1// Protocol Buffers - Google's data interchange format 2// Copyright 2008 Google Inc. All rights reserved. 3// https://developers.google.com/protocol-buffers/ 4// 5// Redistribution and use in source and binary forms, with or without 6// modification, are permitted provided that the following conditions are 7// met: 8// 9// * Redistributions of source code must retain the above copyright 10// notice, this list of conditions and the following disclaimer. 11// * Redistributions in binary form must reproduce the above 12// copyright notice, this list of conditions and the following disclaimer 13// in the documentation and/or other materials provided with the 14// distribution. 15// * Neither the name of Google Inc. nor the names of its 16// contributors may be used to endorse or promote products derived from 17// this software without specific prior written permission. 18// 19// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 31syntax = "proto3"; 32 33package google.protobuf; 34 35option go_package = "google.golang.org/protobuf/types/known/anypb"; 36option java_package = "com.google.protobuf"; 37option java_outer_classname = "AnyProto"; 38option java_multiple_files = true; 39option objc_class_prefix = "GPB"; 40option csharp_namespace = "Google.Protobuf.WellKnownTypes"; 41 42// `Any` contains an arbitrary serialized protocol buffer message along with a 43// URL that describes the type of the serialized message. 44// 45// Protobuf library provides support to pack/unpack Any values in the form 46// of utility functions or additional generated methods of the Any type. 47// 48// Example 1: Pack and unpack a message in C++. 49// 50// Foo foo = ...; 51// Any any; 52// any.PackFrom(foo); 53// ... 54// if (any.UnpackTo(&foo)) { 55// ... 56// } 57// 58// Example 2: Pack and unpack a message in Java. 59// 60// Foo foo = ...; 61// Any any = Any.pack(foo); 62// ... 63// if (any.is(Foo.class)) { 64// foo = any.unpack(Foo.class); 65// } 66// // or ... 67// if (any.isSameTypeAs(Foo.getDefaultInstance())) { 68// foo = any.unpack(Foo.getDefaultInstance()); 69// } 70// 71// Example 3: Pack and unpack a message in Python. 72// 73// foo = Foo(...) 74// any = Any() 75// any.Pack(foo) 76// ... 77// if any.Is(Foo.DESCRIPTOR): 78// any.Unpack(foo) 79// ... 80// 81// Example 4: Pack and unpack a message in Go 82// 83// foo := &pb.Foo{...} 84// any, err := anypb.New(foo) 85// if err != nil { 86// ... 87// } 88// ... 89// foo := &pb.Foo{} 90// if err := any.UnmarshalTo(foo); err != nil { 91// ... 92// } 93// 94// The pack methods provided by protobuf library will by default use 95// 'type.googleapis.com/full.type.name' as the type URL and the unpack 96// methods only use the fully qualified type name after the last '/' 97// in the type URL, for example "foo.bar.com/x/y.z" will yield type 98// name "y.z". 99// 100// JSON 101// ==== 102// The JSON representation of an `Any` value uses the regular 103// representation of the deserialized, embedded message, with an 104// additional field `@type` which contains the type URL. Example: 105// 106// package google.profile; 107// message Person { 108// string first_name = 1; 109// string last_name = 2; 110// } 111// 112// { 113// "@type": "type.googleapis.com/google.profile.Person", 114// "firstName": <string>, 115// "lastName": <string> 116// } 117// 118// If the embedded message type is well-known and has a custom JSON 119// representation, that representation will be embedded adding a field 120// `value` which holds the custom JSON in addition to the `@type` 121// field. Example (for message [google.protobuf.Duration][]): 122// 123// { 124// "@type": "type.googleapis.com/google.protobuf.Duration", 125// "value": "1.212s" 126// } 127// 128message Any { 129 // A URL/resource name that uniquely identifies the type of the serialized 130 // protocol buffer message. This string must contain at least 131 // one "/" character. The last segment of the URL's path must represent 132 // the fully qualified name of the type (as in 133 // `path/google.protobuf.Duration`). The name should be in a canonical form 134 // (e.g., leading "." is not accepted). 135 // 136 // In practice, teams usually precompile into the binary all types that they 137 // expect it to use in the context of Any. However, for URLs which use the 138 // scheme `http`, `https`, or no scheme, one can optionally set up a type 139 // server that maps type URLs to message definitions as follows: 140 // 141 // * If no scheme is provided, `https` is assumed. 142 // * An HTTP GET on the URL must yield a [google.protobuf.Type][] 143 // value in binary format, or produce an error. 144 // * Applications are allowed to cache lookup results based on the 145 // URL, or have them precompiled into a binary to avoid any 146 // lookup. Therefore, binary compatibility needs to be preserved 147 // on changes to types. (Use versioned type names to manage 148 // breaking changes.) 149 // 150 // Note: this functionality is not currently available in the official 151 // protobuf release, and it is not used for type URLs beginning with 152 // type.googleapis.com. As of May 2023, there are no widely used type server 153 // implementations and no plans to implement one. 154 // 155 // Schemes other than `http`, `https` (or the empty scheme) might be 156 // used with implementation specific semantics. 157 // 158 string type_url = 1; 159 160 // Must be a valid serialized protocol buffer of the above specified type. 161 bytes value = 2; 162} 163