com.google.pubsub.v1

Class DeadLetterPolicy

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.pubsub.v1.DeadLetterPolicy

All Implemented Interfaces:

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

public final class DeadLetterPolicy
extends com.google.protobuf.GeneratedMessageV3
implements DeadLetterPolicyOrBuilder

 Dead lettering is done on a best effort basis. The same message might be
 dead lettered multiple times.

 If validation on any of the fields fails at subscription creation/updation,
 the create/update subscription request will fail.
 

Protobuf type google.pubsub.v1.DeadLetterPolicy

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeadLetterPolicy.Builder Dead lettering is done on a best effort basis.

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	DEAD_LETTER_TOPIC_FIELD_NUMBER
static int	MAX_DELIVERY_ATTEMPTS_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)
String	getDeadLetterTopic() The name of the topic to which dead letter messages should be published.
com.google.protobuf.ByteString	getDeadLetterTopicBytes() The name of the topic to which dead letter messages should be published.
static DeadLetterPolicy	getDefaultInstance()
DeadLetterPolicy	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
int	getMaxDeliveryAttempts() The maximum number of delivery attempts for any message.
com.google.protobuf.Parser<DeadLetterPolicy>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DeadLetterPolicy.Builder	newBuilder()
static DeadLetterPolicy.Builder	newBuilder(DeadLetterPolicy prototype)
DeadLetterPolicy.Builder	newBuilderForType()
protected DeadLetterPolicy.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static DeadLetterPolicy	parseDelimitedFrom(InputStream input)
static DeadLetterPolicy	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeadLetterPolicy	parseFrom(byte[] data)
static DeadLetterPolicy	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeadLetterPolicy	parseFrom(ByteBuffer data)
static DeadLetterPolicy	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeadLetterPolicy	parseFrom(com.google.protobuf.ByteString data)
static DeadLetterPolicy	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeadLetterPolicy	parseFrom(com.google.protobuf.CodedInputStream input)
static DeadLetterPolicy	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DeadLetterPolicy	parseFrom(InputStream input)
static DeadLetterPolicy	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DeadLetterPolicy>	parser()
DeadLetterPolicy.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

DEAD_LETTER_TOPIC_FIELD_NUMBER

public static final int DEAD_LETTER_TOPIC_FIELD_NUMBER

See Also:

Constant Field Values

MAX_DELIVERY_ATTEMPTS_FIELD_NUMBER

public static final int MAX_DELIVERY_ATTEMPTS_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

getDeadLetterTopic

public String getDeadLetterTopic()

 The name of the topic to which dead letter messages should be published.
 Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service
 account associated with the enclosing subscription's parent project (i.e.,
 service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
 permission to Publish() to this topic.

 The operation will fail if the topic does not exist.
 Users should ensure that there is a subscription attached to this topic
 since messages published to a topic with no subscriptions are lost.
 

string dead_letter_topic = 1;

Specified by:

getDeadLetterTopic in interface DeadLetterPolicyOrBuilder

Returns:

The deadLetterTopic.

getDeadLetterTopicBytes

public com.google.protobuf.ByteString getDeadLetterTopicBytes()

 The name of the topic to which dead letter messages should be published.
 Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service
 account associated with the enclosing subscription's parent project (i.e.,
 service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
 permission to Publish() to this topic.

 The operation will fail if the topic does not exist.
 Users should ensure that there is a subscription attached to this topic
 since messages published to a topic with no subscriptions are lost.
 

string dead_letter_topic = 1;

Specified by:

getDeadLetterTopicBytes in interface DeadLetterPolicyOrBuilder

Returns:

The bytes for deadLetterTopic.

getMaxDeliveryAttempts

public int getMaxDeliveryAttempts()

 The maximum number of delivery attempts for any message. The value must be
 between 5 and 100.

 The number of delivery attempts is defined as 1 + (the sum of number of
 NACKs and number of times the acknowledgement deadline has been exceeded
 for the message).

 A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that
 client libraries may automatically extend ack_deadlines.

 This field will be honored on a best effort basis.

 If this parameter is 0, a default value of 5 is used.
 

int32 max_delivery_attempts = 2;

Specified by:

getMaxDeliveryAttempts in interface DeadLetterPolicyOrBuilder

Returns:

The maxDeliveryAttempts.

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 DeadLetterPolicy parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeadLetterPolicy parseFrom(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeadLetterPolicy parseFrom(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeadLetterPolicy parseFrom(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeadLetterPolicy parseFrom(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeadLetterPolicy parseFrom(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DeadLetterPolicy parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static DeadLetterPolicy parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static DeadLetterPolicy parseFrom(com.google.protobuf.CodedInputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public DeadLetterPolicy.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DeadLetterPolicy.Builder newBuilder()

newBuilder

public static DeadLetterPolicy.Builder newBuilder(DeadLetterPolicy prototype)

toBuilder

public DeadLetterPolicy.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DeadLetterPolicy.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DeadLetterPolicy getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<DeadLetterPolicy> 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 DeadLetterPolicy getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder