Class PubSubMessage.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
com.google.cloud.pubsublite.proto.PubSubMessage.Builder
- All Implemented Interfaces:
PubSubMessageOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- PubSubMessage
public static final class PubSubMessage.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
implements PubSubMessageOrBuilder
A message that is published by publishers and delivered to subscribers.Protobuf type
google.cloud.pubsublite.v1.PubSubMessage-
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()clear()The payload of the message.An optional, user-specified event time.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) clearKey()The key used for routing messages to partitions or for compaction (e.g., keep the last N messages per key).clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) clone()booleancontainsAttributes(String key) Optional attributes that can be used for message metadata/headers.Deprecated.intOptional attributes that can be used for message metadata/headers.Optional attributes that can be used for message metadata/headers.getAttributesOrDefault(String key, AttributeValues defaultValue) Optional attributes that can be used for message metadata/headers.Optional attributes that can be used for message metadata/headers.com.google.protobuf.ByteStringgetData()The payload of the message.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.Descriptorcom.google.protobuf.TimestampAn optional, user-specified event time.com.google.protobuf.Timestamp.BuilderAn optional, user-specified event time.com.google.protobuf.TimestampOrBuilderAn optional, user-specified event time.com.google.protobuf.ByteStringgetKey()The key used for routing messages to partitions or for compaction (e.g., keep the last N messages per key).Deprecated.booleanAn optional, user-specified event time.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) protected com.google.protobuf.MapFieldReflectionAccessorinternalGetMutableMapFieldReflection(int number) final booleanmergeEventTime(com.google.protobuf.Timestamp value) An optional, user-specified event time.mergeFrom(PubSubMessage other) mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) final PubSubMessage.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) putAllAttributes(Map<String, AttributeValues> values) Optional attributes that can be used for message metadata/headers.putAttributes(String key, AttributeValues value) Optional attributes that can be used for message metadata/headers.Optional attributes that can be used for message metadata/headers.removeAttributes(String key) Optional attributes that can be used for message metadata/headers.setData(com.google.protobuf.ByteString value) The payload of the message.setEventTime(com.google.protobuf.Timestamp value) An optional, user-specified event time.setEventTime(com.google.protobuf.Timestamp.Builder builderForValue) An optional, user-specified event time.setKey(com.google.protobuf.ByteString value) The key used for routing messages to partitions or for compaction (e.g., keep the last N messages per key).setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) final PubSubMessage.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
-
internalGetMutableMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number) - Overrides:
internalGetMutableMapFieldReflectionin classcom.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
-
setField
public PubSubMessage.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
-
clearField
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
-
clearOneof
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
-
setRepeatedField
public PubSubMessage.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
-
addRepeatedField
public PubSubMessage.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<PubSubMessage.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
-
mergeFrom
public PubSubMessage.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<PubSubMessage.Builder>- Throws:
IOException
-
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:
getKeyin interfacePubSubMessageOrBuilder- Returns:
- The key.
-
setKey
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;- Parameters:
value- The key to set.- Returns:
- This builder for chaining.
-
clearKey
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;- Returns:
- This builder for chaining.
-
getData
public com.google.protobuf.ByteString getData()The payload of the message.
bytes data = 2;- Specified by:
getDatain interfacePubSubMessageOrBuilder- Returns:
- The data.
-
setData
The payload of the message.
bytes data = 2;- Parameters:
value- The data to set.- Returns:
- This builder for chaining.
-
clearData
The payload of the message.
bytes data = 2;- Returns:
- This builder for chaining.
-
getAttributesCount
public int getAttributesCount()Description copied from interface:PubSubMessageOrBuilderOptional attributes that can be used for message metadata/headers.
map<string, .google.cloud.pubsublite.v1.AttributeValues> attributes = 3;- Specified by:
getAttributesCountin interfacePubSubMessageOrBuilder
-
containsAttributes
Optional attributes that can be used for message metadata/headers.
map<string, .google.cloud.pubsublite.v1.AttributeValues> attributes = 3;- Specified by:
containsAttributesin interfacePubSubMessageOrBuilder
-
getAttributes
Deprecated.UsegetAttributesMap()instead.- Specified by:
getAttributesin interfacePubSubMessageOrBuilder
-
getAttributesMap
Optional attributes that can be used for message metadata/headers.
map<string, .google.cloud.pubsublite.v1.AttributeValues> attributes = 3;- Specified by:
getAttributesMapin interfacePubSubMessageOrBuilder
-
getAttributesOrDefault
Optional attributes that can be used for message metadata/headers.
map<string, .google.cloud.pubsublite.v1.AttributeValues> attributes = 3;- Specified by:
getAttributesOrDefaultin interfacePubSubMessageOrBuilder
-
getAttributesOrThrow
Optional attributes that can be used for message metadata/headers.
map<string, .google.cloud.pubsublite.v1.AttributeValues> attributes = 3;- Specified by:
getAttributesOrThrowin interfacePubSubMessageOrBuilder
-
clearAttributes
-
removeAttributes
Optional attributes that can be used for message metadata/headers.
map<string, .google.cloud.pubsublite.v1.AttributeValues> attributes = 3; -
getMutableAttributes
Deprecated.Use alternate mutation accessors instead. -
putAttributes
Optional attributes that can be used for message metadata/headers.
map<string, .google.cloud.pubsublite.v1.AttributeValues> attributes = 3; -
putAllAttributes
Optional attributes that can be used for message metadata/headers.
map<string, .google.cloud.pubsublite.v1.AttributeValues> attributes = 3; -
putAttributesBuilderIfAbsent
Optional attributes that can be used for message metadata/headers.
map<string, .google.cloud.pubsublite.v1.AttributeValues> attributes = 3; -
hasEventTime
public boolean hasEventTime()An optional, user-specified event time.
.google.protobuf.Timestamp event_time = 4;- Specified by:
hasEventTimein interfacePubSubMessageOrBuilder- 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:
getEventTimein interfacePubSubMessageOrBuilder- Returns:
- The eventTime.
-
setEventTime
An optional, user-specified event time.
.google.protobuf.Timestamp event_time = 4; -
setEventTime
An optional, user-specified event time.
.google.protobuf.Timestamp event_time = 4; -
mergeEventTime
An optional, user-specified event time.
.google.protobuf.Timestamp event_time = 4; -
clearEventTime
An optional, user-specified event time.
.google.protobuf.Timestamp event_time = 4; -
getEventTimeBuilder
public com.google.protobuf.Timestamp.Builder getEventTimeBuilder()An optional, user-specified event time.
.google.protobuf.Timestamp event_time = 4; -
getEventTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getEventTimeOrBuilder()An optional, user-specified event time.
.google.protobuf.Timestamp event_time = 4;- Specified by:
getEventTimeOrBuilderin interfacePubSubMessageOrBuilder
-
setUnknownFields
public final PubSubMessage.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
-
mergeUnknownFields
public final PubSubMessage.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
-