Package io.temporal.api.common.v1

Class RetryPolicy

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RetryPolicyOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:RetryPolicy.java.pb.meta")
public final class RetryPolicy
extends com.google.protobuf.GeneratedMessageV3
implements RetryPolicyOrBuilder
     How retries ought to be handled, usable by both workflows and activities
    Protobuf type temporal.api.common.v1.RetryPolicy
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RetryPolicy.Builder
      How retries ought to be handled, usable by both workflows and activities

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      double getBackoffCoefficient()
      Coefficient used to calculate the next retry interval.
      static RetryPolicy getDefaultInstance()  
      RetryPolicy getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Duration getInitialInterval()
      Interval of the first retry.
      com.google.protobuf.DurationOrBuilder getInitialIntervalOrBuilder()
      Interval of the first retry.
      int getMaximumAttempts()
      Maximum number of attempts.
      com.google.protobuf.Duration getMaximumInterval()
      Maximum interval between retries.
      com.google.protobuf.DurationOrBuilder getMaximumIntervalOrBuilder()
      Maximum interval between retries.
      java.lang.String getNonRetryableErrorTypes​(int index)
      Non-Retryable errors types.
      com.google.protobuf.ByteString getNonRetryableErrorTypesBytes​(int index)
      Non-Retryable errors types.
      int getNonRetryableErrorTypesCount()
      Non-Retryable errors types.
      com.google.protobuf.ProtocolStringList getNonRetryableErrorTypesList()
      Non-Retryable errors types.
      com.google.protobuf.Parser<RetryPolicy> getParserForType()  
      int getSerializedSize()  
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      int hashCode()  
      boolean hasInitialInterval()
      Interval of the first retry.
      boolean hasMaximumInterval()
      Maximum interval between retries.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static RetryPolicy.Builder newBuilder()  
      static RetryPolicy.Builder newBuilder​(RetryPolicy prototype)  
      RetryPolicy.Builder newBuilderForType()  
      protected RetryPolicy.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static RetryPolicy parseDelimitedFrom​(java.io.InputStream input)  
      static RetryPolicy parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RetryPolicy parseFrom​(byte[] data)  
      static RetryPolicy parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RetryPolicy parseFrom​(com.google.protobuf.ByteString data)  
      static RetryPolicy parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RetryPolicy parseFrom​(com.google.protobuf.CodedInputStream input)  
      static RetryPolicy parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RetryPolicy parseFrom​(java.io.InputStream input)  
      static RetryPolicy parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RetryPolicy parseFrom​(java.nio.ByteBuffer data)  
      static RetryPolicy parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<RetryPolicy> parser()  
      RetryPolicy.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, 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, hasField, hasOneof

    • Field Detail

      • INITIAL_INTERVAL_FIELD_NUMBER

        public static final int INITIAL_INTERVAL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BACKOFF_COEFFICIENT_FIELD_NUMBER

        public static final int BACKOFF_COEFFICIENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAXIMUM_INTERVAL_FIELD_NUMBER

        public static final int MAXIMUM_INTERVAL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAXIMUM_ATTEMPTS_FIELD_NUMBER

        public static final int MAXIMUM_ATTEMPTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NON_RETRYABLE_ERROR_TYPES_FIELD_NUMBER

        public static final int NON_RETRYABLE_ERROR_TYPES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • 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

      • hasInitialInterval

        public boolean hasInitialInterval()
         Interval of the first retry. If retryBackoffCoefficient is 1.0 then it is used for all retries.
        .google.protobuf.Duration initial_interval = 1 [(.gogoproto.stdduration) = true];
        Specified by:
        hasInitialInterval in interface RetryPolicyOrBuilder
        Returns:
        Whether the initialInterval field is set.

      • getInitialInterval

        public com.google.protobuf.Duration getInitialInterval()
         Interval of the first retry. If retryBackoffCoefficient is 1.0 then it is used for all retries.
        .google.protobuf.Duration initial_interval = 1 [(.gogoproto.stdduration) = true];
        Specified by:
        getInitialInterval in interface RetryPolicyOrBuilder
        Returns:
        The initialInterval.

      • getInitialIntervalOrBuilder

        public com.google.protobuf.DurationOrBuilder getInitialIntervalOrBuilder()
         Interval of the first retry. If retryBackoffCoefficient is 1.0 then it is used for all retries.
        .google.protobuf.Duration initial_interval = 1 [(.gogoproto.stdduration) = true];
        Specified by:
        getInitialIntervalOrBuilder in interface RetryPolicyOrBuilder

      • getBackoffCoefficient

        public double getBackoffCoefficient()
         Coefficient used to calculate the next retry interval.
 The next retry interval is previous interval multiplied by the coefficient.
 Must be 1 or larger.
        double backoff_coefficient = 2;
        Specified by:
        getBackoffCoefficient in interface RetryPolicyOrBuilder
        Returns:
        The backoffCoefficient.

      • hasMaximumInterval

        public boolean hasMaximumInterval()
         Maximum interval between retries. Exponential backoff leads to interval increase.
 This value is the cap of the increase. Default is 100x of the initial interval.
        .google.protobuf.Duration maximum_interval = 3 [(.gogoproto.stdduration) = true];
        Specified by:
        hasMaximumInterval in interface RetryPolicyOrBuilder
        Returns:
        Whether the maximumInterval field is set.

      • getMaximumInterval

        public com.google.protobuf.Duration getMaximumInterval()
         Maximum interval between retries. Exponential backoff leads to interval increase.
 This value is the cap of the increase. Default is 100x of the initial interval.
        .google.protobuf.Duration maximum_interval = 3 [(.gogoproto.stdduration) = true];
        Specified by:
        getMaximumInterval in interface RetryPolicyOrBuilder
        Returns:
        The maximumInterval.

      • getMaximumIntervalOrBuilder

        public com.google.protobuf.DurationOrBuilder getMaximumIntervalOrBuilder()
         Maximum interval between retries. Exponential backoff leads to interval increase.
 This value is the cap of the increase. Default is 100x of the initial interval.
        .google.protobuf.Duration maximum_interval = 3 [(.gogoproto.stdduration) = true];
        Specified by:
        getMaximumIntervalOrBuilder in interface RetryPolicyOrBuilder

      • getMaximumAttempts

        public int getMaximumAttempts()
         Maximum number of attempts. When exceeded the retries stop even if not expired yet.
 1 disables retries. 0 means unlimited (up to the timeouts)
        int32 maximum_attempts = 4;
        Specified by:
        getMaximumAttempts in interface RetryPolicyOrBuilder
        Returns:
        The maximumAttempts.

      • getNonRetryableErrorTypesList

        public com.google.protobuf.ProtocolStringList getNonRetryableErrorTypesList()
         Non-Retryable errors types. Will stop retrying if the error type matches this list. Note that
 this is not a substring match, the error *type* (not message) must match exactly.
        repeated string non_retryable_error_types = 5;
        Specified by:
        getNonRetryableErrorTypesList in interface RetryPolicyOrBuilder
        Returns:
        A list containing the nonRetryableErrorTypes.

      • getNonRetryableErrorTypesCount

        public int getNonRetryableErrorTypesCount()
         Non-Retryable errors types. Will stop retrying if the error type matches this list. Note that
 this is not a substring match, the error *type* (not message) must match exactly.
        repeated string non_retryable_error_types = 5;
        Specified by:
        getNonRetryableErrorTypesCount in interface RetryPolicyOrBuilder
        Returns:
        The count of nonRetryableErrorTypes.

      • getNonRetryableErrorTypes

        public java.lang.String getNonRetryableErrorTypes​(int index)
         Non-Retryable errors types. Will stop retrying if the error type matches this list. Note that
 this is not a substring match, the error *type* (not message) must match exactly.
        repeated string non_retryable_error_types = 5;
        Specified by:
        getNonRetryableErrorTypes in interface RetryPolicyOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The nonRetryableErrorTypes at the given index.

      • getNonRetryableErrorTypesBytes

        public com.google.protobuf.ByteString getNonRetryableErrorTypesBytes​(int index)
         Non-Retryable errors types. Will stop retrying if the error type matches this list. Note that
 this is not a substring match, the error *type* (not message) must match exactly.
        repeated string non_retryable_error_types = 5;
        Specified by:
        getNonRetryableErrorTypesBytes in interface RetryPolicyOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the nonRetryableErrorTypes at the given index.

      • isInitialized

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

      • writeTo

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

      • getSerializedSize

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

      • equals

        public boolean equals​(java.lang.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 RetryPolicy parseFrom​(java.nio.ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RetryPolicy parseFrom​(java.nio.ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static RetryPolicy parseFrom​(java.io.InputStream input)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static RetryPolicy parseFrom​(java.io.InputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static RetryPolicy parseDelimitedFrom​(java.io.InputStream input)
                                      throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static RetryPolicy parseDelimitedFrom​(java.io.InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static RetryPolicy parseFrom​(com.google.protobuf.CodedInputStream input)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static RetryPolicy parseFrom​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected RetryPolicy.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static RetryPolicy getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<RetryPolicy> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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