Class RetryPolicy (1.133.1)

public final class RetryPolicy extends GeneratedMessageV3 implements RetryPolicyOrBuilder

A policy that specifies how Pub/Sub retries message delivery.

Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff.

RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.

Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.

Protobuf type google.pubsub.v1.RetryPolicy

Static Fields

MAXIMUM_BACKOFF_FIELD_NUMBER

public static final int MAXIMUM_BACKOFF_FIELD_NUMBER
Field Value
Type Description
int

MINIMUM_BACKOFF_FIELD_NUMBER

public static final int MINIMUM_BACKOFF_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RetryPolicy getDefaultInstance()
Returns
Type Description
RetryPolicy

getDescriptor()

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

newBuilder()

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

newBuilder(RetryPolicy prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<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 RetryPolicy getDefaultInstanceForType()
Returns
Type Description
RetryPolicy

getMaximumBackoff()

public Duration getMaximumBackoff()

Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.

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

Returns
Type Description
Duration

The maximumBackoff.

getMaximumBackoffOrBuilder()

public DurationOrBuilder getMaximumBackoffOrBuilder()

Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.

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

Returns
Type Description
DurationOrBuilder

getMinimumBackoff()

public Duration getMinimumBackoff()

Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.

.google.protobuf.Duration minimum_backoff = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The minimumBackoff.

getMinimumBackoffOrBuilder()

public DurationOrBuilder getMinimumBackoffOrBuilder()

Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.

.google.protobuf.Duration minimum_backoff = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasMaximumBackoff()

public boolean hasMaximumBackoff()

Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.

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

Returns
Type Description
boolean

Whether the maximumBackoff field is set.

hasMinimumBackoff()

public boolean hasMinimumBackoff()

Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.

.google.protobuf.Duration minimum_backoff = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the minimumBackoff 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 RetryPolicy.Builder newBuilderForType()
Returns
Type Description
RetryPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RetryPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
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 RetryPolicy.Builder toBuilder()
Returns
Type Description
RetryPolicy.Builder

writeTo(CodedOutputStream output)

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