com.google.pubsub.v1

Class PubsubMessage.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder<BuilderType>

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessage.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 GeneratedMessage.Builder<PubsubMessage.Builder>
implements PubsubMessageOrBuilder

Protobuf type google.pubsub.v1.PubsubMessage

 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.
 

Method Summary

Modifier and Type	Method and Description
PubsubMessage	build() Constructs the message based on the state of the Builder.
PubsubMessage	buildPartial() Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields.
PubsubMessage.Builder	clear() Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
PubsubMessage.Builder	clearData() The message payload.
PubsubMessage.Builder	clearMessageId() ID of this message, assigned by the server when the message is published.
PubsubMessage.Builder	clearPublishTime() The time at which the message was published, populated by the server when it receives the `Publish` call.
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Optional attributes for this message.
ByteString	getData() The message payload.
PubsubMessage	getDefaultInstanceForType() Get an instance of the type with no fields set.
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType() Get the message's type's descriptor.
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() Optional attributes for this message.
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.
boolean	isInitialized() Returns true if all required fields in the message and all embedded messages are set, false otherwise.
PubsubMessage.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions.
PubsubMessage.Builder	mergeFrom(Message other) Merge other into the message being built.
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) Merge some unknown fields into the UnknownFieldSet for this message.
PubsubMessage.Builder	putAllAttributes(java.util.Map<java.lang.String,java.lang.String> values) Optional attributes for this message.
PubsubMessage.Builder	setData(ByteString value) The message payload.
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	setUnknownFields(UnknownFieldSet unknownFields) Set the UnknownFieldSet for this message.

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

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, newBuilderForField, setField, setRepeatedField

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

findInitializationErrors, getInitializationErrorString, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, toString

Methods inherited from class java.lang.Object

equals, 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

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

clear

public PubsubMessage.Builder clear()

Description copied from class: GeneratedMessage.Builder

Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessage.Builder<PubsubMessage.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Description copied from interface: Message.Builder

Get the message's type's descriptor. See MessageOrBuilder.getDescriptorForType().

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessage.Builder<PubsubMessage.Builder>

getDefaultInstanceForType

public PubsubMessage getDefaultInstanceForType()

Description copied from interface: MessageLiteOrBuilder

Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public PubsubMessage build()

Description copied from interface: MessageLite.Builder

Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public PubsubMessage buildPartial()

Description copied from interface: MessageLite.Builder

Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned. Subsequent changes to the Builder will not affect the returned message.

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

mergeFrom

public PubsubMessage.Builder mergeFrom(Message other)

Description copied from interface: Message.Builder

Merge other into the message being built. other must have the exact same type as this (i.e. getDescriptorForType() == other.getDescriptorForType()). Merging occurs as follows. For each field:
* For singular primitive fields, if the field is set in other, then other's value overwrites the value in this message.
* For singular message fields, if the field is set in other, it is merged into the corresponding sub-message of this message using the same merging rules.
* For repeated fields, the elements in other are concatenated with the elements in this message. * For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved. This is equivalent to the Message::MergeFrom method in C++.

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()

Description copied from interface: MessageLiteOrBuilder

Returns true if all required fields in the message and all embedded messages are set, false otherwise.

See also: MessageOrBuilder.getInitializationErrorString()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessage.Builder<PubsubMessage.Builder>

mergeFrom

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

Description copied from interface: MessageLite.Builder

Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered in extensionRegistry. Extensions not in the registry will be treated as unknown fields.

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. For JSON requests, the value of this field must be
 base64-encoded.
 

Specified by:

getData in interface PubsubMessageOrBuilder

setData

public PubsubMessage.Builder setData(ByteString value)

 The message payload. For JSON requests, the value of this field must be
 base64-encoded.
 

clearData

public PubsubMessage.Builder clearData()

 The message payload. For JSON requests, the value of this field must be
 base64-encoded.
 

getAttributes

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

 Optional attributes for this message.
 

Specified by:

getAttributes in interface PubsubMessageOrBuilder

getMutableAttributes

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

 Optional attributes for this message.
 

putAllAttributes

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

 Optional attributes for this message.
 

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.
 

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.
 

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.
 

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.
 

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.
 

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.
 

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.
 

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.
 

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.
 

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.
 

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.
 

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.
 

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.
 

Specified by:

getPublishTimeOrBuilder in interface PubsubMessageOrBuilder

setUnknownFields

public final PubsubMessage.Builder setUnknownFields(UnknownFieldSet unknownFields)

Description copied from interface: Message.Builder

Set the UnknownFieldSet for this message.

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessage.Builder<PubsubMessage.Builder>

mergeUnknownFields

public final PubsubMessage.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Description copied from interface: Message.Builder

Merge some unknown fields into the UnknownFieldSet for this message.

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessage.Builder<PubsubMessage.Builder>