public final class Any extends GeneratedMessageV3 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
Modifier and Type | Class and Description |
---|---|
static class |
Any.Builder
`Any` contains an arbitrary serialized protocol buffer message along with a
URL that describes the type of the serialized message.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable
Modifier and Type | Field and Description |
---|---|
static int |
TYPE_URL_FIELD_NUMBER |
static int |
VALUE_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj)
Compares the specified object with this message for equality.
|
static Any |
getDefaultInstance() |
Any |
getDefaultInstanceForType()
Get an instance of the type with no fields set.
|
static Descriptors.Descriptor |
getDescriptor() |
Parser<Any> |
getParserForType()
Gets the parser for a message of the same type as this message.
|
int |
getSerializedSize()
Get the number of bytes required to encode this message.
|
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.
|
UnknownFieldSet |
getUnknownFields()
Get the
UnknownFieldSet for this message. |
ByteString |
getValue()
Must be a valid serialized protocol buffer of the above specified type.
|
int |
hashCode()
Returns the hash code value for this message.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable()
Get the FieldAccessorTable for this type.
|
<T extends Message> |
is(Class<T> clazz) |
boolean |
isInitialized()
Returns true if all required fields in the message and all embedded
messages are set, false otherwise.
|
static Any.Builder |
newBuilder() |
static Any.Builder |
newBuilder(Any prototype) |
Any.Builder |
newBuilderForType()
Constructs a new builder for a message of the same type as this message.
|
protected Any.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
|
static <T extends Message> |
pack(T message) |
static <T extends Message> |
pack(T message,
String typeUrlPrefix)
Packs a message uisng the given type URL prefix.
|
static Any |
parseDelimitedFrom(InputStream input) |
static Any |
parseDelimitedFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Any |
parseFrom(byte[] data) |
static Any |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry) |
static Any |
parseFrom(ByteString data) |
static Any |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry) |
static Any |
parseFrom(CodedInputStream input) |
static Any |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
static Any |
parseFrom(InputStream input) |
static Any |
parseFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<Any> |
parser() |
Any.Builder |
toBuilder()
Constructs a builder initialized with the current message.
|
<T extends Message> |
unpack(Class<T> clazz) |
void |
writeTo(CodedOutputStream output)
Serializes the message and writes it to
output . |
computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public static final int TYPE_URL_FIELD_NUMBER
public static final int VALUE_FIELD_NUMBER
public final UnknownFieldSet getUnknownFields()
MessageOrBuilder
UnknownFieldSet
for this message.getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessageV3
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
GeneratedMessageV3
internalGetFieldAccessorTable
in class GeneratedMessageV3
public static <T extends Message> Any pack(T message, String typeUrlPrefix)
public <T extends Message> T unpack(Class<T> clazz) throws InvalidProtocolBufferException
InvalidProtocolBufferException
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;
getTypeUrl
in interface AnyOrBuilder
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;
getTypeUrlBytes
in interface AnyOrBuilder
public ByteString getValue()
Must be a valid serialized protocol buffer of the above specified type.
optional bytes value = 2;
getValue
in interface AnyOrBuilder
public final boolean isInitialized()
MessageLiteOrBuilder
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3
public void writeTo(CodedOutputStream output) throws IOException
MessageLite
output
. This does not
flush or close the stream.writeTo
in interface MessageLite
writeTo
in class GeneratedMessageV3
IOException
public int getSerializedSize()
MessageLite
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessageV3
public boolean equals(Object obj)
Message
true
if the given object is a message of the same type (as
defined by getDescriptorForType()
) and has identical values for
all of its fields. Subclasses must implement this; inheriting
Object.equals()
is incorrect.equals
in interface Message
equals
in class AbstractMessage
obj
- object to be compared for equality with this messagetrue
if the specified object is equal to this messagepublic int hashCode()
Message
Object.hashCode()
is incorrect.hashCode
in interface Message
hashCode
in class AbstractMessage
Map.hashCode()
public static Any parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Any parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Any parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Any parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Any parseFrom(InputStream input) throws IOException
IOException
public static Any parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static Any parseDelimitedFrom(InputStream input) throws IOException
IOException
public static Any parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static Any parseFrom(CodedInputStream input) throws IOException
IOException
public static Any parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public Any.Builder newBuilderForType()
MessageLite
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static Any.Builder newBuilder()
public static Any.Builder newBuilder(Any prototype)
public Any.Builder toBuilder()
MessageLite
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected Any.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
GeneratedMessageV3
newBuilderForType
in class GeneratedMessageV3
public static Any getDefaultInstance()
public Parser<Any> getParserForType()
MessageLite
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
public Any getDefaultInstanceForType()
MessageLiteOrBuilder
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.getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
Copyright © 2008–2016 Google. All rights reserved.