com.google.protobuf

Class Any.Builder

java.lang.Object

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

com.google.protobuf.GeneratedMessageLite.Builder<Any,Any.Builder>

com.google.protobuf.Any.Builder

All Implemented Interfaces:

AnyOrBuilder, MessageLite.Builder, MessageLiteOrBuilder, Cloneable

Enclosing class:

Any

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

 `Any` contains an arbitrary serialized protocol buffer message along with a
 URL that describes the type of the serialized message.
 Protobuf library provides support to pack/unpack Any values in the form
 of utility functions or additional generated methods of the Any type.
 Example 1: Pack and unpack a message in C++.
     Foo foo = ...;
     Any any;
     any.PackFrom(foo);
     ...
     if (any.UnpackTo(&foo)) {
       ...
     }
 Example 2: Pack and unpack a message in Java.
     Foo foo = ...;
     Any any = Any.pack(foo);
     ...
     if (any.is(Foo.class)) {
       foo = any.unpack(Foo.class);
     }
  Example 3: Pack and unpack a message in Python.
     foo = Foo(...)
     any = Any()
     any.Pack(foo)
     ...
     if any.Is(Foo.DESCRIPTOR):
       any.Unpack(foo)
       ...
 The pack methods provided by protobuf library will by default use
 'type.googleapis.com/full.type.name' as the type URL and the unpack
 methods only use the fully qualified type name after the last '/'
 in the type URL, for example "foo.bar.com/x/y.z" will yield type
 name "y.z".
 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 `@type`
 field. Example (for message [google.protobuf.Duration][]):
     {
       "@type": "type.googleapis.com/google.protobuf.Duration",
       "value": "1.212s"
     }
 

Protobuf type google.protobuf.Any

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageLite.Builder

instance, isBuilt

Method Summary

Modifier and Type	Method and Description
Any.Builder	clearTypeUrl() A URL/resource name whose content describes the type of the serialized protocol buffer message.
Any.Builder	clearValue() Must be a valid serialized protocol buffer of the above specified type.
String	getTypeUrl() A URL/resource name whose content describes the type of the serialized protocol buffer message.
ByteString	getTypeUrlBytes() A URL/resource name whose content describes the type of the serialized protocol buffer message.
ByteString	getValue() Must be a valid serialized protocol buffer of the above specified type.
Any.Builder	setTypeUrl(String value) A URL/resource name whose content describes the type of the serialized protocol buffer message.
Any.Builder	setTypeUrlBytes(ByteString value) A URL/resource name whose content describes the type of the serialized protocol buffer message.
Any.Builder	setValue(ByteString value) Must be a valid serialized protocol buffer of the above specified type.

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

build, buildPartial, clear, clone, copyOnWrite, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom

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

addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

getDefaultInstanceForType, isInitialized

Method Detail

getTypeUrl

public String getTypeUrl()

 A URL/resource name whose content describes the type of the
 serialized protocol buffer message.
 For URLs which use the scheme `http`, `https`, or no scheme, the
 following restrictions and interpretations apply:
 * If no scheme 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`).
   The name should be in a canonical form (e.g., leading "." is
   not accepted).
 * An HTTP GET on the URL must yield a [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.)
 Schemes other than `http`, `https` (or the empty scheme) might be
 used with implementation specific semantics.
 

optional string type_url = 1;

Specified by:

getTypeUrl in interface AnyOrBuilder

getTypeUrlBytes

public ByteString getTypeUrlBytes()

 A URL/resource name whose content describes the type of the
 serialized protocol buffer message.
 For URLs which use the scheme `http`, `https`, or no scheme, the
 following restrictions and interpretations apply:
 * If no scheme 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`).
   The name should be in a canonical form (e.g., leading "." is
   not accepted).
 * An HTTP GET on the URL must yield a [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.)
 Schemes other than `http`, `https` (or the empty scheme) might be
 used with implementation specific semantics.
 

optional string type_url = 1;

Specified by:

getTypeUrlBytes in interface AnyOrBuilder

setTypeUrl

public Any.Builder setTypeUrl(String value)

 A URL/resource name whose content describes the type of the
 serialized protocol buffer message.
 For URLs which use the scheme `http`, `https`, or no scheme, the
 following restrictions and interpretations apply:
 * If no scheme 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`).
   The name should be in a canonical form (e.g., leading "." is
   not accepted).
 * An HTTP GET on the URL must yield a [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.)
 Schemes other than `http`, `https` (or the empty scheme) might be
 used with implementation specific semantics.
 

optional string type_url = 1;

clearTypeUrl

public Any.Builder clearTypeUrl()

 A URL/resource name whose content describes the type of the
 serialized protocol buffer message.
 For URLs which use the scheme `http`, `https`, or no scheme, the
 following restrictions and interpretations apply:
 * If no scheme 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`).
   The name should be in a canonical form (e.g., leading "." is
   not accepted).
 * An HTTP GET on the URL must yield a [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.)
 Schemes other than `http`, `https` (or the empty scheme) might be
 used with implementation specific semantics.
 

optional string type_url = 1;

setTypeUrlBytes

public Any.Builder setTypeUrlBytes(ByteString value)

 A URL/resource name whose content describes the type of the
 serialized protocol buffer message.
 For URLs which use the scheme `http`, `https`, or no scheme, the
 following restrictions and interpretations apply:
 * If no scheme 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`).
   The name should be in a canonical form (e.g., leading "." is
   not accepted).
 * An HTTP GET on the URL must yield a [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.)
 Schemes other than `http`, `https` (or the empty scheme) might be
 used with implementation specific semantics.
 

optional string type_url = 1;

getValue

public ByteString getValue()

 Must be a valid serialized protocol buffer of the above specified type.
 

optional bytes value = 2;

Specified by:

getValue in interface AnyOrBuilder

setValue

public Any.Builder setValue(ByteString value)

 Must be a valid serialized protocol buffer of the above specified type.
 

optional bytes value = 2;

clearValue

public Any.Builder clearValue()

 Must be a valid serialized protocol buffer of the above specified type.
 

optional bytes value = 2;