Package 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, Serializable

public final class Any
extends GeneratedMessageV3
implements AnyOrBuilder

Protobuf type google.protobuf.Any

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Any.Builder	Protobuf type google.protobuf.Any

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, GeneratedMessageV3.ExtendableMessage<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends GeneratedMessageV3.ExtendableMessage<MessageT>>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TYPE_URL_FIELD_NUMBER
static final int	VALUE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	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 final Descriptors.Descriptor	getDescriptor()
Parser<Any>	getParserForType()	TODO(b/258340024): Remove this unnecessary intermediate implementation of this method.
int	getSerializedSize()	Get the number of bytes required to encode this message.
String	getTypeUrl()	string type_url = 1 [json_name = "typeUrl"];
ByteString	getTypeUrlBytes()	string type_url = 1 [json_name = "typeUrl"];
ByteString	getValue()	bytes value = 2 [json_name = "value"];
int	hashCode()	Returns the hash code value for this message.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()	Get the FieldAccessorTable for this type.
<T extends Message> boolean	is(Class<T> clazz)
final boolean	isInitialized()	Returns true if all required fields in the message and all embedded messages are set, false otherwise.
boolean	isSameTypeAs(Message message)
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(b/258340024): remove this together with GeneratedMessageV3.BuilderParent.
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)	Creates a new instance of this message type.
static <T extends Message> Any	pack(T message)
static <T extends Message> Any	pack(T message, String typeUrlPrefix)	Packs a message using 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 Any	parseFrom(ByteBuffer data)
static Any	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Parser<Any>	parser()
Any.Builder	toBuilder()	Constructs a builder initialized with the current message.
<T extends Message> T	unpack(Class<T> clazz)
<T extends Message> T	unpackSameTypeAs(T message)
void	writeTo(CodedOutputStream output)	Serializes the message and writes it to output.

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

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 Details

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Description copied from class: GeneratedMessageV3

Creates a new instance of this message type. Overridden in the generated code.

Overrides:

newInstance in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Description copied from class: GeneratedMessageV3

Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

pack

public static <T extends Message> Any pack(T message)

pack

public static <T extends Message> Any pack(T message,
 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(Class<T> clazz)

isSameTypeAs

public boolean isSameTypeAs(Message message)

unpack

public <T extends Message> T unpack(Class<T> clazz)
                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

unpackSameTypeAs

public <T extends Message> T unpackSameTypeAs(T message)
                                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

getTypeUrl

public String getTypeUrl()

string type_url = 1 [json_name = "typeUrl"];

Specified by:

getTypeUrl in interface AnyOrBuilder

Returns:

The typeUrl.

getTypeUrlBytes

public ByteString getTypeUrlBytes()

string type_url = 1 [json_name = "typeUrl"];

Specified by:

getTypeUrlBytes in interface AnyOrBuilder

Returns:

The bytes for typeUrl.

getValue

public ByteString getValue()

bytes value = 2 [json_name = "value"];

Specified by:

getValue in interface AnyOrBuilder

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.

See also: MessageOrBuilder.getInitializationErrorString()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Description copied from interface: MessageLite

Serializes the message and writes it to output. This does not flush or close the stream.

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

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. If this message requires more than Integer.MAX_VALUE bytes to encode, the return value will be smaller than the actual number of bytes required and might be negative.

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Description copied from interface: Message

Compares the specified object with this message for equality. Returns 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.

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

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; inheriting Object.hashCode() is incorrect.

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

Returns:

the hash code value for this message

See Also:

• Map.hashCode()

parseFrom

public static Any parseFrom(ByteBuffer data)
                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Any parseFrom(ByteBuffer data,
 ExtensionRegistryLite extensionRegistry)
                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Any parseFrom(ByteString data)
                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Any parseFrom(ByteString data,
 ExtensionRegistryLite extensionRegistry)
                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Any parseFrom(byte[] data)
                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Any parseFrom(byte[] data,
 ExtensionRegistryLite extensionRegistry)
                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Any parseFrom(InputStream input)
                     throws IOException

Throws:

IOException

parseFrom

public static Any parseFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static Any parseDelimitedFrom(InputStream input)
                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static Any parseDelimitedFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

parseFrom

public static Any parseFrom(CodedInputStream input)
                     throws IOException

Throws:

IOException

parseFrom

public static Any parseFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                     throws IOException

Throws:

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 interface Message

Specified by:

newBuilderForType in interface MessageLite

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 interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Any.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Description copied from class: GeneratedMessageV3

TODO(b/258340024): remove this together with GeneratedMessageV3.BuilderParent.

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Any getDefaultInstance()

parser

public static Parser<Any> parser()

getParserForType

public Parser<Any> getParserForType()

Description copied from class: GeneratedMessageV3

TODO(b/258340024): Remove this unnecessary intermediate implementation of this method.

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class 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 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