final case class PubsubMessage(data: ByteString = ..., attributes: Map[String, String] = ..., messageId: String = "", publishTime: Option[Timestamp] = _root_.scala.None, orderingKey: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[PubsubMessage] with Product with Serializable

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 <a href="https://cloud.google.com/pubsub/docs/reference/libraries">client library documentation</a> for more information. See <a href="https://cloud.google.com/pubsub/quotas">Quotas and limits</a> 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.

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. <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
PubsubMessage.scala
Linear Supertypes
Product, Equals, Updatable[PubsubMessage], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PubsubMessage
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    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.

    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. <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

  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. def addAllAttributes(__vs: Iterable[(String, String)]): PubsubMessage
  5. def addAttributes(__vs: (String, String)*): PubsubMessage
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val attributes: Map[String, String]
  8. def clearAttributes: PubsubMessage
  9. def clearPublishTime: PubsubMessage
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  11. def companion: PubsubMessage.type
    Definition Classes
    PubsubMessage → GeneratedMessage
  12. val data: ByteString
  13. def discardUnknownFields: PubsubMessage
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    PubsubMessage → GeneratedMessage
  17. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    PubsubMessage → GeneratedMessage
  18. def getPublishTime: Timestamp
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val messageId: String
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. val orderingKey: String
  25. val publishTime: Option[Timestamp]
  26. def serializedSize: Int
    Definition Classes
    PubsubMessage → GeneratedMessage
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  29. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  30. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  31. def toProtoString: String
    Definition Classes
    PubsubMessage → GeneratedMessage
  32. val unknownFields: UnknownFieldSet
  33. def update(ms: (Lens[PubsubMessage, PubsubMessage]) ⇒ Mutation[PubsubMessage]*): PubsubMessage
    Definition Classes
    Updatable
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. def withAttributes(__v: Map[String, String]): PubsubMessage
  38. def withData(__v: ByteString): PubsubMessage
  39. def withMessageId(__v: String): PubsubMessage
  40. def withOrderingKey(__v: String): PubsubMessage
  41. def withPublishTime(__v: Timestamp): PubsubMessage
  42. def withUnknownFields(__v: UnknownFieldSet): PubsubMessage
  43. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  44. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    PubsubMessage → GeneratedMessage
  45. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Product

Inherited from Equals

Inherited from Updatable[PubsubMessage]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped