com.google.pubsub.v1

Class PubsubMessage.Builder

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:

Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, PubsubMessageOrBuilder, java.lang.Cloneable

Enclosing class:

PubsubMessage

public static final class PubsubMessage.Builder
extends 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

Modifier and Type	Method and Description
PubsubMessage.Builder	addRepeatedField(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(Descriptors.FieldDescriptor field)
PubsubMessage.Builder	clearMessageId() ID of this message, assigned by the server when the message is published.
PubsubMessage.Builder	clearOneof(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.
ByteString	getData() The message payload.
PubsubMessage	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
java.lang.String	getMessageId() ID of this message, assigned by the server when the message is published.
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.
Timestamp	getPublishTime() The time at which the message was published, populated by the server when it receives the `Publish` call.
Timestamp.Builder	getPublishTimeBuilder() The time at which the message was published, populated by the server when it receives the `Publish` call.
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 GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected MapField	internalGetMapField(int number)
protected MapField	internalGetMutableMapField(int number)
boolean	isInitialized()
PubsubMessage.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
PubsubMessage.Builder	mergeFrom(Message other)
PubsubMessage.Builder	mergeFrom(PubsubMessage other)
PubsubMessage.Builder	mergePublishTime(Timestamp value) The time at which the message was published, populated by the server when it receives the `Publish` call.
PubsubMessage.Builder	mergeUnknownFields(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(ByteString value) The message payload.
PubsubMessage.Builder	setField(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(ByteString value) ID of this message, assigned by the server when the message is published.
PubsubMessage.Builder	setPublishTime(Timestamp.Builder builderForValue) The time at which the message was published, populated by the server when it receives the `Publish` call.
PubsubMessage.Builder	setPublishTime(Timestamp value) The time at which the message was published, populated by the server when it receives the `Publish` call.
PubsubMessage.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
PubsubMessage.Builder	setUnknownFields(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, setUnknownFieldsProto3

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, 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 Descriptors.Descriptor getDescriptor()

internalGetMapField

protected MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class GeneratedMessageV3.Builder<PubsubMessage.Builder>

internalGetMutableMapField

protected MapField internalGetMutableMapField(int number)

Overrides:

internalGetMutableMapField in class GeneratedMessageV3.Builder<PubsubMessage.Builder>

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<PubsubMessage.Builder>

clear

public PubsubMessage.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<PubsubMessage.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<PubsubMessage.Builder>

getDefaultInstanceForType

public PubsubMessage getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public PubsubMessage build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public PubsubMessage buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public PubsubMessage.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<PubsubMessage.Builder>

setField

public PubsubMessage.Builder setField(Descriptors.FieldDescriptor field,
                                      java.lang.Object value)

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<PubsubMessage.Builder>

clearField

public PubsubMessage.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<PubsubMessage.Builder>

clearOneof

public PubsubMessage.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<PubsubMessage.Builder>

setRepeatedField

public PubsubMessage.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                              int index,
                                              java.lang.Object value)

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<PubsubMessage.Builder>

addRepeatedField

public PubsubMessage.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                              java.lang.Object value)

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<PubsubMessage.Builder>

mergeFrom

public PubsubMessage.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<PubsubMessage.Builder>

mergeFrom

public PubsubMessage.Builder mergeFrom(PubsubMessage other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<PubsubMessage.Builder>

mergeFrom

public PubsubMessage.Builder mergeFrom(CodedInputStream input,
                                       ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<PubsubMessage.Builder>

Throws:

java.io.IOException

getData

public ByteString getData()

 The message payload.
 

bytes data = 1;

Specified by:

getData in interface PubsubMessageOrBuilder

setData

public PubsubMessage.Builder setData(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 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(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;

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;

Specified by:

hasPublishTime in interface PubsubMessageOrBuilder

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;

Specified by:

getPublishTime in interface PubsubMessageOrBuilder

setPublishTime

public PubsubMessage.Builder setPublishTime(Timestamp value)

 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;

setPublishTime

public PubsubMessage.Builder setPublishTime(Timestamp.Builder builderForValue)

 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;

mergePublishTime

public PubsubMessage.Builder mergePublishTime(Timestamp value)

 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;

clearPublishTime

public PubsubMessage.Builder clearPublishTime()

 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;

getPublishTimeBuilder

public Timestamp.Builder getPublishTimeBuilder()

 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;

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;

Specified by:

getPublishTimeOrBuilder in interface PubsubMessageOrBuilder

setUnknownFields

public final PubsubMessage.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<PubsubMessage.Builder>

mergeUnknownFields

public final PubsubMessage.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<PubsubMessage.Builder>