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
MAX_DELIVERY_ATTEMPTS_FIELD_NUMBER
public static final int MAX_DELIVERY_ATTEMPTS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static DeadLetterPolicy getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static DeadLetterPolicy.Builder newBuilder()
Returns
newBuilder(DeadLetterPolicy prototype)
public static DeadLetterPolicy.Builder newBuilder(DeadLetterPolicy prototype)
Parameter
Returns
public static DeadLetterPolicy parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static DeadLetterPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static DeadLetterPolicy parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DeadLetterPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static DeadLetterPolicy parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DeadLetterPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DeadLetterPolicy parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static DeadLetterPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DeadLetterPolicy parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static DeadLetterPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static DeadLetterPolicy parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DeadLetterPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<DeadLetterPolicy> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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;
| Type | Description |
| String | The deadLetterTopic.
|
getDeadLetterTopicBytes()
public 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;
| Type | Description |
| ByteString | The bytes for deadLetterTopic.
|
getDefaultInstanceForType()
public DeadLetterPolicy getDefaultInstanceForType()
Returns
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;
| Type | Description |
| int | The maxDeliveryAttempts.
|
getParserForType()
public Parser<DeadLetterPolicy> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public DeadLetterPolicy.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DeadLetterPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public DeadLetterPolicy.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
