public sealed class DeadLetterPolicy : IMessage<DeadLetterPolicy>, IEquatable<DeadLetterPolicy>, IDeepCloneable<DeadLetterPolicy>, IBufferMessage, IMessage
Reference documentation and code samples for the Cloud Pub/Sub v1 API class DeadLetterPolicy.
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThe latest version available for the Cloud Pub/Sub v1 API class DeadLetterPolicy is 3.23.0, with multiple other versions listed, ranging down to version 2.3.0.\u003c/p\u003e\n"],["\u003cp\u003eThe DeadLetterPolicy class is used for managing the handling of messages that cannot be delivered, and it includes features like specifying a dead letter topic and setting the maximum number of delivery attempts.\u003c/p\u003e\n"],["\u003cp\u003eDead lettering is performed on a best-effort basis, and the same message might be dead lettered multiple times.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDeadLetterTopic\u003c/code\u003e property defines the topic where undeliverable messages will be published, requiring proper permissions for the Pub/Sub service account, and the \u003ccode\u003eMaxDeliveryAttempts\u003c/code\u003e property allows configuring the maximum delivery attempts, which must be between 5 and 100.\u003c/p\u003e\n"],["\u003cp\u003eThe DeadLetterPolicy class also implements the interfaces \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable<DeadLetterPolicy>\u003c/code\u003e, \u003ccode\u003eIDeepCloneable<DeadLetterPolicy>\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,[]]
