com.google.cloud.pubsublite.proto

Class PubSubMessage

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.pubsublite.proto.PubSubMessage

All Implemented Interfaces:

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

public final class PubSubMessage
extends com.google.protobuf.GeneratedMessageV3
implements PubSubMessageOrBuilder

 A message that is published by publishers and delivered to subscribers.
 

Protobuf type google.cloud.pubsublite.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 delivered to subscribers.

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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	EVENT_TIME_FIELD_NUMBER
static int	KEY_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) Optional attributes that can be used for message metadata/headers.
boolean	equals(Object obj)
Map<String,AttributeValues>	getAttributes() Deprecated.
int	getAttributesCount() Optional attributes that can be used for message metadata/headers.
Map<String,AttributeValues>	getAttributesMap() Optional attributes that can be used for message metadata/headers.
AttributeValues	getAttributesOrDefault(String key, AttributeValues defaultValue) Optional attributes that can be used for message metadata/headers.
AttributeValues	getAttributesOrThrow(String key) Optional attributes that can be used for message metadata/headers.
com.google.protobuf.ByteString	getData() The payload of the message.
static PubSubMessage	getDefaultInstance()
PubSubMessage	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Timestamp	getEventTime() An optional, user-specified event time.
com.google.protobuf.TimestampOrBuilder	getEventTimeOrBuilder() An optional, user-specified event time.
com.google.protobuf.ByteString	getKey() The key used for routing messages to partitions or for compaction (e.g., keep the last N messages per key).
com.google.protobuf.Parser<PubSubMessage>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasEventTime() An optional, user-specified event time.
int	hashCode()
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, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, 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, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER

See Also:

Constant Field Values

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

EVENT_TIME_FIELD_NUMBER

public static final int EVENT_TIME_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

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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

getKey

public com.google.protobuf.ByteString getKey()

 The key used for routing messages to partitions or for compaction (e.g.,
 keep the last N messages per key). If the key is empty, the message is
 routed to an arbitrary partition.
 

bytes key = 1;

Specified by:

getKey in interface PubSubMessageOrBuilder

Returns:

The key.

getData

public com.google.protobuf.ByteString getData()

 The payload of the message.
 

bytes data = 2;

Specified by:

getData in interface PubSubMessageOrBuilder

Returns:

The data.

getAttributesCount

public int getAttributesCount()

Description copied from interface: PubSubMessageOrBuilder

 Optional attributes that can be used for message metadata/headers.
 

map<string, .google.cloud.pubsublite.v1.AttributeValues> attributes = 3;

Specified by:

getAttributesCount in interface PubSubMessageOrBuilder

containsAttributes

public boolean containsAttributes(String key)

 Optional attributes that can be used for message metadata/headers.
 

map<string, .google.cloud.pubsublite.v1.AttributeValues> attributes = 3;

Specified by:

containsAttributes in interface PubSubMessageOrBuilder

getAttributes

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

Deprecated.

Use getAttributesMap() instead.

Specified by:

getAttributes in interface PubSubMessageOrBuilder

getAttributesMap

public Map<String,AttributeValues> getAttributesMap()

 Optional attributes that can be used for message metadata/headers.
 

map<string, .google.cloud.pubsublite.v1.AttributeValues> attributes = 3;

Specified by:

getAttributesMap in interface PubSubMessageOrBuilder

getAttributesOrDefault

public AttributeValues getAttributesOrDefault(String key,
                                              AttributeValues defaultValue)

 Optional attributes that can be used for message metadata/headers.
 

map<string, .google.cloud.pubsublite.v1.AttributeValues> attributes = 3;

Specified by:

getAttributesOrDefault in interface PubSubMessageOrBuilder

getAttributesOrThrow

public AttributeValues getAttributesOrThrow(String key)

 Optional attributes that can be used for message metadata/headers.
 

map<string, .google.cloud.pubsublite.v1.AttributeValues> attributes = 3;

Specified by:

getAttributesOrThrow in interface PubSubMessageOrBuilder

hasEventTime

public boolean hasEventTime()

 An optional, user-specified event time.
 

.google.protobuf.Timestamp event_time = 4;

Specified by:

hasEventTime in interface PubSubMessageOrBuilder

Returns:

Whether the eventTime field is set.

getEventTime

public com.google.protobuf.Timestamp getEventTime()

 An optional, user-specified event time.
 

.google.protobuf.Timestamp event_time = 4;

Specified by:

getEventTime in interface PubSubMessageOrBuilder

Returns:

The eventTime.

getEventTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getEventTimeOrBuilder()

 An optional, user-specified event time.
 

.google.protobuf.Timestamp event_time = 4;

Specified by:

getEventTimeOrBuilder in interface PubSubMessageOrBuilder

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