Class Pipeline.RetryPolicy (1.55.0)

public static final class Pipeline.RetryPolicy extends GeneratedMessageV3 implements Pipeline.RetryPolicyOrBuilder

The retry policy configuration for the Pipeline. The pipeline exponentially backs off in case the destination is non responsive or returns a retryable error code. The default semantics are as follows: The backoff starts with a 5 second delay and doubles the delay after each failed attempt (10 seconds, 20 seconds, 40 seconds, etc.). The delay is capped at 60 seconds by default. Please note that if you set the min_retry_delay and max_retry_delay fields to the same value this will make the duration between retries constant.

Protobuf type google.cloud.eventarc.v1.Pipeline.RetryPolicy

Static Fields

MAX_ATTEMPTS_FIELD_NUMBER

public static final int MAX_ATTEMPTS_FIELD_NUMBER
Field Value
Type Description
int

MAX_RETRY_DELAY_FIELD_NUMBER

public static final int MAX_RETRY_DELAY_FIELD_NUMBER
Field Value
Type Description
int

MIN_RETRY_DELAY_FIELD_NUMBER

public static final int MIN_RETRY_DELAY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Pipeline.RetryPolicy getDefaultInstance()
Returns
Type Description
Pipeline.RetryPolicy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Pipeline.RetryPolicy.Builder newBuilder()
Returns
Type Description
Pipeline.RetryPolicy.Builder

newBuilder(Pipeline.RetryPolicy prototype)

public static Pipeline.RetryPolicy.Builder newBuilder(Pipeline.RetryPolicy prototype)
Parameter
Name Description
prototype Pipeline.RetryPolicy
Returns
Type Description
Pipeline.RetryPolicy.Builder

parseDelimitedFrom(InputStream input)

public static Pipeline.RetryPolicy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Pipeline.RetryPolicy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline.RetryPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline.RetryPolicy
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Pipeline.RetryPolicy parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Pipeline.RetryPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Pipeline.RetryPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline.RetryPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Pipeline.RetryPolicy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Pipeline.RetryPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Pipeline.RetryPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline.RetryPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Pipeline.RetryPolicy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Pipeline.RetryPolicy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline.RetryPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline.RetryPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Pipeline.RetryPolicy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Pipeline.RetryPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline.RetryPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline.RetryPolicy
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Pipeline.RetryPolicy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Pipeline.RetryPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Pipeline.RetryPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline.RetryPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Pipeline.RetryPolicy> parser()
Returns
Type Description
Parser<RetryPolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Pipeline.RetryPolicy getDefaultInstanceForType()
Returns
Type Description
Pipeline.RetryPolicy

getMaxAttempts()

public int getMaxAttempts()

Optional. The maximum number of delivery attempts for any message. The value must be between 1 and 100. The default value for this field is 5.

int32 max_attempts = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The maxAttempts.

getMaxRetryDelay()

public Duration getMaxRetryDelay()

Optional. The maximum amount of seconds to wait between retry attempts. The value must be between 1 and 600. The default value for this field is 60.

.google.protobuf.Duration max_retry_delay = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The maxRetryDelay.

getMaxRetryDelayOrBuilder()

public DurationOrBuilder getMaxRetryDelayOrBuilder()

Optional. The maximum amount of seconds to wait between retry attempts. The value must be between 1 and 600. The default value for this field is 60.

.google.protobuf.Duration max_retry_delay = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getMinRetryDelay()

public Duration getMinRetryDelay()

Optional. The minimum amount of seconds to wait between retry attempts. The value must be between 1 and 600. The default value for this field is 5.

.google.protobuf.Duration min_retry_delay = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The minRetryDelay.

getMinRetryDelayOrBuilder()

public DurationOrBuilder getMinRetryDelayOrBuilder()

Optional. The minimum amount of seconds to wait between retry attempts. The value must be between 1 and 600. The default value for this field is 5.

.google.protobuf.Duration min_retry_delay = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getParserForType()

public Parser<Pipeline.RetryPolicy> getParserForType()
Returns
Type Description
Parser<RetryPolicy>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasMaxRetryDelay()

public boolean hasMaxRetryDelay()

Optional. The maximum amount of seconds to wait between retry attempts. The value must be between 1 and 600. The default value for this field is 60.

.google.protobuf.Duration max_retry_delay = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the maxRetryDelay field is set.

hasMinRetryDelay()

public boolean hasMinRetryDelay()

Optional. The minimum amount of seconds to wait between retry attempts. The value must be between 1 and 600. The default value for this field is 5.

.google.protobuf.Duration min_retry_delay = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the minRetryDelay field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Pipeline.RetryPolicy.Builder newBuilderForType()
Returns
Type Description
Pipeline.RetryPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Pipeline.RetryPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Pipeline.RetryPolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Pipeline.RetryPolicy.Builder toBuilder()
Returns
Type Description
Pipeline.RetryPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException