Class RetryPolicy

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.temporal.api.common.v1.RetryPolicy
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RetryPolicyOrBuilder, 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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final 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<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BACKOFF_COEFFICIENT_FIELD_NUMBER
     
    static final int
    INITIAL_INTERVAL_FIELD_NUMBER
     
    static final int
    MAXIMUM_ATTEMPTS_FIELD_NUMBER
     
    static final int
    MAXIMUM_INTERVAL_FIELD_NUMBER
     
    static final int
    NON_RETRYABLE_ERROR_TYPES_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, 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)
     
    double
    getBackoffCoefficient()
    Coefficient used to calculate the next retry interval.
    static RetryPolicy
    getDefaultInstance()
     
    RetryPolicy
    getDefaultInstanceForType()
     
    static final 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.
    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()
     
    int
    hashCode()
     
    boolean
    hasInitialInterval()
    Interval of the first retry.
    boolean
    hasMaximumInterval()
    Maximum interval between retries.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final 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 Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static RetryPolicy
    parseDelimitedFrom(InputStream input)
     
    static RetryPolicy
    parseDelimitedFrom(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(InputStream input)
     
    static RetryPolicy
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RetryPolicy
    parseFrom(ByteBuffer data)
     
    static RetryPolicy
    parseFrom(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, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, getUnknownFields, hasField, hasOneof

  • Field Details

    • INITIAL_INTERVAL_FIELD_NUMBER

      public static final int INITIAL_INTERVAL_FIELD_NUMBER
      See Also:

    • BACKOFF_COEFFICIENT_FIELD_NUMBER

      public static final int BACKOFF_COEFFICIENT_FIELD_NUMBER
      See Also:

    • MAXIMUM_INTERVAL_FIELD_NUMBER

      public static final int MAXIMUM_INTERVAL_FIELD_NUMBER
      See Also:

    • MAXIMUM_ATTEMPTS_FIELD_NUMBER

      public static final int MAXIMUM_ATTEMPTS_FIELD_NUMBER
      See Also:

    • NON_RETRYABLE_ERROR_TYPES_FIELD_NUMBER

      public static final int NON_RETRYABLE_ERROR_TYPES_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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;
      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;
      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;
      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;
      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;
      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;
      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 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RetryPolicy parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RetryPolicy.Builder newBuilder()

    • newBuilder

      public static RetryPolicy.Builder newBuilder(RetryPolicy prototype)

    • 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