Packages

c

com.google.pubsub.v1

DeadLetterPolicy

final class DeadLetterPolicy extends GeneratedMessageV3 with DeadLetterPolicyOrBuilder 

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.

Protobuf type google.pubsub.v1.DeadLetterPolicy

Source
DeadLetterPolicy.java
Linear Supertypes
DeadLetterPolicyOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DeadLetterPolicy
  2. DeadLetterPolicyOrBuilder
  3. GeneratedMessageV3
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(obj: Any): Boolean
    Definition Classes
    DeadLetterPolicy → AbstractMessage → Message → AnyRef → Any
  8. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  9. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def getDeadLetterTopic(): 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.


    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.

    string dead_letter_topic = 1;

    returns

    The deadLetterTopic.

    Definition Classes
    DeadLetterPolicy → DeadLetterPolicyOrBuilder
  12. def getDeadLetterTopicBytes(): ByteString 

    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 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.

    string dead_letter_topic = 1;

    returns

    The bytes for deadLetterTopic.

    Definition Classes
    DeadLetterPolicy → DeadLetterPolicyOrBuilder
  13. def getDefaultInstanceForType(): DeadLetterPolicy
    Definition Classes
    DeadLetterPolicy → MessageOrBuilder → MessageLiteOrBuilder
  14. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  15. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  16. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  17. def getMaxDeliveryAttempts(): Int 

    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.


    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.

    int32 max_delivery_attempts = 2;

    returns

    The maxDeliveryAttempts.

    Definition Classes
    DeadLetterPolicy → DeadLetterPolicyOrBuilder
  18. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  19. def getParserForType(): Parser[DeadLetterPolicy]
    Definition Classes
    DeadLetterPolicy → GeneratedMessageV3 → Message → MessageLite
  20. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  21. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  22. def getSerializedSize(): Int
    Definition Classes
    DeadLetterPolicy → GeneratedMessageV3 → AbstractMessage → MessageLite
  23. final def getUnknownFields(): UnknownFieldSet
    Definition Classes
    DeadLetterPolicy → GeneratedMessageV3 → MessageOrBuilder
  24. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  25. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  26. def hashCode(): Int
    Definition Classes
    DeadLetterPolicy → AbstractMessage → Message → AnyRef → Any
  27. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[v1]
    Definition Classes
    DeadLetterPolicy → GeneratedMessageV3
  28. def internalGetMapField(arg0: Int): MapField[_, _]
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  29. final def isInitialized(): Boolean
    Definition Classes
    DeadLetterPolicy → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  32. def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( ... )
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[v1]
    Definition Classes
    DeadLetterPolicy → GeneratedMessageV3
  35. def newBuilderForType(): Builder
    Definition Classes
    DeadLetterPolicy → Message → MessageLite
  36. def newBuilderForType(arg0: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  37. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[v1]
    Definition Classes
    DeadLetterPolicy → GeneratedMessageV3
  38. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  40. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( classOf[java.io.IOException] )
  41. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( classOf[java.io.IOException] )
  42. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  43. def toBuilder(): Builder
    Definition Classes
    DeadLetterPolicy → Message → MessageLite
  44. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  45. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  46. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  49. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. def writeDelimitedTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws( classOf[java.io.IOException] )
  51. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( ... )
  52. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    DeadLetterPolicy → GeneratedMessageV3 → AbstractMessage → MessageLite
  53. def writeTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws( classOf[java.io.IOException] )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from DeadLetterPolicyOrBuilder

Inherited from GeneratedMessageV3

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped