public final class Any extends GeneratedMessageLite<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)
...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
...
}
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
Static Fields
TYPE_URL_FIELD_NUMBER
public static final int TYPE_URL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
VALUE_FIELD_NUMBER
public static final int VALUE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Any getDefaultInstance()
| Returns |
|---|
| Type | Description |
Any | |
newBuilder()
public static Any.Builder newBuilder()
newBuilder(Any prototype)
public static Any.Builder newBuilder(Any prototype)
| Parameter |
|---|
| Name | Description |
prototype | Any
|
public static Any parseDelimitedFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Any | |
public static Any parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Any | |
parseFrom(byte[] data)
public static Any parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
| Returns |
|---|
| Type | Description |
Any | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Any parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Any | |
parseFrom(ByteString data)
public static Any parseFrom(ByteString data)
| Returns |
|---|
| Type | Description |
Any | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Any parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Any | |
public static Any parseFrom(CodedInputStream input)
| Returns |
|---|
| Type | Description |
Any | |
public static Any parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Any | |
public static Any parseFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Any | |
public static Any parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Any | |
parseFrom(ByteBuffer data)
public static Any parseFrom(ByteBuffer data)
| Returns |
|---|
| Type | Description |
Any | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Any parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Any | |
parser()
public static Parser<Any> parser()
Methods
dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
protected final Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
A method that implements different types of operations described in MethodToInvoke.
These different kinds of operations are required to implement message-level operations for
builders in the runtime. This method bundles those operations to reduce the generated methods
count.
NEW_INSTANCE returns a new instance of the protocol buffer that has not yet been
made immutable. See MAKE_IMMUTABLE.
IS_INITIALIZED returns null for false and the default instance for true.
It doesn't use or modify any memoized value.
GET_MEMOIZED_IS_INITIALIZED returns the memoized isInitialized byte
value.
SET_MEMOIZED_IS_INITIALIZED sets the memoized isInitialized byte value to
1 if the first parameter is not null, or to 0 if the first parameter is null.
NEW_BUILDER returns a BuilderType instance.
This method, plus the implementation of the Builder, enables the Builder class to be proguarded
away entirely on Android.
For use by generated code only.
getTypeUrl()
public String getTypeUrl()
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. 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).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http, https, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
- If no scheme is provided,
https is assumed.
- 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.)
Note: this functionality is not currently available in the official
protobuf release, and it is not used for type URLs beginning with
type.googleapis.com.
Schemes other than
http, https (or the empty scheme) might be
used with implementation specific semantics.
string type_url = 1;
| Returns |
|---|
| Type | Description |
String | The typeUrl.
|
getTypeUrlBytes()
public ByteString getTypeUrlBytes()
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. 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).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http, https, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
- If no scheme is provided,
https is assumed.
- 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.)
Note: this functionality is not currently available in the official
protobuf release, and it is not used for type URLs beginning with
type.googleapis.com.
Schemes other than
http, https (or the empty scheme) might be
used with implementation specific semantics.
string type_url = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for typeUrl.
|
getValue()
public ByteString getValue()
Must be a valid serialized protocol buffer of the above specified type.
bytes value = 2;
