final case class ReceivedMessage(ackId: String = "", message: Option[PubsubMessage] = _root_.scala.None, deliveryAttempt: Int = 0, unknownFields: UnknownFieldSet = ...) 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
Delivery attempt counter is 1 + (the sum of number of NACKs and 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. The first delivery of a given message will have this value as 1. The value is calculated at best effort and is approximate. If a DeadLetterPolicy is not set on the subscription, this will be 0. <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
- Annotations
- @SerialVersionUID()
- Source
- ReceivedMessage.scala
- Alphabetic
- By Inheritance
- ReceivedMessage
- Product
- Equals
- Updatable
- GeneratedMessage
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
ReceivedMessage(ackId: String = "", message: Option[PubsubMessage] = _root_.scala.None, deliveryAttempt: Int = 0, unknownFields: UnknownFieldSet = ...)
- ackId
This ID can be used to acknowledge the received message.
- message
The message.
- deliveryAttempt
Delivery attempt counter is 1 + (the sum of number of NACKs and 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. The first delivery of a given message will have this value as 1. The value is calculated at best effort and is approximate. If a DeadLetterPolicy is not set on the subscription, this will be 0. <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val ackId: String
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearMessage: ReceivedMessage
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
def
companion: ReceivedMessage.type
- Definition Classes
- ReceivedMessage → GeneratedMessage
- val deliveryAttempt: Int
- def discardUnknownFields: ReceivedMessage
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getField(__field: FieldDescriptor): PValue
- Definition Classes
- ReceivedMessage → GeneratedMessage
-
def
getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- ReceivedMessage → GeneratedMessage
- def getMessage: PubsubMessage
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val message: Option[PubsubMessage]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
serializedSize: Int
- Definition Classes
- ReceivedMessage → GeneratedMessage
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
-
final
def
toByteString: ByteString
- Definition Classes
- GeneratedMessage
-
final
def
toPMessage: PMessage
- Definition Classes
- GeneratedMessage
-
def
toProtoString: String
- Definition Classes
- ReceivedMessage → GeneratedMessage
- val unknownFields: UnknownFieldSet
-
def
update(ms: (Lens[ReceivedMessage, ReceivedMessage]) ⇒ Mutation[ReceivedMessage]*): ReceivedMessage
- Definition Classes
- Updatable
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- def withAckId(__v: String): ReceivedMessage
- def withDeliveryAttempt(__v: Int): ReceivedMessage
- def withMessage(__v: PubsubMessage): ReceivedMessage
- def withUnknownFields(__v: UnknownFieldSet): ReceivedMessage
-
final
def
writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
-
def
writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- ReceivedMessage → GeneratedMessage
-
final
def
writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage