Class PubsubMessage (1.129.1)

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PubsubMessage

Implements

PubsubMessageOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,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()

Returns
Type	Description
`PubsubMessage`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static PubsubMessage.Builder newBuilder()

Returns
Type	Description
`PubsubMessage.Builder`

newBuilder(PubsubMessage prototype)

public static PubsubMessage.Builder newBuilder(PubsubMessage prototype)

Parameter
Name	Description
`prototype`	`PubsubMessage`

Returns
Type	Description
`PubsubMessage.Builder`

parseDelimitedFrom(InputStream input)

public static PubsubMessage parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`PubsubMessage`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PubsubMessage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PubsubMessage`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static PubsubMessage parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`PubsubMessage`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PubsubMessage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PubsubMessage`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static PubsubMessage parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`PubsubMessage`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PubsubMessage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PubsubMessage`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static PubsubMessage parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`PubsubMessage`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PubsubMessage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PubsubMessage`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static PubsubMessage parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`PubsubMessage`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PubsubMessage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PubsubMessage`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static PubsubMessage parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`PubsubMessage`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PubsubMessage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PubsubMessage`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<PubsubMessage> parser()

Returns
Type	Description
`Parser<PubsubMessage>`

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`

Returns
Type	Description
`boolean`

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getAttributes() (deprecated)

public Map<String,String> getAttributes()

Use #getAttributesMap() instead.

Returns
Type	Description
`Map<String,String>`

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

Returns
Type	Description
`Map<String,String>`

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

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

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

Returns
Type	Description
`ByteString`	The data.

getDefaultInstanceForType()

public PubsubMessage getDefaultInstanceForType()

Returns
Type	Description
`PubsubMessage`

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()

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()

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

Returns
Type	Description
`ByteString`	The bytes for orderingKey.

getParserForType()

public Parser<PubsubMessage> getParserForType()

Returns
Type	Description
`Parser<PubsubMessage>`

Overrides

GeneratedMessageV3.getParserForType()

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;

Returns
Type	Description
`TimestampOrBuilder`

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

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()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

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()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public PubsubMessage.Builder newBuilderForType()

Returns
Type	Description
`PubsubMessage.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PubsubMessage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`PubsubMessage.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public PubsubMessage.Builder toBuilder()

Returns
Type	Description
`PubsubMessage.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`