public final class DeadLetterPolicy extends GeneratedMessageV3 implements DeadLetterPolicyOrBuilderDead 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DeadLetterPolicyImplements
DeadLetterPolicyOrBuilderStatic Fields
DEAD_LETTER_TOPIC_FIELD_NUMBER
public static final int DEAD_LETTER_TOPIC_FIELD_NUMBER| Type | Description |
| int |
MAX_DELIVERY_ATTEMPTS_FIELD_NUMBER
public static final int MAX_DELIVERY_ATTEMPTS_FIELD_NUMBER| Type | Description |
| int |
Static Methods
getDefaultInstance()
public static DeadLetterPolicy getDefaultInstance()| Type | Description |
| DeadLetterPolicy |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
newBuilder()
public static DeadLetterPolicy.Builder newBuilder()| Type | Description |
| DeadLetterPolicy.Builder |
newBuilder(DeadLetterPolicy prototype)
public static DeadLetterPolicy.Builder newBuilder(DeadLetterPolicy prototype)| Name | Description |
| prototype | DeadLetterPolicy |
| Type | Description |
| DeadLetterPolicy.Builder |
parseDelimitedFrom(InputStream input)
public static DeadLetterPolicy parseDelimitedFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| DeadLetterPolicy |
| Type | Description |
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DeadLetterPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| DeadLetterPolicy |
| Type | Description |
| IOException |
parseFrom(byte[] data)
public static DeadLetterPolicy parseFrom(byte[] data)| Name | Description |
| data | byte[] |
| Type | Description |
| DeadLetterPolicy |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DeadLetterPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | byte[] |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| DeadLetterPolicy |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data)
public static DeadLetterPolicy parseFrom(ByteString data)| Name | Description |
| data | ByteString |
| Type | Description |
| DeadLetterPolicy |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DeadLetterPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteString |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| DeadLetterPolicy |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static DeadLetterPolicy parseFrom(CodedInputStream input)| Name | Description |
| input | CodedInputStream |
| Type | Description |
| DeadLetterPolicy |
| Type | Description |
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DeadLetterPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| DeadLetterPolicy |
| Type | Description |
| IOException |
parseFrom(InputStream input)
public static DeadLetterPolicy parseFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| DeadLetterPolicy |
| Type | Description |
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DeadLetterPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| DeadLetterPolicy |
| Type | Description |
| IOException |
parseFrom(ByteBuffer data)
public static DeadLetterPolicy parseFrom(ByteBuffer data)| Name | Description |
| data | ByteBuffer |
| Type | Description |
| DeadLetterPolicy |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DeadLetterPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteBuffer |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| DeadLetterPolicy |
| Type | Description |
| InvalidProtocolBufferException |
parser()
public static Parser<DeadLetterPolicy> parser()| Type | Description |
| Parser<DeadLetterPolicy> |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
| obj | Object |
| Type | Description |
| boolean |
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()| Type | Description |
| DeadLetterPolicy |
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()| Type | Description |
| Parser<DeadLetterPolicy> |
getSerializedSize()
public int getSerializedSize()| Type | Description |
| int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
| UnknownFieldSet |
hashCode()
public int hashCode()| Type | Description |
| int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
newBuilderForType()
public DeadLetterPolicy.Builder newBuilderForType()| Type | Description |
| DeadLetterPolicy.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DeadLetterPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
| parent | BuilderParent |
| Type | Description |
| DeadLetterPolicy.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
| unused | UnusedPrivateParameter |
| Type | Description |
| Object |
toBuilder()
public DeadLetterPolicy.Builder toBuilder()| Type | Description |
| DeadLetterPolicy.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
| output | CodedOutputStream |
| Type | Description |
| IOException |