Google.Protobuf.WellKnownTypes.Any

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Summary

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"
}

Inheritance

Inherits from: pb::IMessage< Any >

Constructors and Destructors

Any()
Any(Any other)

Properties

Descriptor
pbr::MessageDescriptor
Descriptor
pbr::MessageDescriptor pb::IMessage.
Parser
pb::MessageParser< Any >
TypeUrl
string
A URL/resource name whose content describes the type of the serialized protocol buffer message.
Value
pb::ByteString
Must be a valid serialized protocol buffer of the above specified type.

Public attributes

TypeUrlFieldNumber = 1
const int
Field number for the "type_url" field.
ValueFieldNumber = 2
const int
Field number for the "value" field.

Public functions

CalculateSize()
int
Clone()
Any
Equals(object other)
override bool
Equals(Any other)
bool
GetHashCode()
override int
MergeFrom(Any other)
void
MergeFrom(pb::CodedInputStream input)
void
ToString()
override string
Unpack< T >()
T
Unpacks the content of this Any message into the target message type, which must match the type URL within this Any message.
WriteTo(pb::CodedOutputStream output)
void

Public static functions

Pack(IMessage message)
Any
Packs the specified message into an Any message using a type URL prefix of "type.googleapis.com".
Pack(IMessage message, string typeUrlPrefix)
Any
Packs the specified message into an Any message using the specified type URL prefix.

Properties

Descriptor

pbr::MessageDescriptor Descriptor

Descriptor

pbr::MessageDescriptor pb::IMessage. Descriptor

Parser

pb::MessageParser< Any > Parser

TypeUrl

string TypeUrl

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.

Value

pb::ByteString Value

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

Public attributes

TypeUrlFieldNumber

const int TypeUrlFieldNumber = 1

Field number for the "type_url" field.

ValueFieldNumber

const int ValueFieldNumber = 2

Field number for the "value" field.

Public functions

Any

 Any()

Any

 Any(
  Any other
)

CalculateSize

int CalculateSize()

Clone

Any Clone()

Equals

override bool Equals(
  object other
)

Equals

bool Equals(
  Any other
)

GetHashCode

override int GetHashCode()

MergeFrom

void MergeFrom(
  Any other
)

MergeFrom

void MergeFrom(
  pb::CodedInputStream input
)

ToString

override string ToString()

Unpack< T >

T Unpack< T >()

Unpacks the content of this Any message into the target message type, which must match the type URL within this Any message.

Details
Template Parameters
T
The type of message to unpack the content into.
Exceptions
InvalidProtocolBufferException
The target message type doesn't match the type URL in this message
Returns
The unpacked message.

WriteTo

void WriteTo(
  pb::CodedOutputStream output
)

Public static functions

Pack

Any Pack(
  IMessage message
)

Packs the specified message into an Any message using a type URL prefix of "type.googleapis.com".

Details
Parameters
message
The message to pack.
Returns
An Any message with the content and type URL of message .

Pack

Any Pack(
  IMessage message,
  string typeUrlPrefix
)

Packs the specified message into an Any message using the specified type URL prefix.

Details
Parameters
message
The message to pack.
typeUrlPrefix
The prefix for the type URL.
Returns
An Any message with the content and type URL of message .