ReceivedMessage

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()

Linear Supertypes

Product, Equals, Updatable[ReceivedMessage], Message[ReceivedMessage], GeneratedMessage, Serializable, Serializable, AnyRef, Any

Instance Constructors

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

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

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

This ID can be used to acknowledge the received message.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clearMessage: ReceivedMessage
def clone(): AnyRef

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

Definition Classes
ReceivedMessage → GeneratedMessage
val deliveryAttempt: Int

The approximate number of times that Cloud Pub/Sub has attempted to deliver the associated message to a subscriber.
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.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

Definition Classes
AnyRef → Any
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
def mergeFrom(_input__: CodedInputStream): ReceivedMessage

Definition Classes
ReceivedMessage → Message
val message: Option[PubsubMessage]

The message.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def serializedSize: Int

Definition Classes
ReceivedMessage → GeneratedMessage
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toByteArray: Array[Byte]

Definition Classes
GeneratedMessage
def toByteString: ByteString

Definition Classes
GeneratedMessage
def toPMessage: PMessage

Definition Classes
GeneratedMessage
def toProtoString: String

Definition Classes
ReceivedMessage → GeneratedMessage
def update(ms: (Lens[ReceivedMessage, ReceivedMessage]) ⇒ Mutation[ReceivedMessage]*): ReceivedMessage

Definition Classes
Updatable
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def withAckId(__v: String): ReceivedMessage
def withDeliveryAttempt(__v: Int): ReceivedMessage
def withMessage(__v: PubsubMessage): ReceivedMessage
def writeDelimitedTo(output: OutputStream): Unit

Definition Classes
GeneratedMessage
def writeTo(_output__: CodedOutputStream): Unit

Definition Classes
ReceivedMessage → GeneratedMessage
def writeTo(output: OutputStream): Unit

Definition Classes
GeneratedMessage

Deprecated Value Members

def getAllFields: Map[FieldDescriptor, Any]

Definition Classes
GeneratedMessage
Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use toPMessage
def getField(field: FieldDescriptor): Any

Definition Classes
GeneratedMessage
Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue

Related Docs: object ReceivedMessage | package pubsub

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

Instance Constructors

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

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val ackId: String

final def asInstanceOf[T0]: T0

def clearMessage: ReceivedMessage

def clone(): AnyRef

def companion: ReceivedMessage.type

val deliveryAttempt: Int

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getField(__field: FieldDescriptor): PValue

def getFieldByNumber(__fieldNumber: Int): Any

def getMessage: PubsubMessage

final def isInstanceOf[T0]: Boolean

def mergeFrom(_input__: CodedInputStream): ReceivedMessage

val message: Option[PubsubMessage]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def serializedSize: Int

final def synchronized[T0](arg0: ⇒ T0): T0

def toByteArray: Array[Byte]

def toByteString: ByteString

def toPMessage: PMessage

def toProtoString: String

def update(ms: (Lens[ReceivedMessage, ReceivedMessage]) ⇒ Mutation[ReceivedMessage]*): ReceivedMessage

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withAckId(__v: String): ReceivedMessage

def withDeliveryAttempt(__v: Int): ReceivedMessage

def withMessage(__v: PubsubMessage): ReceivedMessage

def writeDelimitedTo(output: OutputStream): Unit

def writeTo(_output__: CodedOutputStream): Unit

def writeTo(output: OutputStream): Unit

Deprecated Value Members

def getAllFields: Map[FieldDescriptor, Any]

def getField(field: FieldDescriptor): Any

Inherited from Product

Inherited from Equals

Inherited from Updatable[ReceivedMessage]

Inherited from Message[ReceivedMessage]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped