Package com.google.cloud.scheduler.v1

Class RetryConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.scheduler.v1.RetryConfig
All Implemented Interfaces:
RetryConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class RetryConfig extends com.google.protobuf.GeneratedMessage implements RetryConfigOrBuilder
 Settings that determine the retry behavior.

 By default, if a job does not complete successfully (meaning that
 an acknowledgement is not received from the handler, then it will be retried
 with exponential backoff according to the settings in
 [RetryConfig][google.cloud.scheduler.v1.RetryConfig].
Protobuf type google.cloud.scheduler.v1.RetryConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    RetryConfig.Builder
    Settings that determine the retry behavior.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    MAX_BACKOFF_DURATION_FIELD_NUMBER
     
    static final int
    MAX_DOUBLINGS_FIELD_NUMBER
     
    static final int
    MAX_RETRY_DURATION_FIELD_NUMBER
     
    static final int
    MIN_BACKOFF_DURATION_FIELD_NUMBER
     
    static final int
    RETRY_COUNT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static RetryConfig
    getDefaultInstance()
     
    RetryConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Duration
    getMaxBackoffDuration()
    The maximum amount of time to wait before retrying a job after it fails.
    com.google.protobuf.DurationOrBuilder
    getMaxBackoffDurationOrBuilder()
    The maximum amount of time to wait before retrying a job after it fails.
    int
    getMaxDoublings()
    The time between retries will double `max_doublings` times.
    com.google.protobuf.Duration
    getMaxRetryDuration()
    The time limit for retrying a failed job, measured from time when an execution was first attempted.
    com.google.protobuf.DurationOrBuilder
    getMaxRetryDurationOrBuilder()
    The time limit for retrying a failed job, measured from time when an execution was first attempted.
    com.google.protobuf.Duration
    getMinBackoffDuration()
    The minimum amount of time to wait before retrying a job after it fails.
    com.google.protobuf.DurationOrBuilder
    getMinBackoffDurationOrBuilder()
    The minimum amount of time to wait before retrying a job after it fails.
    com.google.protobuf.Parser<RetryConfig>
    getParserForType()
     
    int
    getRetryCount()
    The number of attempts that the system will make to run a job using the exponential backoff procedure described by [max_doublings][google.cloud.scheduler.v1.RetryConfig.max_doublings].
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasMaxBackoffDuration()
    The maximum amount of time to wait before retrying a job after it fails.
    boolean
    hasMaxRetryDuration()
    The time limit for retrying a failed job, measured from time when an execution was first attempted.
    boolean
    hasMinBackoffDuration()
    The minimum amount of time to wait before retrying a job after it fails.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static RetryConfig.Builder
    newBuilder()
     
    static RetryConfig.Builder
    newBuilder(RetryConfig prototype)
     
    RetryConfig.Builder
    newBuilderForType()
     
    protected RetryConfig.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static RetryConfig
    parseDelimitedFrom(InputStream input)
     
    static RetryConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RetryConfig
    parseFrom(byte[] data)
     
    static RetryConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RetryConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static RetryConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RetryConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static RetryConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RetryConfig
    parseFrom(InputStream input)
     
    static RetryConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RetryConfig
    parseFrom(ByteBuffer data)
     
    static RetryConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<RetryConfig>
    parser()
     
    RetryConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • RETRY_COUNT_FIELD_NUMBER

      public static final int RETRY_COUNT_FIELD_NUMBER
      See Also:

    • MAX_RETRY_DURATION_FIELD_NUMBER

      public static final int MAX_RETRY_DURATION_FIELD_NUMBER
      See Also:

    • MIN_BACKOFF_DURATION_FIELD_NUMBER

      public static final int MIN_BACKOFF_DURATION_FIELD_NUMBER
      See Also:

    • MAX_BACKOFF_DURATION_FIELD_NUMBER

      public static final int MAX_BACKOFF_DURATION_FIELD_NUMBER
      See Also:

    • MAX_DOUBLINGS_FIELD_NUMBER

      public static final int MAX_DOUBLINGS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getRetryCount

      public int getRetryCount()
       The number of attempts that the system will make to run a job using the
 exponential backoff procedure described by
 [max_doublings][google.cloud.scheduler.v1.RetryConfig.max_doublings].

 The default value of retry_count is zero.

 If retry_count is 0, a job attempt will not be retried if
 it fails. Instead the Cloud Scheduler system will wait for the
 next scheduled execution time. Setting retry_count to 0 does not prevent
 failed jobs from running according to schedule after the failure.

 If retry_count is set to a non-zero number then Cloud Scheduler
 will retry failed attempts, using exponential backoff,
 retry_count times, or until the next scheduled execution time,
 whichever comes first.

 Values greater than 5 and negative values are not allowed.
      int32 retry_count = 1;
      Specified by:
      getRetryCount in interface RetryConfigOrBuilder
      Returns:
      The retryCount.

    • hasMaxRetryDuration

      public boolean hasMaxRetryDuration()
       The time limit for retrying a failed job, measured from time when an
 execution was first attempted. If specified with
 [retry_count][google.cloud.scheduler.v1.RetryConfig.retry_count], the job
 will be retried until both limits are reached.

 The default value for max_retry_duration is zero, which means retry
 duration is unlimited.
      .google.protobuf.Duration max_retry_duration = 2;
      Specified by:
      hasMaxRetryDuration in interface RetryConfigOrBuilder
      Returns:
      Whether the maxRetryDuration field is set.

    • getMaxRetryDuration

      public com.google.protobuf.Duration getMaxRetryDuration()
       The time limit for retrying a failed job, measured from time when an
 execution was first attempted. If specified with
 [retry_count][google.cloud.scheduler.v1.RetryConfig.retry_count], the job
 will be retried until both limits are reached.

 The default value for max_retry_duration is zero, which means retry
 duration is unlimited.
      .google.protobuf.Duration max_retry_duration = 2;
      Specified by:
      getMaxRetryDuration in interface RetryConfigOrBuilder
      Returns:
      The maxRetryDuration.

    • getMaxRetryDurationOrBuilder

      public com.google.protobuf.DurationOrBuilder getMaxRetryDurationOrBuilder()
       The time limit for retrying a failed job, measured from time when an
 execution was first attempted. If specified with
 [retry_count][google.cloud.scheduler.v1.RetryConfig.retry_count], the job
 will be retried until both limits are reached.

 The default value for max_retry_duration is zero, which means retry
 duration is unlimited.
      .google.protobuf.Duration max_retry_duration = 2;
      Specified by:
      getMaxRetryDurationOrBuilder in interface RetryConfigOrBuilder

    • hasMinBackoffDuration

      public boolean hasMinBackoffDuration()
       The minimum amount of time to wait before retrying a job after
 it fails.

 The default value of this field is 5 seconds.
      .google.protobuf.Duration min_backoff_duration = 3;
      Specified by:
      hasMinBackoffDuration in interface RetryConfigOrBuilder
      Returns:
      Whether the minBackoffDuration field is set.

    • getMinBackoffDuration

      public com.google.protobuf.Duration getMinBackoffDuration()
       The minimum amount of time to wait before retrying a job after
 it fails.

 The default value of this field is 5 seconds.
      .google.protobuf.Duration min_backoff_duration = 3;
      Specified by:
      getMinBackoffDuration in interface RetryConfigOrBuilder
      Returns:
      The minBackoffDuration.

    • getMinBackoffDurationOrBuilder

      public com.google.protobuf.DurationOrBuilder getMinBackoffDurationOrBuilder()
       The minimum amount of time to wait before retrying a job after
 it fails.

 The default value of this field is 5 seconds.
      .google.protobuf.Duration min_backoff_duration = 3;
      Specified by:
      getMinBackoffDurationOrBuilder in interface RetryConfigOrBuilder

    • hasMaxBackoffDuration

      public boolean hasMaxBackoffDuration()
       The maximum amount of time to wait before retrying a job after
 it fails.

 The default value of this field is 1 hour.
      .google.protobuf.Duration max_backoff_duration = 4;
      Specified by:
      hasMaxBackoffDuration in interface RetryConfigOrBuilder
      Returns:
      Whether the maxBackoffDuration field is set.

    • getMaxBackoffDuration

      public com.google.protobuf.Duration getMaxBackoffDuration()
       The maximum amount of time to wait before retrying a job after
 it fails.

 The default value of this field is 1 hour.
      .google.protobuf.Duration max_backoff_duration = 4;
      Specified by:
      getMaxBackoffDuration in interface RetryConfigOrBuilder
      Returns:
      The maxBackoffDuration.

    • getMaxBackoffDurationOrBuilder

      public com.google.protobuf.DurationOrBuilder getMaxBackoffDurationOrBuilder()
       The maximum amount of time to wait before retrying a job after
 it fails.

 The default value of this field is 1 hour.
      .google.protobuf.Duration max_backoff_duration = 4;
      Specified by:
      getMaxBackoffDurationOrBuilder in interface RetryConfigOrBuilder

    • getMaxDoublings

      public int getMaxDoublings()
       The time between retries will double `max_doublings` times.

 A job's retry interval starts at
 [min_backoff_duration][google.cloud.scheduler.v1.RetryConfig.min_backoff_duration],
 then doubles `max_doublings` times, then increases linearly, and finally
 retries at intervals of
 [max_backoff_duration][google.cloud.scheduler.v1.RetryConfig.max_backoff_duration]
 up to [retry_count][google.cloud.scheduler.v1.RetryConfig.retry_count]
 times.

 For example, if
 [min_backoff_duration][google.cloud.scheduler.v1.RetryConfig.min_backoff_duration]
 is 10s,
 [max_backoff_duration][google.cloud.scheduler.v1.RetryConfig.max_backoff_duration]
 is 300s, and `max_doublings` is 3, then the job will first be retried in
 10s. The retry interval will double three times, and then increase linearly
 by 2^3 * 10s.  Finally, the job will retry at intervals of
 [max_backoff_duration][google.cloud.scheduler.v1.RetryConfig.max_backoff_duration]
 until the job has been attempted
 [retry_count][google.cloud.scheduler.v1.RetryConfig.retry_count] times.
 Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s,
 300s, ....

 The default value of this field is 5.
      int32 max_doublings = 5;
      Specified by:
      getMaxDoublings in interface RetryConfigOrBuilder
      Returns:
      The maxDoublings.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RetryConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RetryConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RetryConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RetryConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RetryConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RetryConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RetryConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RetryConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RetryConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RetryConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RetryConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RetryConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public RetryConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static RetryConfig.Builder newBuilder()

    • newBuilder

      public static RetryConfig.Builder newBuilder(RetryConfig prototype)

    • toBuilder

      public RetryConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RetryConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RetryConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RetryConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<RetryConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public RetryConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder