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.
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.
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.
[[["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\u003eThis document provides reference documentation for the \u003ccode\u003eDeadLetterPolicy\u003c/code\u003e class within the Google Cloud Pub/Sub v1 API, specifically for version 3.14.0, and links to other versions.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDeadLetterPolicy\u003c/code\u003e class is used to manage the handling of messages that cannot be delivered, including the topic where dead letter messages will be published and the maximum delivery attempts for any given message.\u003c/p\u003e\n"],["\u003cp\u003eDead lettering of messages is executed on a best effort basis, therefore messages may be dead lettered more than once, and failed validations in fields during subscription creation/update will cause the respective request to fail.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDeadLetterPolicy\u003c/code\u003e class inherits from the \u003ccode\u003eobject\u003c/code\u003e class, and implements the interfaces \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDeadLetterPolicy\u003c/code\u003e allows configuration of \u003ccode\u003eDeadLetterTopic\u003c/code\u003e and \u003ccode\u003eMaxDeliveryAttempts\u003c/code\u003e as parameters, where the \u003ccode\u003eDeadLetterTopic\u003c/code\u003e must exist, and the \u003ccode\u003eMaxDeliveryAttempts\u003c/code\u003e must be between 5 and 100, otherwise defaults to 5 if set to 0.\u003c/p\u003e\n"]]],[],null,[]]
