Class/Object

com.google.pubsub.v1.pubsub

DeadLetterPolicy

Related Docs: object DeadLetterPolicy | package pubsub

Permalink

final case class DeadLetterPolicy(deadLetterTopic: String = "", maxDeliveryAttempts: Int = 0) extends GeneratedMessage with Message[DeadLetterPolicy] with Updatable[DeadLetterPolicy] with Product with Serializable

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.

deadLetterTopic

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.

maxDeliveryAttempts

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.

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[DeadLetterPolicy], Message[DeadLetterPolicy], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DeadLetterPolicy
  2. Product
  3. Equals
  4. Updatable
  5. Message
  6. GeneratedMessage
  7. Serializable
  8. Serializable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DeadLetterPolicy(deadLetterTopic: String = "", maxDeliveryAttempts: Int = 0)

    Permalink

    deadLetterTopic

    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.

    maxDeliveryAttempts

    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.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def companion: DeadLetterPolicy.type

    Permalink
    Definition Classes
    DeadLetterPolicy → GeneratedMessage
  7. val deadLetterTopic: String

    Permalink

    The name of the topic to which dead letter messages should be published.

    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.

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def getField(__field: FieldDescriptor): PValue

    Permalink
    Definition Classes
    DeadLetterPolicy → GeneratedMessage
  12. def getFieldByNumber(__fieldNumber: Int): Any

    Permalink
    Definition Classes
    DeadLetterPolicy → GeneratedMessage
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. val maxDeliveryAttempts: Int

    Permalink

    The maximum number of delivery attempts for any message.

    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.

  15. def mergeFrom(_input__: CodedInputStream): DeadLetterPolicy

    Permalink
    Definition Classes
    DeadLetterPolicy → Message
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def serializedSize: Int

    Permalink
    Definition Classes
    DeadLetterPolicy → GeneratedMessage
  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  21. def toByteArray: Array[Byte]

    Permalink
    Definition Classes
    GeneratedMessage
  22. def toByteString: ByteString

    Permalink
    Definition Classes
    GeneratedMessage
  23. def toPMessage: PMessage

    Permalink
    Definition Classes
    GeneratedMessage
  24. def toProtoString: String

    Permalink
    Definition Classes
    DeadLetterPolicy → GeneratedMessage
  25. def update(ms: (Lens[DeadLetterPolicy, DeadLetterPolicy]) ⇒ Mutation[DeadLetterPolicy]*): DeadLetterPolicy

    Permalink
    Definition Classes
    Updatable
  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def withDeadLetterTopic(__v: String): DeadLetterPolicy

    Permalink
  30. def withMaxDeliveryAttempts(__v: Int): DeadLetterPolicy

    Permalink
  31. def writeDelimitedTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage
  32. def writeTo(_output__: CodedOutputStream): Unit

    Permalink
    Definition Classes
    DeadLetterPolicy → GeneratedMessage
  33. def writeTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def getAllFields: Map[FieldDescriptor, Any]

    Permalink
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  2. def getField(field: FieldDescriptor): Any

    Permalink
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue

Inherited from Product

Inherited from Equals

Inherited from Updatable[DeadLetterPolicy]

Inherited from Message[DeadLetterPolicy]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped