com.google.pubsub.v1

Class RetryPolicy

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.pubsub.v1.RetryPolicy

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RetryPolicyOrBuilder, Serializable

public final class RetryPolicy
extends com.google.protobuf.GeneratedMessageV3
implements RetryPolicyOrBuilder

 A policy that specifies how Cloud 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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RetryPolicy.Builder A policy that specifies how Cloud Pub/Sub retries message delivery.

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 and Description
static int	MAXIMUM_BACKOFF_FIELD_NUMBER
static int	MINIMUM_BACKOFF_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 and Description
boolean	equals(Object obj)
static RetryPolicy	getDefaultInstance()
RetryPolicy	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Duration	getMaximumBackoff() The maximum delay between consecutive deliveries of a given message.
com.google.protobuf.DurationOrBuilder	getMaximumBackoffOrBuilder() The maximum delay between consecutive deliveries of a given message.
com.google.protobuf.Duration	getMinimumBackoff() The minimum delay between consecutive deliveries of a given message.
com.google.protobuf.DurationOrBuilder	getMinimumBackoffOrBuilder() The minimum delay between consecutive deliveries of a given message.
com.google.protobuf.Parser<RetryPolicy>	getParserForType()
int	getSerializedSize()
int	hashCode()
boolean	hasMaximumBackoff() The maximum delay between consecutive deliveries of a given message.
boolean	hasMinimumBackoff() The minimum delay between consecutive deliveries of a given message.
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 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(ByteBuffer data)
static RetryPolicy	parseFrom(ByteBuffer 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 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, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

MINIMUM_BACKOFF_FIELD_NUMBER

public static final int MINIMUM_BACKOFF_FIELD_NUMBER

See Also:

Constant Field Values

MAXIMUM_BACKOFF_FIELD_NUMBER

public static final int MAXIMUM_BACKOFF_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

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

hasMinimumBackoff

public boolean hasMinimumBackoff()

 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;

Specified by:

hasMinimumBackoff in interface RetryPolicyOrBuilder

Returns:

Whether the minimumBackoff field is set.

getMinimumBackoff

public com.google.protobuf.Duration getMinimumBackoff()

 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;

Specified by:

getMinimumBackoff in interface RetryPolicyOrBuilder

Returns:

The minimumBackoff.

getMinimumBackoffOrBuilder

public com.google.protobuf.DurationOrBuilder getMinimumBackoffOrBuilder()

 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;

Specified by:

getMinimumBackoffOrBuilder in interface RetryPolicyOrBuilder

hasMaximumBackoff

public boolean hasMaximumBackoff()

 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;

Specified by:

hasMaximumBackoff in interface RetryPolicyOrBuilder

Returns:

Whether the maximumBackoff field is set.

getMaximumBackoff

public com.google.protobuf.Duration getMaximumBackoff()

 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;

Specified by:

getMaximumBackoff in interface RetryPolicyOrBuilder

Returns:

The maximumBackoff.

getMaximumBackoffOrBuilder

public com.google.protobuf.DurationOrBuilder getMaximumBackoffOrBuilder()

 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;

Specified by:

getMaximumBackoffOrBuilder in interface RetryPolicyOrBuilder

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