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

A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.

data

The message payload.

attributes

Optional attributes for this message.

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.

Annotations
@SerialVersionUID()
Source
PubsubMessage.scala
Linear Supertypes
Product, Equals, Updatable[PubsubMessage], Message[PubsubMessage], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PubsubMessage
  2. Product
  3. Equals
  4. Updatable
  5. Message
  6. GeneratedMessage
  7. Serializable
  8. Serializable
  9. AnyRef
  10. 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] = None)

    data

    The message payload.

    attributes

    Optional attributes for this message.

    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.

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: TraversableOnce[(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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  11. def companion: PubsubMessage.type
    Definition Classes
    PubsubMessage → GeneratedMessage
  12. val data: ByteString
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    PubsubMessage → GeneratedMessage
  16. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    PubsubMessage → GeneratedMessage
  17. def getPublishTime: Timestamp
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def mergeFrom(_input__: CodedInputStream): PubsubMessage
    Definition Classes
    PubsubMessage → Message
  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 publishTime: Option[Timestamp]
  25. final def serializedSize: Int
    Definition Classes
    PubsubMessage → GeneratedMessage
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  28. def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  29. def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  30. def toProtoString: String
    Definition Classes
    PubsubMessage → GeneratedMessage
  31. def update(ms: (Lens[PubsubMessage, PubsubMessage]) ⇒ Mutation[PubsubMessage]*): PubsubMessage
    Definition Classes
    Updatable
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def withAttributes(__v: Map[String, String]): PubsubMessage
  36. def withData(__v: ByteString): PubsubMessage
  37. def withMessageId(__v: String): PubsubMessage
  38. def withPublishTime(__v: Timestamp): PubsubMessage
  39. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  40. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    PubsubMessage → GeneratedMessage
  41. def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

  2. def getAllFields: Map[FieldDescriptor, Any]
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

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

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