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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ATTRIBUTES_FIELD_NUMBER
public static final int ATTRIBUTES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DATA_FIELD_NUMBER
public static final int DATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MESSAGE_ID_FIELD_NUMBER
public static final int MESSAGE_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ORDERING_KEY_FIELD_NUMBER
public static final int ORDERING_KEY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PUBLISH_TIME_FIELD_NUMBER
public static final int PUBLISH_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static PubsubMessage getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PubsubMessage.Builder newBuilder()
newBuilder(PubsubMessage prototype)
public static PubsubMessage.Builder newBuilder(PubsubMessage prototype)
public static PubsubMessage parseDelimitedFrom(InputStream input)
public static PubsubMessage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PubsubMessage parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PubsubMessage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PubsubMessage parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PubsubMessage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PubsubMessage parseFrom(CodedInputStream input)
public static PubsubMessage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PubsubMessage parseFrom(InputStream input)
public static PubsubMessage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PubsubMessage parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PubsubMessage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PubsubMessage> parser()
Methods
containsAttributes(String key)
public boolean containsAttributes(String key)
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];
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAttributes() (deprecated)
public Map<String,String> getAttributes()
getAttributesCount()
public int getAttributesCount()
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];
| Returns |
| Type |
Description |
int |
|
getAttributesMap()
public Map<String,String> getAttributesMap()
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];
getAttributesOrDefault(String key, String defaultValue)
public String getAttributesOrDefault(String key, String defaultValue)
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];
| Returns |
| Type |
Description |
String |
|
getAttributesOrThrow(String key)
public String getAttributesOrThrow(String key)
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];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getData()
public ByteString getData()
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];
getDefaultInstanceForType()
public PubsubMessage getDefaultInstanceForType()
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;
| Returns |
| 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;
| Returns |
| Type |
Description |
ByteString |
The bytes for messageId.
|
getOrderingKey()
public String getOrderingKey()
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 PubsubMessages published in a given
PublishRequest must specify the same ordering_key value. For more
information, see ordering
messages.
string ordering_key = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The orderingKey.
|
getOrderingKeyBytes()
public ByteString getOrderingKeyBytes()
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 PubsubMessages published in a given
PublishRequest must specify the same ordering_key value. For more
information, see ordering
messages.
string ordering_key = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for orderingKey.
|
getParserForType()
public Parser<PubsubMessage> getParserForType()
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;
| Returns |
| Type |
Description |
Timestamp |
The publishTime.
|
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 |
| Type |
Description |
int |
|
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;
| Returns |
| Type |
Description |
boolean |
Whether the publishTime field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PubsubMessage.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PubsubMessage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public PubsubMessage.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
