Packages

c

com.google.pubsub.v1

PubsubMessage

final class PubsubMessage extends GeneratedMessageV3 with PubsubMessageOrBuilder

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.

Protobuf type google.pubsub.v1.PubsubMessage

Source
PubsubMessage.java
Linear Supertypes
PubsubMessageOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PubsubMessage
  2. PubsubMessageOrBuilder
  3. GeneratedMessageV3
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def containsAttributes(key: String): Boolean

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


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

    map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    PubsubMessage → PubsubMessageOrBuilder
    Annotations
    @Override()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(obj: AnyRef): Boolean
    Definition Classes
    PubsubMessage → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  11. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  12. def getAttributesCount(): Int

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


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

    map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    PubsubMessage → PubsubMessageOrBuilder
  13. def getAttributesMap(): Map[String, String]

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


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

    map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    PubsubMessage → PubsubMessageOrBuilder
    Annotations
    @Override()
  14. def getAttributesOrDefault(key: String, defaultValue: String): String

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


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

    map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    PubsubMessage → PubsubMessageOrBuilder
    Annotations
    @Override()
  15. def getAttributesOrThrow(key: String): String

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


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

    map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    PubsubMessage → PubsubMessageOrBuilder
    Annotations
    @Override()
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getData(): ByteString

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


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

    bytes data = 1 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The data.

    Definition Classes
    PubsubMessage → PubsubMessageOrBuilder
    Annotations
    @Override()
  18. def getDefaultInstanceForType(): PubsubMessage
    Definition Classes
    PubsubMessage → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  19. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  20. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  21. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  22. def getMessageId(): String

    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.


    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.

    string message_id = 3;

    returns

    The messageId.

    Definition Classes
    PubsubMessage → PubsubMessageOrBuilder
    Annotations
    @Override()
  23. def getMessageIdBytes(): ByteString

    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.


    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.

    string message_id = 3;

    returns

    The bytes for messageId.

    Definition Classes
    PubsubMessage → PubsubMessageOrBuilder
    Annotations
    @Override()
  24. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  25. def getOrderingKey(): String

    Optional. 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 `PubsubMessage`s published in a given
`PublishRequest` must specify the same `ordering_key` value. For more
information, see [ordering
messages](https://cloud.google.com/pubsub/docs/ordering).


    Optional. 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 `PubsubMessage`s published in a given
`PublishRequest` must specify the same `ordering_key` value. For more
information, see [ordering
messages](https://cloud.google.com/pubsub/docs/ordering).

    string ordering_key = 5 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The orderingKey.

    Definition Classes
    PubsubMessage → PubsubMessageOrBuilder
    Annotations
    @Override()
  26. def getOrderingKeyBytes(): ByteString

    Optional. 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 `PubsubMessage`s published in a given
`PublishRequest` must specify the same `ordering_key` value. For more
information, see [ordering
messages](https://cloud.google.com/pubsub/docs/ordering).


    Optional. 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 `PubsubMessage`s published in a given
`PublishRequest` must specify the same `ordering_key` value. For more
information, see [ordering
messages](https://cloud.google.com/pubsub/docs/ordering).

    string ordering_key = 5 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The bytes for orderingKey.

    Definition Classes
    PubsubMessage → PubsubMessageOrBuilder
    Annotations
    @Override()
  27. def getParserForType(): Parser[PubsubMessage]
    Definition Classes
    PubsubMessage → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  28. def getPublishTime(): Timestamp

    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.


    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.

    .google.protobuf.Timestamp publish_time = 4;

    returns

    The publishTime.

    Definition Classes
    PubsubMessage → PubsubMessageOrBuilder
    Annotations
    @Override()
  29. def getPublishTimeOrBuilder(): TimestampOrBuilder

    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.


    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.

    .google.protobuf.Timestamp publish_time = 4;

    Definition Classes
    PubsubMessage → PubsubMessageOrBuilder
    Annotations
    @Override()
  30. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  31. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  32. def getSerializedSize(): Int
    Definition Classes
    PubsubMessage → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  33. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  34. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  35. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  36. def hasPublishTime(): Boolean

    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.


    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.

    .google.protobuf.Timestamp publish_time = 4;

    returns

    Whether the publishTime field is set.

    Definition Classes
    PubsubMessage → PubsubMessageOrBuilder
    Annotations
    @Override()
  37. def hashCode(): Int
    Definition Classes
    PubsubMessage → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  38. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[v1]
    Definition Classes
    PubsubMessage → GeneratedMessageV3
    Annotations
    @Override()
  39. def internalGetMapField(arg0: Int): MapField[_ <: AnyRef, _ <: AnyRef]
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  40. def internalGetMapFieldReflection(number: Int): MapFieldReflectionAccessor
    Attributes
    protected[v1]
    Annotations
    @SuppressWarnings() @Override()
  41. final def isInitialized(): Boolean
    Definition Classes
    PubsubMessage → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  42. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  43. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  44. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  45. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[v1]
    Definition Classes
    PubsubMessage → GeneratedMessageV3
    Annotations
    @Override()
  46. def newBuilderForType(): Builder
    Definition Classes
    PubsubMessage → Message → MessageLite
    Annotations
    @Override()
  47. def newBuilderForType(arg0: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  48. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[v1]
    Definition Classes
    PubsubMessage → GeneratedMessageV3
    Annotations
    @Override() @SuppressWarnings()
  49. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  50. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  51. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  52. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  53. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  54. def toBuilder(): Builder
    Definition Classes
    PubsubMessage → Message → MessageLite
    Annotations
    @Override()
  55. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  56. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  57. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  58. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  59. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  60. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  61. def writeDelimitedTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  62. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  63. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    PubsubMessage → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  64. def writeTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

Deprecated Value Members

  1. def getAttributes(): Map[String, String]

    Use #getAttributesMap() instead.

    Use #getAttributesMap() instead.

    Definition Classes
    PubsubMessage → PubsubMessageOrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated
  2. def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
    Deprecated

Inherited from PubsubMessageOrBuilder

Inherited from GeneratedMessageV3

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped