Package com.google.cloud.scheduler.v1

Class RetryConfig.Builder

  • All Implemented Interfaces:
    RetryConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    RetryConfig
    public static final class RetryConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RetryConfig.Builder>
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

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RetryConfig.Builder>

      • clear

        public RetryConfig.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<RetryConfig.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RetryConfig.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public RetryConfig.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<RetryConfig.Builder>

      • setField

        public RetryConfig.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                    Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<RetryConfig.Builder>

      • clearField

        public RetryConfig.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RetryConfig.Builder>

      • clearOneof

        public RetryConfig.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RetryConfig.Builder>

      • setRepeatedField

        public RetryConfig.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            int index,
                                            Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RetryConfig.Builder>

      • addRepeatedField

        public RetryConfig.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RetryConfig.Builder>

      • mergeFrom

        public RetryConfig.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RetryConfig.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RetryConfig.Builder>

      • mergeFrom

        public RetryConfig.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RetryConfig.Builder>
        Throws:
        IOException

      • 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 zero, a job attempt will *not* be retried if
 it fails. Instead the Cloud Scheduler system will wait for the
 next scheduled execution time.

 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.

      • setRetryCount

        public RetryConfig.Builder setRetryCount​(int value)
         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 zero, a job attempt will *not* be retried if
 it fails. Instead the Cloud Scheduler system will wait for the
 next scheduled execution time.

 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;
        Parameters:
        value - The retryCount to set.
        Returns:
        This builder for chaining.

      • clearRetryCount

        public RetryConfig.Builder clearRetryCount()
         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 zero, a job attempt will *not* be retried if
 it fails. Instead the Cloud Scheduler system will wait for the
 next scheduled execution time.

 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;
        Returns:
        This builder for chaining.

      • 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.

      • setMaxRetryDuration

        public RetryConfig.Builder setMaxRetryDuration​(com.google.protobuf.Duration value)
         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;

      • setMaxRetryDuration

        public RetryConfig.Builder setMaxRetryDuration​(com.google.protobuf.Duration.Builder builderForValue)
         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;

      • mergeMaxRetryDuration

        public RetryConfig.Builder mergeMaxRetryDuration​(com.google.protobuf.Duration value)
         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;

      • clearMaxRetryDuration

        public RetryConfig.Builder clearMaxRetryDuration()
         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;

      • getMaxRetryDurationBuilder

        public com.google.protobuf.Duration.Builder getMaxRetryDurationBuilder()
         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;

      • 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.

      • setMinBackoffDuration

        public RetryConfig.Builder setMinBackoffDuration​(com.google.protobuf.Duration value)
         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;

      • setMinBackoffDuration

        public RetryConfig.Builder setMinBackoffDuration​(com.google.protobuf.Duration.Builder builderForValue)
         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;

      • mergeMinBackoffDuration

        public RetryConfig.Builder mergeMinBackoffDuration​(com.google.protobuf.Duration value)
         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;

      • clearMinBackoffDuration

        public RetryConfig.Builder clearMinBackoffDuration()
         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;

      • getMinBackoffDurationBuilder

        public com.google.protobuf.Duration.Builder getMinBackoffDurationBuilder()
         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;

      • 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.

      • setMaxBackoffDuration

        public RetryConfig.Builder setMaxBackoffDuration​(com.google.protobuf.Duration value)
         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;

      • setMaxBackoffDuration

        public RetryConfig.Builder setMaxBackoffDuration​(com.google.protobuf.Duration.Builder builderForValue)
         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;

      • mergeMaxBackoffDuration

        public RetryConfig.Builder mergeMaxBackoffDuration​(com.google.protobuf.Duration value)
         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;

      • clearMaxBackoffDuration

        public RetryConfig.Builder clearMaxBackoffDuration()
         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;

      • getMaxBackoffDurationBuilder

        public com.google.protobuf.Duration.Builder getMaxBackoffDurationBuilder()
         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;

      • 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 a 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.

      • setMaxDoublings

        public RetryConfig.Builder setMaxDoublings​(int value)
         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 a 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;
        Parameters:
        value - The maxDoublings to set.
        Returns:
        This builder for chaining.

      • clearMaxDoublings

        public RetryConfig.Builder clearMaxDoublings()
         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 a 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;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final RetryConfig.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RetryConfig.Builder>

      • mergeUnknownFields

        public final RetryConfig.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RetryConfig.Builder>