Packages

t

com.google.pubsub.v1

PubsubMessageOrBuilder

trait PubsubMessageOrBuilder extends MessageOrBuilder

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PubsubMessageOrBuilder
  2. MessageOrBuilder
  3. MessageLiteOrBuilder
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract 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];

  2. abstract def findInitializationErrors(): List[String]
    Definition Classes
    MessageOrBuilder
  3. abstract def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    MessageOrBuilder
  4. abstract 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];

  5. abstract 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];

  6. abstract 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];

  7. abstract 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];

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

  9. abstract def getDefaultInstanceForType(): Message
    Definition Classes
    MessageOrBuilder → MessageLiteOrBuilder
  10. abstract def getDescriptorForType(): Descriptor
    Definition Classes
    MessageOrBuilder
  11. abstract def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    MessageOrBuilder
  12. abstract def getInitializationErrorString(): String
    Definition Classes
    MessageOrBuilder
  13. abstract 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.

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

  15. abstract def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    MessageOrBuilder
  16. abstract 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.

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

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

  19. abstract 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;

  20. abstract def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    MessageOrBuilder
  21. abstract def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    MessageOrBuilder
  22. abstract def getUnknownFields(): UnknownFieldSet
    Definition Classes
    MessageOrBuilder
  23. abstract def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  24. abstract def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  25. abstract 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.

  26. abstract def isInitialized(): Boolean
    Definition Classes
    MessageLiteOrBuilder
  27. abstract def getAttributes(): Map[String, String]

    Use #getAttributesMap() instead.

    Use #getAttributesMap() instead.

    Annotations
    @Deprecated
    Deprecated

Concrete 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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from MessageOrBuilder

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped