com.google.pubsub.v1

Class PubsubMessage

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.pubsub.v1.PubsubMessage

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PubsubMessageOrBuilder, Serializable

public final class PubsubMessage
extends com.google.protobuf.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](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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubsubMessage.Builder A message that is published by publishers and consumed by subscribers.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ATTRIBUTES_FIELD_NUMBER
static int	DATA_FIELD_NUMBER
static int	MESSAGE_ID_FIELD_NUMBER
static int	ORDERING_KEY_FIELD_NUMBER
static int	PUBLISH_TIME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsAttributes(String key) Attributes for this message.
boolean	equals(Object obj)
Map<String,String>	getAttributes() Deprecated.
int	getAttributesCount() Attributes for this message.
Map<String,String>	getAttributesMap() Attributes for this message.
String	getAttributesOrDefault(String key, String defaultValue) Attributes for this message.
String	getAttributesOrThrow(String key) Attributes for this message.
com.google.protobuf.ByteString	getData() The message data field.
static PubsubMessage	getDefaultInstance()
PubsubMessage	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getMessageId() ID of this message, assigned by the server when the message is published.
com.google.protobuf.ByteString	getMessageIdBytes() ID of this message, assigned by the server when the message is published.
String	getOrderingKey() If non-empty, identifies related messages for which publish order should be respected.
com.google.protobuf.ByteString	getOrderingKeyBytes() If non-empty, identifies related messages for which publish order should be respected.
com.google.protobuf.Parser<PubsubMessage>	getParserForType()
com.google.protobuf.Timestamp	getPublishTime() The time at which the message was published, populated by the server when it receives the `Publish` call.
com.google.protobuf.TimestampOrBuilder	getPublishTimeOrBuilder() The time at which the message was published, populated by the server when it receives the `Publish` call.
int	getSerializedSize()
int	hashCode()
boolean	hasPublishTime() The time at which the message was published, populated by the server when it receives the `Publish` call.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static PubsubMessage.Builder	newBuilder()
static PubsubMessage.Builder	newBuilder(PubsubMessage prototype)
PubsubMessage.Builder	newBuilderForType()
protected PubsubMessage.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static PubsubMessage	parseDelimitedFrom(InputStream input)
static PubsubMessage	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PubsubMessage	parseFrom(byte[] data)
static PubsubMessage	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PubsubMessage	parseFrom(ByteBuffer data)
static PubsubMessage	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PubsubMessage	parseFrom(com.google.protobuf.ByteString data)
static PubsubMessage	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PubsubMessage	parseFrom(com.google.protobuf.CodedInputStream input)
static PubsubMessage	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PubsubMessage	parseFrom(InputStream input)
static PubsubMessage	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<PubsubMessage>	parser()
PubsubMessage.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

DATA_FIELD_NUMBER

public static final int DATA_FIELD_NUMBER

See Also:

Constant Field Values

ATTRIBUTES_FIELD_NUMBER

public static final int ATTRIBUTES_FIELD_NUMBER

See Also:

Constant Field Values

MESSAGE_ID_FIELD_NUMBER

public static final int MESSAGE_ID_FIELD_NUMBER

See Also:

Constant Field Values

PUBLISH_TIME_FIELD_NUMBER

public static final int PUBLISH_TIME_FIELD_NUMBER

See Also:

Constant Field Values

ORDERING_KEY_FIELD_NUMBER

public static final int ORDERING_KEY_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getData

public com.google.protobuf.ByteString getData()

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

bytes data = 1;

Specified by:

getData in interface PubsubMessageOrBuilder

Returns:

The data.

getAttributesCount

public int getAttributesCount()

Description copied from interface: PubsubMessageOrBuilder

 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;

Specified by:

getAttributesCount in interface PubsubMessageOrBuilder

containsAttributes

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;

Specified by:

containsAttributes in interface PubsubMessageOrBuilder

getAttributes

@Deprecated
public Map<String,String> getAttributes()

Deprecated.

Use getAttributesMap() instead.

Specified by:

getAttributes in interface PubsubMessageOrBuilder

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;

Specified by:

getAttributesMap in interface PubsubMessageOrBuilder

getAttributesOrDefault

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;

Specified by:

getAttributesOrDefault in interface PubsubMessageOrBuilder

getAttributesOrThrow

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;

Specified by:

getAttributesOrThrow in interface PubsubMessageOrBuilder

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;

Specified by:

getMessageId in interface PubsubMessageOrBuilder

Returns:

The messageId.

getMessageIdBytes

public com.google.protobuf.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;

Specified by:

getMessageIdBytes in interface PubsubMessageOrBuilder

Returns:

The bytes for messageId.

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;

Specified by:

hasPublishTime in interface PubsubMessageOrBuilder

Returns:

Whether the publishTime field is set.

getPublishTime

public com.google.protobuf.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;

Specified by:

getPublishTime in interface PubsubMessageOrBuilder

Returns:

The publishTime.

getPublishTimeOrBuilder

public com.google.protobuf.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;

Specified by:

getPublishTimeOrBuilder in interface PubsubMessageOrBuilder

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 `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;

Specified by:

getOrderingKey in interface PubsubMessageOrBuilder

Returns:

The orderingKey.

getOrderingKeyBytes

public com.google.protobuf.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 `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;

Specified by:

getOrderingKeyBytes in interface PubsubMessageOrBuilder

Returns:

The bytes for orderingKey.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static PubsubMessage parseFrom(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PubsubMessage parseFrom(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PubsubMessage parseFrom(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PubsubMessage parseFrom(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PubsubMessage parseFrom(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PubsubMessage parseFrom(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PubsubMessage parseFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static PubsubMessage parseFrom(InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static PubsubMessage parseDelimitedFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static PubsubMessage parseDelimitedFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

parseFrom

public static PubsubMessage parseFrom(com.google.protobuf.CodedInputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static PubsubMessage parseFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

newBuilderForType

public PubsubMessage.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static PubsubMessage.Builder newBuilder()

newBuilder

public static PubsubMessage.Builder newBuilder(PubsubMessage prototype)

toBuilder

public PubsubMessage.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected PubsubMessage.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static PubsubMessage getDefaultInstance()

parser

public static com.google.protobuf.Parser<PubsubMessage> parser()

getParserForType

public com.google.protobuf.Parser<PubsubMessage> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public PubsubMessage getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder