Reference documentation and code samples for the Analytics Hub V1 API class Google::Cloud::Bigquery::AnalyticsHub::V1::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.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#dead_letter_topic
defdead_letter_topic()->::String
Returns
(::String) — 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.
#dead_letter_topic=
defdead_letter_topic=(value)->::String
Parameter
value (::String) — 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.
Returns
(::String) — 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.
#max_delivery_attempts
defmax_delivery_attempts()->::Integer
Returns
(::Integer) — 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.
#max_delivery_attempts=
defmax_delivery_attempts=(value)->::Integer
Parameter
value (::Integer) — 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.
Returns
(::Integer) — 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"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Analytics Hub V1 API - Class Google::Cloud::Bigquery::AnalyticsHub::V1::DeadLetterPolicy (v0.13.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.13.1 (latest)](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/latest/Google-Cloud-Bigquery-AnalyticsHub-V1-DeadLetterPolicy)\n- [0.13.0](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.13.0/Google-Cloud-Bigquery-AnalyticsHub-V1-DeadLetterPolicy)\n- [0.12.0](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.12.0/Google-Cloud-Bigquery-AnalyticsHub-V1-DeadLetterPolicy)\n- [0.11.1](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.11.1/Google-Cloud-Bigquery-AnalyticsHub-V1-DeadLetterPolicy)\n- [0.10.0](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.10.0/Google-Cloud-Bigquery-AnalyticsHub-V1-DeadLetterPolicy)\n- [0.9.0](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.9.0/Google-Cloud-Bigquery-AnalyticsHub-V1-DeadLetterPolicy)\n- [0.8.1](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.8.1/Google-Cloud-Bigquery-AnalyticsHub-V1-DeadLetterPolicy)\n- [0.7.0](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.7.0/Google-Cloud-Bigquery-AnalyticsHub-V1-DeadLetterPolicy)\n- [0.6.0](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.6.0/Google-Cloud-Bigquery-AnalyticsHub-V1-DeadLetterPolicy)\n- [0.5.2](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.5.2/Google-Cloud-Bigquery-AnalyticsHub-V1-DeadLetterPolicy)\n- [0.4.0](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.4.0/Google-Cloud-Bigquery-AnalyticsHub-V1-DeadLetterPolicy)\n- [0.3.0](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.3.0/Google-Cloud-Bigquery-AnalyticsHub-V1-DeadLetterPolicy)\n- [0.2.1](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.2.1/Google-Cloud-Bigquery-AnalyticsHub-V1-DeadLetterPolicy)\n- [0.1.0](/ruby/docs/reference/google-cloud-bigquery-analytics_hub-v1/0.1.0/Google-Cloud-Bigquery-AnalyticsHub-V1-DeadLetterPolicy) \nReference documentation and code samples for the Analytics Hub V1 API class Google::Cloud::Bigquery::AnalyticsHub::V1::DeadLetterPolicy.\n\nDead lettering is done on a best effort basis. The same message might be\ndead lettered multiple times.\n\n\n\u003cbr /\u003e\n\nIf validation on any of the fields fails at subscription creation/updation,\nthe create/update subscription request will fail. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #dead_letter_topic\n\n def dead_letter_topic() -\u003e ::String\n\n**Returns**\n\n- (::String) --- 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.\n\n\n The operation will fail if the topic does not exist.\n Users should ensure that there is a subscription attached to this topic\n since messages published to a topic with no subscriptions are lost.\n\n### #dead_letter_topic=\n\n def dead_letter_topic=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- 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.\n\n\n The operation will fail if the topic does not exist.\n Users should ensure that there is a subscription attached to this topic\nsince messages published to a topic with no subscriptions are lost. \n**Returns**\n\n- (::String) --- 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.\n\n\n The operation will fail if the topic does not exist.\n Users should ensure that there is a subscription attached to this topic\n since messages published to a topic with no subscriptions are lost.\n\n### #max_delivery_attempts\n\n def max_delivery_attempts() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100.\n\n The number of delivery attempts is defined as 1 + (the sum of number of\n NACKs and number of times the acknowledgement deadline has been exceeded\n for the message).\n\n A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that\n client libraries may automatically extend ack_deadlines.\n\n This field will be honored on a best effort basis.\n\n If this parameter is 0, a default value of 5 is used.\n\n### #max_delivery_attempts=\n\n def max_delivery_attempts=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100.\n\n\n The number of delivery attempts is defined as 1 + (the sum of number of\n NACKs and number of times the acknowledgement deadline has been exceeded\n for the message).\n\n A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that\n client libraries may automatically extend ack_deadlines.\n\n This field will be honored on a best effort basis.\n\nIf this parameter is 0, a default value of 5 is used. \n**Returns**\n\n- (::Integer) --- Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100.\n\n The number of delivery attempts is defined as 1 + (the sum of number of\n NACKs and number of times the acknowledgement deadline has been exceeded\n for the message).\n\n A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that\n client libraries may automatically extend ack_deadlines.\n\n This field will be honored on a best effort basis.\n\n If this parameter is 0, a default value of 5 is used."]]