com.google.protobuf
Class Any
- java.lang.Object
- com.google.protobuf.AbstractMessageLite
- com.google.protobuf.AbstractMessage
- com.google.protobuf.GeneratedMessageV3
- com.google.protobuf.Any
- All Implemented Interfaces:
- AnyOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable
public final class Any extends com.google.protobuf.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) ... 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 typegoogle.protobuf.Any
- See Also:
- Serialized Form
Nested Class Summary
Nested Classes 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.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
Field Summary
Fields Modifier and Type Field and Description static int
TYPE_URL_FIELD_NUMBER
static int
VALUE_FIELD_NUMBER
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description boolean
equals(java.lang.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.java.lang.String
getTypeUrl()
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message.ByteString
getTypeUrlBytes()
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message.com.google.protobuf.UnknownFieldSet
getUnknownFields()
Get theUnknownFieldSet
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.<T extends Message>
booleanis(java.lang.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.static <T extends Message>
Anypack(T message)
static <T extends Message>
Anypack(T message, java.lang.String typeUrlPrefix)
Packs a message using the given type URL prefix.static Any
parseDelimitedFrom(java.io.InputStream input)
static Any
parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Any
parseFrom(byte[] data)
static Any
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Any
parseFrom(java.nio.ByteBuffer data)
static Any
parseFrom(java.nio.ByteBuffer 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(java.io.InputStream input)
static Any
parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<Any>
parser()
Any.Builder
toBuilder()
Constructs a builder initialized with the current message.<T extends Message>
Tunpack(java.lang.Class<T> clazz)
void
writeTo(CodedOutputStream output)
Serializes the message and writes it tooutput
.Methods inherited from class com.google.protobuf.GeneratedMessageV3
getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Field Detail
TYPE_URL_FIELD_NUMBER
public static final int TYPE_URL_FIELD_NUMBER
- See Also:
- Constant Field Values
VALUE_FIELD_NUMBER
public static final int VALUE_FIELD_NUMBER
- See Also:
- Constant Field Values
Method Detail
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
Description copied from interface:MessageOrBuilder
Get theUnknownFieldSet
for this message.- Specified by:
getUnknownFields
in interfaceMessageOrBuilder
- Overrides:
getUnknownFields
in classcom.google.protobuf.GeneratedMessageV3
getDescriptor
public static final Descriptors.Descriptor getDescriptor()
pack
public static <T extends Message> Any pack(T message, java.lang.String typeUrlPrefix)
Packs a message using the given type URL prefix. The type URL will be constructed by concatenating the message type's full name to the prefix with an optional "/" separator if the prefix doesn't end with "/" already.
is
public <T extends Message> boolean is(java.lang.Class<T> clazz)
unpack
public <T extends Message> T unpack(java.lang.Class<T> clazz) throws InvalidProtocolBufferException
getTypeUrl
public java.lang.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;
- Specified by:
getTypeUrl
in interfaceAnyOrBuilder
- Returns:
- 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;
- Specified by:
getTypeUrlBytes
in interfaceAnyOrBuilder
- Returns:
- The bytes for typeUrl.
getValue
public ByteString getValue()
Must be a valid serialized protocol buffer of the above specified type.
bytes value = 2;
- Specified by:
getValue
in interfaceAnyOrBuilder
- Returns:
- The value.
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.- Specified by:
isInitialized
in interfaceMessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
writeTo
public void writeTo(CodedOutputStream output) throws java.io.IOException
Description copied from interface:MessageLite
Serializes the message and writes it tooutput
. This does not flush or close the stream.- Specified by:
writeTo
in interfaceMessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
java.io.IOException
getSerializedSize
public int getSerializedSize()
Description copied from interface:MessageLite
Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that.- Specified by:
getSerializedSize
in interfaceMessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
equals
public boolean equals(java.lang.Object obj)
Description copied from interface:Message
Compares the specified object with this message for equality. Returnstrue
if the given object is a message of the same type (as defined bygetDescriptorForType()
) and has identical values for all of its fields. Subclasses must implement this; inheritingObject.equals()
is incorrect.- Specified by:
equals
in interfaceMessage
- Overrides:
equals
in classAbstractMessage
- Parameters:
obj
- object to be compared for equality with this message- Returns:
true
if the specified object is equal to this message
hashCode
public int hashCode()
Description copied from interface:Message
Returns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheritingObject.hashCode()
is incorrect.- Specified by:
hashCode
in interfaceMessage
- Overrides:
hashCode
in classAbstractMessage
- Returns:
- the hash code value for this message
- See Also:
Map.hashCode()
parseFrom
public static Any parseFrom(java.nio.ByteBuffer data) throws InvalidProtocolBufferException
parseFrom
public static Any parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
parseFrom
public static Any parseFrom(ByteString data) throws InvalidProtocolBufferException
parseFrom
public static Any parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
parseFrom
public static Any parseFrom(byte[] data) throws InvalidProtocolBufferException
parseFrom
public static Any parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
parseFrom
public static Any parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
parseFrom
public static Any parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
parseDelimitedFrom
public static Any parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
parseDelimitedFrom
public static Any parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
parseFrom
public static Any parseFrom(CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
parseFrom
public static Any parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
newBuilderForType
public Any.Builder newBuilderForType()
Description copied from interface:MessageLite
Constructs a new builder for a message of the same type as this message.- Specified by:
newBuilderForType
in interfaceMessage
- Specified by:
newBuilderForType
in interfaceMessageLite
newBuilder
public static Any.Builder newBuilder()
newBuilder
public static Any.Builder newBuilder(Any prototype)
toBuilder
public Any.Builder toBuilder()
Description copied from interface:MessageLite
Constructs a builder initialized with the current message. Use this to derive a new message from the current one.- Specified by:
toBuilder
in interfaceMessage
- Specified by:
toBuilder
in interfaceMessageLite
getDefaultInstance
public static Any getDefaultInstance()
getParserForType
public Parser<Any> getParserForType()
Description copied from interface:MessageLite
Gets the parser for a message of the same type as this message.- Specified by:
getParserForType
in interfaceMessage
- Specified by:
getParserForType
in interfaceMessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
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 thegetDefaultInstance()
method of generated message classes in that this method is an abstract method of theMessageLite
interface whereasgetDefaultInstance()
is a static method of a specific class. They return the same thing.- Specified by:
getDefaultInstanceForType
in interfaceMessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfaceMessageOrBuilder