PubsubMessage

A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding [client library documentation](https://cloud.google.com/pubsub/docs/reference/libraries) for more information. See [quotas and limits] (https://cloud.google.com/pubsub/quotas) for more information about message limits.

data: The message data field. If this field is empty, the message must contain at least one attribute.
attributes: Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription.
messageId: ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by the publisher in a Publish call.
publishTime: The time at which the message was published, populated by the server when it receives the Publish call. It must not be populated by the publisher in a Publish call.
orderingKey: If non-empty, identifies related messages for which publish order should be respected. If a Subscription has enable_message_ordering set to true, messages published with the same non-empty ordering_key value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All PubsubMessages published in a given PublishRequest must specify the same ordering_key value.

Annotations: @SerialVersionUID()

Linear Supertypes

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

Instance Constructors

new PubsubMessage(data: ByteString = ..., attributes: Map[String, String] = ..., messageId: String = "", publishTime: Option[Timestamp] = _root_.scala.None, orderingKey: String = "")

data
The message data field. If this field is empty, the message must contain at least one attribute.
attributes
Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription.
messageId
ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by the publisher in a Publish call.
publishTime
The time at which the message was published, populated by the server when it receives the Publish call. It must not be populated by the publisher in a Publish call.
orderingKey
If non-empty, identifies related messages for which publish order should be respected. If a Subscription has enable_message_ordering set to true, messages published with the same non-empty ordering_key value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All PubsubMessages published in a given PublishRequest must specify the same ordering_key value.

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
def addAllAttributes(__vs: Iterable[(String, String)]): PubsubMessage
def addAttributes(__vs: (String, String)*): PubsubMessage
final def asInstanceOf[T0]: T0

Definition Classes
Any
val attributes: Map[String, String]

Attributes for this message.
Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription.
def clearAttributes: PubsubMessage
def clearPublishTime: PubsubMessage
def clone(): AnyRef

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

Definition Classes
PubsubMessage → GeneratedMessage
val data: ByteString

The message data field.
The message data field. If this field is empty, the message must contain at least one attribute.
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
PubsubMessage → GeneratedMessage
def getFieldByNumber(__fieldNumber: Int): Any

Definition Classes
PubsubMessage → GeneratedMessage
def getPublishTime: Timestamp
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def mergeFrom(_input__: CodedInputStream): PubsubMessage

Definition Classes
PubsubMessage → Message
val messageId: String

ID of this message, assigned by the server when the message is published.
ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by the publisher in a Publish call.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val orderingKey: String

If non-empty, identifies related messages for which publish order should be respected.
If non-empty, identifies related messages for which publish order should be respected. If a Subscription has enable_message_ordering set to true, messages published with the same non-empty ordering_key value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All PubsubMessages published in a given PublishRequest must specify the same ordering_key value.
val publishTime: Option[Timestamp]

The time at which the message was published, populated by the server when it receives the Publish call.
The time at which the message was published, populated by the server when it receives the Publish call. It must not be populated by the publisher in a Publish call.
final def serializedSize: Int

Definition Classes
PubsubMessage → 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
PubsubMessage → GeneratedMessage
def update(ms: (Lens[PubsubMessage, PubsubMessage]) ⇒ Mutation[PubsubMessage]*): PubsubMessage

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 withAttributes(__v: Map[String, String]): PubsubMessage
def withData(__v: ByteString): PubsubMessage
def withMessageId(__v: String): PubsubMessage
def withOrderingKey(__v: String): PubsubMessage
def withPublishTime(__v: Timestamp): PubsubMessage
def writeDelimitedTo(output: OutputStream): Unit

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

Definition Classes
PubsubMessage → 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 PubsubMessage | package pubsub

Instance Constructors

new PubsubMessage(data: ByteString = ..., attributes: Map[String, String] = ..., messageId: String = "", publishTime: Option[Timestamp] = _root_.scala.None, orderingKey: String = "")

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addAllAttributes(__vs: Iterable[(String, String)]): PubsubMessage

def addAttributes(__vs: (String, String)*): PubsubMessage

final def asInstanceOf[T0]: T0

val attributes: Map[String, String]

def clearAttributes: PubsubMessage

def clearPublishTime: PubsubMessage

def clone(): AnyRef

def companion: PubsubMessage.type

val data: ByteString

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getField(__field: FieldDescriptor): PValue

def getFieldByNumber(__fieldNumber: Int): Any

def getPublishTime: Timestamp

final def isInstanceOf[T0]: Boolean

def mergeFrom(_input__: CodedInputStream): PubsubMessage

val messageId: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val orderingKey: String

val publishTime: Option[Timestamp]

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[PubsubMessage, PubsubMessage]) ⇒ Mutation[PubsubMessage]*): PubsubMessage

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withAttributes(__v: Map[String, String]): PubsubMessage

def withData(__v: ByteString): PubsubMessage

def withMessageId(__v: String): PubsubMessage

def withOrderingKey(__v: String): PubsubMessage

def withPublishTime(__v: Timestamp): PubsubMessage

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[PubsubMessage]

Inherited from Message[PubsubMessage]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped