PubSubMessage.Builder (proto-google-cloud-pubsublite-v1 1.9.3 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - 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

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`PubSubMessage.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`PubSubMessage`	`build()`
`PubSubMessage`	`buildPartial()`
`PubSubMessage.Builder`	`clear()`
`PubSubMessage.Builder`	`clearAttributes()`
`PubSubMessage.Builder`	`clearData()` The payload of the message.
`PubSubMessage.Builder`	`clearEventTime()` An optional, user-specified event time.
`PubSubMessage.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`PubSubMessage.Builder`	`clearKey()` The key used for routing messages to partitions or for compaction (e.g., keep the last N messages per key).
`PubSubMessage.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`PubSubMessage.Builder`	`clone()`
`boolean`	`containsAttributes(String key)` Optional attributes that can be used for message metadata/headers.
`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.
`PubSubMessage`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`com.google.protobuf.Timestamp`	`getEventTime()` An optional, user-specified event time.
`com.google.protobuf.Timestamp.Builder`	`getEventTimeBuilder()` 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).
`Map<String,AttributeValues>`	`getMutableAttributes()` Deprecated.
`boolean`	`hasEventTime()` An optional, user-specified event time.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`protected com.google.protobuf.MapField`	`internalGetMutableMapField(int number)`
`boolean`	`isInitialized()`
`PubSubMessage.Builder`	`mergeEventTime(com.google.protobuf.Timestamp value)` An optional, user-specified event time.
`PubSubMessage.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`PubSubMessage.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`PubSubMessage.Builder`	`mergeFrom(PubSubMessage other)`
`PubSubMessage.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`PubSubMessage.Builder`	`putAllAttributes(Map<String,AttributeValues> values)` Optional attributes that can be used for message metadata/headers.
`PubSubMessage.Builder`	`putAttributes(String key, AttributeValues value)` Optional attributes that can be used for message metadata/headers.
`PubSubMessage.Builder`	`removeAttributes(String key)` Optional attributes that can be used for message metadata/headers.
`PubSubMessage.Builder`	`setData(com.google.protobuf.ByteString value)` The payload of the message.
`PubSubMessage.Builder`	`setEventTime(com.google.protobuf.Timestamp.Builder builderForValue)` An optional, user-specified event time.
`PubSubMessage.Builder`	`setEventTime(com.google.protobuf.Timestamp value)` An optional, user-specified event time.
`PubSubMessage.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`PubSubMessage.Builder`	`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).
`PubSubMessage.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`PubSubMessage.Builder`	`setUnknownFields(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, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - 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.Builder<PubSubMessage.Builder>
  - internalGetMutableMapField
```
protected com.google.protobuf.MapField internalGetMutableMapField(int number)
```
    Overrides:
    
    internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
  - clear
```
public PubSubMessage.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
  - getDefaultInstanceForType
```
public PubSubMessage getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public PubSubMessage build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public PubSubMessage buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public PubSubMessage.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
  - setField
```
public PubSubMessage.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
  - clearField
```
public PubSubMessage.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
  - clearOneof
```
public PubSubMessage.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
  - setRepeatedField
```
public PubSubMessage.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              int index,
                                              Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
  - addRepeatedField
```
public PubSubMessage.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
  - mergeFrom
```
public PubSubMessage.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PubSubMessage.Builder>
  - mergeFrom
```
public PubSubMessage.Builder mergeFrom(PubSubMessage other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.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:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.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:
    
    getKey in interface PubSubMessageOrBuilder
    
    Returns:
    
    The key.
  - setKey
```
public PubSubMessage.Builder 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). 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
```
public PubSubMessage.Builder 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:
    
    getData in interface PubSubMessageOrBuilder
    
    Returns:
    
    The data.
  - setData
```
public PubSubMessage.Builder setData(com.google.protobuf.ByteString value)
```
```
 The payload of the message.
 
```
    bytes data = 2;
    Parameters:
    
    value - The data to set.
    
    Returns:
    
    This builder for chaining.
  - clearData
```
public PubSubMessage.Builder clearData()
```
```
 The payload of the message.
 
```
    bytes data = 2;
    Returns:
    
    This builder for chaining.
  - 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
  - clearAttributes
```
public PubSubMessage.Builder clearAttributes()
```
  - removeAttributes
```
public PubSubMessage.Builder removeAttributes(String key)
```
```
 Optional attributes that can be used for message metadata/headers.
 
```
    map<string, .google.cloud.pubsublite.v1.AttributeValues> attributes = 3;
  - getMutableAttributes
```
@Deprecated
public Map<String,AttributeValues> getMutableAttributes()
```
    Deprecated.
    
    Use alternate mutation accessors instead.
  - putAttributes
```
public PubSubMessage.Builder putAttributes(String key,
                                           AttributeValues value)
```
```
 Optional attributes that can be used for message metadata/headers.
 
```
    map<string, .google.cloud.pubsublite.v1.AttributeValues> attributes = 3;
  - putAllAttributes
```
public PubSubMessage.Builder putAllAttributes(Map<String,AttributeValues> values)
```
```
 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:
    
    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.
  - setEventTime
```
public PubSubMessage.Builder setEventTime(com.google.protobuf.Timestamp value)
```
```
 An optional, user-specified event time.
 
```
    .google.protobuf.Timestamp event_time = 4;
  - setEventTime
```
public PubSubMessage.Builder setEventTime(com.google.protobuf.Timestamp.Builder builderForValue)
```
```
 An optional, user-specified event time.
 
```
    .google.protobuf.Timestamp event_time = 4;
  - mergeEventTime
```
public PubSubMessage.Builder mergeEventTime(com.google.protobuf.Timestamp value)
```
```
 An optional, user-specified event time.
 
```
    .google.protobuf.Timestamp event_time = 4;
  - clearEventTime
```
public PubSubMessage.Builder 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:
    
    getEventTimeOrBuilder in interface PubSubMessageOrBuilder
  - setUnknownFields
```
public final PubSubMessage.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>
  - mergeUnknownFields
```
public final PubSubMessage.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PubSubMessage.Builder>

Class PubSubMessage.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetMapField

internalGetMutableMapField

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getKey

setKey

clearKey

getData

setData

clearData

getAttributesCount

containsAttributes

getAttributes

getAttributesMap

getAttributesOrDefault

getAttributesOrThrow

clearAttributes

removeAttributes

getMutableAttributes

putAttributes

putAllAttributes

hasEventTime

getEventTime

setEventTime

setEventTime

mergeEventTime

clearEventTime

getEventTimeBuilder

getEventTimeOrBuilder

setUnknownFields

mergeUnknownFields