Class DeadLetterPolicy (1.131.0)

public final class DeadLetterPolicy extends 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

Static Fields

DEAD_LETTER_TOPIC_FIELD_NUMBER

public static final int DEAD_LETTER_TOPIC_FIELD_NUMBER
Field Value
Type Description
int

MAX_DELIVERY_ATTEMPTS_FIELD_NUMBER

public static final int MAX_DELIVERY_ATTEMPTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DeadLetterPolicy getDefaultInstance()
Returns
Type Description
DeadLetterPolicy

getDescriptor()

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

newBuilder()

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

newBuilder(DeadLetterPolicy prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<DeadLetterPolicy> parser()
Returns
Type Description
Parser<DeadLetterPolicy>

Methods

equals(Object obj)

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

getDeadLetterTopic()

public String getDeadLetterTopic()

Optional. The name of the topic to which dead letter messages should be published. Format is projects/{project}/topics/{topic}.The 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The deadLetterTopic.

getDeadLetterTopicBytes()

public ByteString getDeadLetterTopicBytes()

Optional. The name of the topic to which dead letter messages should be published. Format is projects/{project}/topics/{topic}.The 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for deadLetterTopic.

getDefaultInstanceForType()

public DeadLetterPolicy getDefaultInstanceForType()
Returns
Type Description
DeadLetterPolicy

getMaxDeliveryAttempts()

public int getMaxDeliveryAttempts()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The maxDeliveryAttempts.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 DeadLetterPolicy.Builder newBuilderForType()
Returns
Type Description
DeadLetterPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public DeadLetterPolicy.Builder toBuilder()
Returns
Type Description
DeadLetterPolicy.Builder

writeTo(CodedOutputStream output)

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