target.apidocs.com.google.api.services.pubsub.model.DeadLetterPolicy.html Maven / Gradle / Ivy
DeadLetterPolicy (Cloud Pub/Sub API v1-rev20240918-2.0.0)
com.google.api.services.pubsub.model
Class DeadLetterPolicy
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.pubsub.model.DeadLetterPolicy
-
public final class DeadLetterPolicy
extends com.google.api.client.json.GenericJson
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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the Cloud Pub/Sub API. For a detailed explanation see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
DeadLetterPolicy()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
DeadLetterPolicyclone()
StringgetDeadLetterTopic()
Optional.
IntegergetMaxDeliveryAttempts()
Optional.
DeadLetterPolicyset(String fieldName,
Object value)
DeadLetterPolicysetDeadLetterTopic(String deadLetterTopic)
Optional.
DeadLetterPolicysetMaxDeliveryAttempts(Integer maxDeliveryAttempts)
Optional.
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
getDeadLetterTopic
public String getDeadLetterTopic()
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:
- value or
null for none
-
setDeadLetterTopic
public DeadLetterPolicy setDeadLetterTopic(String deadLetterTopic)
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.
- Parameters:
deadLetterTopic - deadLetterTopic or null for none
-
getMaxDeliveryAttempts
public Integer getMaxDeliveryAttempts()
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:
- value or
null for none
-
setMaxDeliveryAttempts
public DeadLetterPolicy setMaxDeliveryAttempts(Integer maxDeliveryAttempts)
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.
- Parameters:
maxDeliveryAttempts - maxDeliveryAttempts or null for none
-
set
public DeadLetterPolicy set(String fieldName,
Object value)
- Overrides:
set in class com.google.api.client.json.GenericJson
-
clone
public DeadLetterPolicy clone()
- Overrides:
clone in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.