public final class PubsubMessage extends GeneratedMessageV3 implements 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 for
more information. See quotas and limits for more information about message
limits.
Protobuf type google.pubsub.v1.PubsubMessage
Static Fields
ATTRIBUTES_FIELD_NUMBER
public static final int ATTRIBUTES_FIELD_NUMBER
Field Value
DATA_FIELD_NUMBER
public static final int DATA_FIELD_NUMBER
Field Value
MESSAGE_ID_FIELD_NUMBER
public static final int MESSAGE_ID_FIELD_NUMBER
Field Value
ORDERING_KEY_FIELD_NUMBER
public static final int ORDERING_KEY_FIELD_NUMBER
Field Value
PUBLISH_TIME_FIELD_NUMBER
public static final int PUBLISH_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static PubsubMessage getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static PubsubMessage.Builder newBuilder()
Returns
newBuilder(PubsubMessage prototype)
public static PubsubMessage.Builder newBuilder(PubsubMessage prototype)
Parameter
Returns
public static PubsubMessage parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static PubsubMessage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static PubsubMessage parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PubsubMessage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static PubsubMessage parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PubsubMessage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PubsubMessage parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static PubsubMessage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PubsubMessage parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static PubsubMessage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static PubsubMessage parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PubsubMessage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<PubsubMessage> parser()
Returns
Methods
containsAttributes(String key)
public boolean containsAttributes(String key)
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;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAttributes()
public Map<String,String> getAttributes()
Returns
getAttributesCount()
public int getAttributesCount()
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;
getAttributesMap()
public Map<String,String> getAttributesMap()
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;
getAttributesOrDefault(String key, String defaultValue)
public String getAttributesOrDefault(String key, String defaultValue)
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;
getAttributesOrThrow(String key)
public String getAttributesOrThrow(String key)
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;
getData()
public ByteString getData()
The message data field. If this field is empty, the message must contain
at least one attribute.
bytes data = 1;
getDefaultInstanceForType()
public PubsubMessage getDefaultInstanceForType()
Returns
getMessageId()
public String getMessageId()
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;
| Type | Description |
| String | The messageId.
|
getMessageIdBytes()
public ByteString getMessageIdBytes()
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;
getOrderingKey()
public String getOrderingKey()
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.
string ordering_key = 5;
| Type | Description |
| String | The orderingKey.
|
getOrderingKeyBytes()
public ByteString getOrderingKeyBytes()
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.
string ordering_key = 5;
| Type | Description |
| ByteString | The bytes for orderingKey.
|
getParserForType()
public Parser<PubsubMessage> getParserForType()
Returns
Overrides
getPublishTime()
public Timestamp getPublishTime()
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;
getPublishTimeOrBuilder()
public TimestampOrBuilder getPublishTimeOrBuilder()
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;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasPublishTime()
public boolean hasPublishTime()
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;
| Type | Description |
| boolean | Whether the publishTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public PubsubMessage.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PubsubMessage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public PubsubMessage.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
