PubsubMessage

com.google.pubsub.v1.pubsub.PubsubMessage
See thePubsubMessage companion object
final case class PubsubMessage(data: ByteString, attributes: Map[String, String], messageId: String, publishTime: Option[Timestamp], orderingKey: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[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 for more information. See [quotas and limits] (https://cloud.google.com/pubsub/quotas) for more information about message limits.

Attributes

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.

data

The message data field. If this field is empty, the message must contain at least one attribute.

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.

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.

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.

Companion:
object
Source:
PubsubMessage.scala
Graph
Supertypes
trait Updatable[PubsubMessage]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

Attributes

Source:
PubsubMessage.scala

Attributes

Source:
PubsubMessage.scala
def getField(`__field`: FieldDescriptor): PValue

Attributes

Source:
PubsubMessage.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source:
PubsubMessage.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source:
PubsubMessage.scala

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns:

human-readable representation of this message.

Source:
PubsubMessage.scala
def withData(`__v`: ByteString): PubsubMessage

Attributes

Source:
PubsubMessage.scala
def withUnknownFields(`__v`: UnknownFieldSet): PubsubMessage

Attributes

Source:
PubsubMessage.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source:
PubsubMessage.scala

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
def update(ms: Lens[PubsubMessage, PubsubMessage] => () => PubsubMessage*): A

Attributes

Inherited from:
Updatable
Source:
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala