Class: Google::Apis::PubsubV1::DeadLetterPolicy
- Inherits:
-
Object
- Object
- Google::Apis::PubsubV1::DeadLetterPolicy
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/pubsub_v1/classes.rb,
generated/google/apis/pubsub_v1/representations.rb,
generated/google/apis/pubsub_v1/representations.rb
Overview
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.
Instance Attribute Summary collapse
-
#dead_letter_topic ⇒ String
The name of the topic to which dead letter messages should be published.
-
#max_delivery_attempts ⇒ Fixnum
The maximum number of delivery attempts for any message.
Instance Method Summary collapse
-
#initialize(**args) ⇒ DeadLetterPolicy
constructor
A new instance of DeadLetterPolicy.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ DeadLetterPolicy
Returns a new instance of DeadLetterPolicy.
194 195 196 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 194 def initialize(**args) update!(**args) end |
Instance Attribute Details
#dead_letter_topic ⇒ String
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.
Corresponds to the JSON property
deadLetterTopic`
179 180 181 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 179 def dead_letter_topic @dead_letter_topic end |
#max_delivery_attempts ⇒ Fixnum
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.
Corresponds to the JSON property maxDeliveryAttempts
192 193 194 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 192 def max_delivery_attempts @max_delivery_attempts end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
199 200 201 202 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 199 def update!(**args) @dead_letter_topic = args[:dead_letter_topic] if args.key?(:dead_letter_topic) @max_delivery_attempts = args[:max_delivery_attempts] if args.key?(:max_delivery_attempts) end |