Get desktop application:
View/edit binary Protocol Buffers messages
`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 := ptypes.MarshalAny(foo) ... foo := &pb.Foo{} if err := ptypes.UnmarshalAny(any, 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" }
Used in:
, , , , , , ,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.
Must be a valid serialized protocol buffer of the above specified type.
Enum type definition.
Enum type name.
Enum value definitions.
Protocol buffer options.
The source context.
The source syntax.
Enum value definition.
Used in:
Enum value name.
Enum value number.
Protocol buffer options.
A single field of a message type.
Used in:
The field type.
The field cardinality.
The field number.
The field name.
The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list.
Whether to use alternative packed wire representation.
The protocol buffer options.
The field JSON name.
The string value of the default value of this field. Proto2 syntax only.
Whether a field is optional, required, or repeated.
Used in:
For fields with unknown cardinality.
For optional fields.
For required fields. Proto2 syntax only.
For repeated fields.
Basic field types.
Used in:
Field type unknown.
Field type double.
Field type float.
Field type int64.
Field type uint64.
Field type int32.
Field type fixed64.
Field type fixed32.
Field type bool.
Field type string.
Field type group. Proto2 syntax only, and deprecated.
Field type message.
Field type bytes.
Field type uint32.
Field type enum.
Field type sfixed32.
Field type sfixed64.
Field type sint32.
Field type sint64.
A protocol buffer option, which can be attached to a message, field, enumeration, etc.
Used in:
, , ,The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`.
The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
The syntax in which a protocol buffer element is defined.
Used in:
,Syntax `proto2`.
Syntax `proto3`.
A protocol buffer message type.
The fully qualified message name.
The list of fields.
The list of types appearing in `oneof` definitions in this type.
The protocol buffer options.
The source context.
The source syntax.