protobuf/src/google/protobuf/any.proto at main · protocolbuffers/protobuf · GitHub

History

106 lines (101 loc) · 5.42 KB

Raw

100

101

102

103

104

105

106

// Protocol Buffers - Google's data interchange format

// https://developers.google.com/protocol-buffers/

// Redistribution and use in source and binary forms, with or without

// modification, are permitted provided that the following conditions are

// met:

// * Redistributions of source code must retain the above copyright

// notice, this list of conditions and the following disclaimer.

// * Redistributions in binary form must reproduce the above

// copyright notice, this list of conditions and the following disclaimer

// in the documentation and/or other materials provided with the

// distribution.

// * Neither the name of Google Inc. nor the names of its

// contributors may be used to endorse or promote products derived from

// this software without specific prior written permission.

// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

syntax = "proto3";

package google.protobuf;

option go_package = "google.golang.org/protobuf/types/known/anypb";

option java_package = "com.google.protobuf";

option java_outer_classname = "AnyProto";

option java_multiple_files = true;

option objc_class_prefix = "GPB";

option csharp_namespace = "Google.Protobuf.WellKnownTypes";

// `Any` contains an arbitrary serialized protocol buffer message along with a

// URL that describes the type of the serialized message.

// In its binary encoding, an `Any` is an ordinary message; but in other wire

// forms like JSON, it has a special encoding. The format of the type URL is

// described on the `type_url` field.

// Protobuf APIs provide utilities to interact with `Any` values:

// - A 'pack' operation accepts a message and constructs a generic `Any` wrapper

// around it.

// - An 'unpack' operation reads the content of an `Any` message, either into an

// existing message or a new one. Unpack operations must check the type of the

// value they unpack against the declared `type_url`.

// - An 'is' operation decides whether an `Any` contains a message of the given

// type, i.e. whether it can 'unpack' that type.

// The JSON format representation of an `Any` follows one of these cases:

// - For types without special-cased JSON encodings, the JSON format

// representation of the `Any` is the same as that of the message, with an

// additional `@type` field which contains the type URL.

// - For types with special-cased JSON encodings (typically called 'well-known'

// types, listed in https://protobuf.dev/programming-guides/json/#any), the

// JSON format representation has a key `@type` which contains the type URL

// and a key `value` which contains the JSON-serialized value.

// The text format representation of an `Any` is like a message with one field

// whose name is the type URL in brackets. For example, an `Any` containing a

// `foo.Bar` message may be written `[type.googleapis.com/foo.Bar] { a: 2 }`.

message Any {

// Identifies the type of the serialized Protobuf message with a URI reference

// consisting of a prefix ending in a slash and the fully-qualified type name.

// Example: type.googleapis.com/google.protobuf.StringValue

// This string must contain at least one `/` character, and the content after

// the last `/` must be the fully-qualified name of the type in canonical

// form, without a leading dot. Do not write a scheme on these URI references

// so that clients do not attempt to contact them.

// The prefix is arbitrary and Protobuf implementations are expected to

// simply strip off everything up to and including the last `/` to identify

// the type. `type.googleapis.com/` is a common default prefix that some

// legacy implementations require. This prefix does not indicate the origin of

// the type, and URIs containing it are not expected to respond to any

// requests.

// All type URL strings must be legal URI references with the additional

// restriction (for the text format) that the content of the reference

// must consist only of alphanumeric characters, percent-encoded escapes, and

// characters in the following set (not including the outer backticks):

// `/-.~_!$&()*+,;=`. Despite our allowing percent encodings, implementations

// should not unescape them to prevent confusion with existing parsers. For

// example, `type.googleapis.com%2FFoo` should be rejected.

// In the original design of `Any`, the possibility of launching a type

// resolution service at these type URLs was considered but Protobuf never

// implemented one and considers contacting these URLs to be problematic and

// a potential security issue. Do not attempt to contact type URLs.

string type_url = 1;

// Holds a Protobuf serialization of the type described by type_url.

bytes value = 2;

}

protobuf/src/google/protobuf/any.proto at main · protocolbuffers/protobuf · GitHub

Uh oh!

Expand file tree

Breadcrumbs

any.proto

Latest commit

History

Breadcrumbs

any.proto

File metadata and controls