PubsubMessage.Builder (proto-google-cloud-pubsub-v1 0.1.15 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<PubsubMessage.Builder>
    - - com.google.pubsub.v1.PubsubMessage.Builder

All Implemented Interfaces:: com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PubsubMessageOrBuilder, java.lang.Cloneable

Enclosing class:: PubsubMessage

public static final class PubsubMessage.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<PubsubMessage.Builder>
implements PubsubMessageOrBuilder

 A message data and its attributes. The message payload must not be empty;
 it must contain either a non-empty data field, or at least one attribute.

Protobuf type google.pubsub.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, java.lang.Object value)`
`PubsubMessage`	`build()`
`PubsubMessage`	`buildPartial()`
`PubsubMessage.Builder`	`clear()`
`PubsubMessage.Builder`	`clearAttributes()`
`PubsubMessage.Builder`	`clearData()` The message payload.
`PubsubMessage.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`PubsubMessage.Builder`	`clearMessageId()` ID of this message, assigned by the server when the message is published.
`PubsubMessage.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`PubsubMessage.Builder`	`clearPublishTime()` The time at which the message was published, populated by the server when it receives the `Publish` call.
`PubsubMessage.Builder`	`clone()`
`boolean`	`containsAttributes(java.lang.String key)` Optional attributes for this message.
`java.util.Map<java.lang.String,java.lang.String>`	`getAttributes()` Deprecated.
`int`	`getAttributesCount()` Optional attributes for this message.
`java.util.Map<java.lang.String,java.lang.String>`	`getAttributesMap()` Optional attributes for this message.
`java.lang.String`	`getAttributesOrDefault(java.lang.String key, java.lang.String defaultValue)` Optional attributes for this message.
`java.lang.String`	`getAttributesOrThrow(java.lang.String key)` Optional attributes for this message.
`com.google.protobuf.ByteString`	`getData()` The message payload.
`PubsubMessage`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`java.lang.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.
`java.util.Map<java.lang.String,java.lang.String>`	`getMutableAttributes()` Deprecated.
`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.Timestamp.Builder`	`getPublishTimeBuilder()` 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.
`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)`
`protected com.google.protobuf.MapField`	`internalGetMutableMapField(int number)`
`boolean`	`isInitialized()`
`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`	`mergePublishTime(com.google.protobuf.Timestamp value)` The time at which the message was published, populated by the server when it receives the `Publish` call.
`PubsubMessage.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`PubsubMessage.Builder`	`putAllAttributes(java.util.Map<java.lang.String,java.lang.String> values)` Optional attributes for this message.
`PubsubMessage.Builder`	`putAttributes(java.lang.String key, java.lang.String value)` Optional attributes for this message.
`PubsubMessage.Builder`	`removeAttributes(java.lang.String key)` Optional attributes for this message.
`PubsubMessage.Builder`	`setData(com.google.protobuf.ByteString value)` The message payload.
`PubsubMessage.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`PubsubMessage.Builder`	`setMessageId(java.lang.String value)` ID of this message, assigned by the server when the message is published.
`PubsubMessage.Builder`	`setMessageIdBytes(com.google.protobuf.ByteString value)` ID of this message, assigned by the server when the message is published.
`PubsubMessage.Builder`	`setPublishTime(com.google.protobuf.Timestamp.Builder builderForValue)` The time at which the message was published, populated by the server when it receives the `Publish` call.
`PubsubMessage.Builder`	`setPublishTime(com.google.protobuf.Timestamp value)` The time at which the message was published, populated by the server when it receives the `Publish` call.
`PubsubMessage.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.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, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, parseUnknownField

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

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, 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.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,
                                      java.lang.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,
                                              java.lang.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,
                                              java.lang.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 java.io.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:

java.io.IOException

getData
```
public com.google.protobuf.ByteString getData()
```
```
 The message payload.
 
```
bytes data = 1;
Specified by:

getData in interface PubsubMessageOrBuilder

setData

public PubsubMessage.Builder setData(com.google.protobuf.ByteString value)

 The message payload.

bytes data = 1;

clearData

public PubsubMessage.Builder clearData()

 The message payload.

bytes data = 1;

getAttributesCount
```
public int getAttributesCount()
```
Description copied from interface: PubsubMessageOrBuilder
```
 Optional attributes for this message.
 
```
map<string, string> attributes = 2;
Specified by:

getAttributesCount in interface PubsubMessageOrBuilder

containsAttributes
```
public boolean containsAttributes(java.lang.String key)
```
```
 Optional attributes for this message.
 
```
map<string, string> attributes = 2;
Specified by:

containsAttributes in interface PubsubMessageOrBuilder

getAttributes
```
@Deprecated
public java.util.Map<java.lang.String,java.lang.String> getAttributes()
```
Deprecated.

Use getAttributesMap() instead.

Specified by:

getAttributes in interface PubsubMessageOrBuilder

getAttributesMap

public java.util.Map<java.lang.String,java.lang.String> getAttributesMap()

 Optional attributes for this message.

map<string, string> attributes = 2;

Specified by:: getAttributesMap in interface PubsubMessageOrBuilder

getAttributesOrDefault

public java.lang.String getAttributesOrDefault(java.lang.String key,
                                               java.lang.String defaultValue)

 Optional attributes for this message.

map<string, string> attributes = 2;

Specified by:: getAttributesOrDefault in interface PubsubMessageOrBuilder

getAttributesOrThrow
```
public java.lang.String getAttributesOrThrow(java.lang.String key)
```
```
 Optional attributes for this message.
 
```
map<string, string> attributes = 2;
Specified by:

getAttributesOrThrow in interface PubsubMessageOrBuilder

clearAttributes

public PubsubMessage.Builder clearAttributes()

removeAttributes

public PubsubMessage.Builder removeAttributes(java.lang.String key)

 Optional attributes for this message.

map<string, string> attributes = 2;

getMutableAttributes

@Deprecated
public java.util.Map<java.lang.String,java.lang.String> getMutableAttributes()

Deprecated.

Use alternate mutation accessors instead.

putAttributes

public PubsubMessage.Builder putAttributes(java.lang.String key,
                                           java.lang.String value)

 Optional attributes for this message.

map<string, string> attributes = 2;

putAllAttributes

public PubsubMessage.Builder putAllAttributes(java.util.Map<java.lang.String,java.lang.String> values)

 Optional attributes for this message.

map<string, string> attributes = 2;

getMessageId

public java.lang.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

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

setMessageId

public PubsubMessage.Builder setMessageId(java.lang.String value)

 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;

clearMessageId

public PubsubMessage.Builder clearMessageId()

 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;

setMessageIdBytes

public PubsubMessage.Builder setMessageIdBytes(com.google.protobuf.ByteString value)

 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;