com.google.protobuf

Class Any.Builder

java.lang.Object

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

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

com.google.protobuf.GeneratedMessage.Builder<Any.Builder>

com.google.protobuf.Any.Builder

All Implemented Interfaces:

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

Enclosing class:

Any

public static final class Any.Builder
extends GeneratedMessage.Builder<Any.Builder>
implements AnyOrBuilder

Protobuf type google.protobuf.Any

 `Any` contains an arbitrary serialized message along with a URL
 that describes the type of the serialized message.
 JSON
 ====
 The JSON representation of an `Any` value uses the regular
 representation of the deserialized, embedded message, with an
 additional field `@type` which contains the type URL. Example:
     package google.profile;
     message Person {
       string first_name = 1;
       string last_name = 2;
     }
     {
       "@type": "type.googleapis.com/google.profile.Person",
       "firstName": <string>,
       "lastName": <string>
     }
 If the embedded message type is well-known and has a custom JSON
 representation, that representation will be embedded adding a field
 `value` which holds the custom JSON in addition to the the `@type`
 field. Example (for message [google.protobuf.Duration][google.protobuf.Duration]):
     {
       "@type": "type.googleapis.com/google.protobuf.Duration",
       "value": "1.212s"
     }
 

Method Summary

Modifier and Type	Method and Description
Any	build() Constructs the message based on the state of the Builder.
Any	buildPartial() Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields.
Any.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.
Any.Builder	clearTypeUrl() optional string type_url = 1;
Any.Builder	clearValue() optional bytes value = 2;
Any	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	getTypeUrl() optional string type_url = 1;
ByteString	getTypeUrlBytes() optional string type_url = 1;
ByteString	getValue() optional bytes value = 2;
boolean	isInitialized() Returns true if all required fields in the message and all embedded messages are set, false otherwise.
Any.Builder	mergeFrom(Any other)
Any.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions.
Any.Builder	mergeFrom(Message other) Merge other into the message being built.
Any.Builder	mergeUnknownFields(UnknownFieldSet unknownFields) Merge some unknown fields into the UnknownFieldSet for this message.
Any.Builder	setTypeUrl(java.lang.String value) optional string type_url = 1;
Any.Builder	setTypeUrlBytes(ByteString value) optional string type_url = 1;
Any.Builder	setUnknownFields(UnknownFieldSet unknownFields) Set the UnknownFieldSet for this message.
Any.Builder	setValue(ByteString value) optional bytes value = 2;

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 Any.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<Any.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<Any.Builder>

getDefaultInstanceForType

public Any 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 Any 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 Any 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 Any.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<Any.Builder>

mergeFrom

public Any.Builder mergeFrom(Any 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<Any.Builder>

mergeFrom

public Any.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<Any.Builder>

Throws:

java.io.IOException

getTypeUrl

public java.lang.String getTypeUrl()

optional string type_url = 1;

 A URL/resource name whose content describes the type of the
 serialized message.
 For URLs which use the schema `http`, `https`, or no schema, the
 following restrictions and interpretations apply:
 * If no schema is provided, `https` is assumed.
 * The last segment of the URL's path must represent the fully
   qualified name of the type (as in `path/google.protobuf.Duration`).
 * An HTTP GET on the URL must yield a [google.protobuf.Type][google.protobuf.Type]
   value in binary format, or produce an error.
 * Applications are allowed to cache lookup results based on the
   URL, or have them precompiled into a binary to avoid any
   lookup. Therefore, binary compatibility needs to be preserved
   on changes to types. (Use versioned type names to manage
   breaking changes.)
 Schemas other than `http`, `https` (or the empty schema) might be
 used with implementation specific semantics.
 

Specified by:

getTypeUrl in interface AnyOrBuilder

getTypeUrlBytes

public ByteString getTypeUrlBytes()

optional string type_url = 1;

 A URL/resource name whose content describes the type of the
 serialized message.
 For URLs which use the schema `http`, `https`, or no schema, the
 following restrictions and interpretations apply:
 * If no schema is provided, `https` is assumed.
 * The last segment of the URL's path must represent the fully
   qualified name of the type (as in `path/google.protobuf.Duration`).
 * An HTTP GET on the URL must yield a [google.protobuf.Type][google.protobuf.Type]
   value in binary format, or produce an error.
 * Applications are allowed to cache lookup results based on the
   URL, or have them precompiled into a binary to avoid any
   lookup. Therefore, binary compatibility needs to be preserved
   on changes to types. (Use versioned type names to manage
   breaking changes.)
 Schemas other than `http`, `https` (or the empty schema) might be
 used with implementation specific semantics.
 

Specified by:

getTypeUrlBytes in interface AnyOrBuilder

setTypeUrl

public Any.Builder setTypeUrl(java.lang.String value)

optional string type_url = 1;

 A URL/resource name whose content describes the type of the
 serialized message.
 For URLs which use the schema `http`, `https`, or no schema, the
 following restrictions and interpretations apply:
 * If no schema is provided, `https` is assumed.
 * The last segment of the URL's path must represent the fully
   qualified name of the type (as in `path/google.protobuf.Duration`).
 * An HTTP GET on the URL must yield a [google.protobuf.Type][google.protobuf.Type]
   value in binary format, or produce an error.
 * Applications are allowed to cache lookup results based on the
   URL, or have them precompiled into a binary to avoid any
   lookup. Therefore, binary compatibility needs to be preserved
   on changes to types. (Use versioned type names to manage
   breaking changes.)
 Schemas other than `http`, `https` (or the empty schema) might be
 used with implementation specific semantics.
 

clearTypeUrl

public Any.Builder clearTypeUrl()

optional string type_url = 1;

 A URL/resource name whose content describes the type of the
 serialized message.
 For URLs which use the schema `http`, `https`, or no schema, the
 following restrictions and interpretations apply:
 * If no schema is provided, `https` is assumed.
 * The last segment of the URL's path must represent the fully
   qualified name of the type (as in `path/google.protobuf.Duration`).
 * An HTTP GET on the URL must yield a [google.protobuf.Type][google.protobuf.Type]
   value in binary format, or produce an error.
 * Applications are allowed to cache lookup results based on the
   URL, or have them precompiled into a binary to avoid any
   lookup. Therefore, binary compatibility needs to be preserved
   on changes to types. (Use versioned type names to manage
   breaking changes.)
 Schemas other than `http`, `https` (or the empty schema) might be
 used with implementation specific semantics.
 

setTypeUrlBytes

public Any.Builder setTypeUrlBytes(ByteString value)

optional string type_url = 1;

 A URL/resource name whose content describes the type of the
 serialized message.
 For URLs which use the schema `http`, `https`, or no schema, the
 following restrictions and interpretations apply:
 * If no schema is provided, `https` is assumed.
 * The last segment of the URL's path must represent the fully
   qualified name of the type (as in `path/google.protobuf.Duration`).
 * An HTTP GET on the URL must yield a [google.protobuf.Type][google.protobuf.Type]
   value in binary format, or produce an error.
 * Applications are allowed to cache lookup results based on the
   URL, or have them precompiled into a binary to avoid any
   lookup. Therefore, binary compatibility needs to be preserved
   on changes to types. (Use versioned type names to manage
   breaking changes.)
 Schemas other than `http`, `https` (or the empty schema) might be
 used with implementation specific semantics.
 

getValue

public ByteString getValue()

optional bytes value = 2;

 Must be valid serialized data of the above specified type.
 

Specified by:

getValue in interface AnyOrBuilder

setValue

public Any.Builder setValue(ByteString value)

optional bytes value = 2;

 Must be valid serialized data of the above specified type.
 

clearValue

public Any.Builder clearValue()

optional bytes value = 2;

 Must be valid serialized data of the above specified type.
 

setUnknownFields

public final Any.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<Any.Builder>

mergeUnknownFields

public final Any.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<Any.Builder>