final case class ReceivedMessage(ackId: String = "", message: Option[PubsubMessage] = _root_.scala.None, deliveryAttempt: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ReceivedMessage] with Product with Serializable

A message and its corresponding acknowledgment ID.

ackId

This ID can be used to acknowledge the received message.

message

The message.

deliveryAttempt

The approximate number of times that Cloud Pub/Sub has attempted to deliver the associated message to a subscriber. More precisely, this is 1 + (number of NACKs) + (number of ack_deadline exceeds) for this message. A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is whenever a message is not acknowledged within ack_deadline. Note that ack_deadline is initially Subscription.ackDeadlineSeconds, but may get extended automatically by the client library. Upon the first delivery of a given message, delivery_attempt will have a value of 1. The value is calculated at best effort and is approximate. If a DeadLetterPolicy is not set on the subscription, this will be 0.

Annotations
@SerialVersionUID()
Source
ReceivedMessage.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReceivedMessage
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ReceivedMessage(ackId: String = "", message: Option[PubsubMessage] = _root_.scala.None, deliveryAttempt: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    ackId

    This ID can be used to acknowledge the received message.

    message

    The message.

    deliveryAttempt

    The approximate number of times that Cloud Pub/Sub has attempted to deliver the associated message to a subscriber. More precisely, this is 1 + (number of NACKs) + (number of ack_deadline exceeds) for this message. A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is whenever a message is not acknowledged within ack_deadline. Note that ack_deadline is initially Subscription.ackDeadlineSeconds, but may get extended automatically by the client library. Upon the first delivery of a given message, delivery_attempt will have a value of 1. The value is calculated at best effort and is approximate. If a DeadLetterPolicy is not set on the subscription, this will be 0.

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. val ackId: String
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clearMessage: ReceivedMessage
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def companion: ReceivedMessage.type
    Definition Classes
    ReceivedMessage → GeneratedMessage
  9. val deliveryAttempt: Int
  10. def discardUnknownFields: ReceivedMessage
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    ReceivedMessage → GeneratedMessage
  15. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    ReceivedMessage → GeneratedMessage
  16. def getMessage: PubsubMessage
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val message: Option[PubsubMessage]
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def productElementNames: Iterator[String]
    Definition Classes
    Product
  23. def serializedSize: Int
    Definition Classes
    ReceivedMessage → GeneratedMessage
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  26. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  27. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  28. def toProtoString: String
    Definition Classes
    ReceivedMessage → GeneratedMessage
  29. val unknownFields: UnknownFieldSet
  30. def update(ms: (Lens[ReceivedMessage, ReceivedMessage]) => Mutation[ReceivedMessage]*): ReceivedMessage
    Definition Classes
    Updatable
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  34. def withAckId(__v: String): ReceivedMessage
  35. def withDeliveryAttempt(__v: Int): ReceivedMessage
  36. def withMessage(__v: PubsubMessage): ReceivedMessage
  37. def withUnknownFields(__v: UnknownFieldSet): ReceivedMessage
  38. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  39. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    ReceivedMessage → GeneratedMessage
  40. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Updatable[ReceivedMessage]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped