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 31 syntax = "proto3"; 32 33 package google.protobuf; 34 35 option csharp_namespace = "Google.Protobuf.WellKnownTypes"; 36 option go_package = "github.com/golang/protobuf/ptypes/any"; 37 option java_package = "com.google.protobuf"; 38 option java_outer_classname = "AnyProto"; 39 option java_multiple_files = true; 40 option java_generate_equals_and_hash = true; 41 option objc_class_prefix = "GPB"; 42 43 // `Any` contains an arbitrary serialized protocol buffer message along with a 44 // URL that describes the type of the serialized message. 45 // 46 // Protobuf library provides support to pack/unpack Any values in the form 47 // of utility functions or additional generated methods of the Any type. 48 // 49 // Example 1: Pack and unpack a message in C++. 50 // 51 // Foo foo = ...; 52 // Any any; 53 // any.PackFrom(foo); 54 // ... 55 // if (any.UnpackTo(&foo)) { 56 // ... 57 // } 58 // 59 // Example 2: Pack and unpack a message in Java. 60 // 61 // Foo foo = ...; 62 // Any any = Any.pack(foo); 63 // ... 64 // if (any.is(Foo.class)) { 65 // foo = any.unpack(Foo.class); 66 // } 67 // 68 // The pack methods provided by protobuf library will by default use 69 // 'type.googleapis.com/full.type.name' as the type URL and the unpack 70 // methods only use the fully qualified type name after the last '/' 71 // in the type URL, for example "foo.bar.com/x/y.z" will yield type 72 // name "y.z". 73 // 74 // 75 // JSON 76 // ==== 77 // The JSON representation of an `Any` value uses the regular 78 // representation of the deserialized, embedded message, with an 79 // additional field `@type` which contains the type URL. Example: 80 // 81 // package google.profile; 82 // message Person { 83 // string first_name = 1; 84 // string last_name = 2; 85 // } 86 // 87 // { 88 // "@type": "type.googleapis.com/google.profile.Person", 89 // "firstName": <string>, 90 // "lastName": <string> 91 // } 92 // 93 // If the embedded message type is well-known and has a custom JSON 94 // representation, that representation will be embedded adding a field 95 // `value` which holds the custom JSON in addition to the `@type` 96 // field. Example (for message [google.protobuf.Duration][]): 97 // 98 // { 99 // "@type": "type.googleapis.com/google.protobuf.Duration", 100 // "value": "1.212s" 101 // } 102 // 103 message Any { 104 // A URL/resource name whose content describes the type of the 105 // serialized protocol buffer message. 106 // 107 // For URLs which use the schema `http`, `https`, or no schema, the 108 // following restrictions and interpretations apply: 109 // 110 // * If no schema is provided, `https` is assumed. 111 // * The last segment of the URL's path must represent the fully 112 // qualified name of the type (as in `path/google.protobuf.Duration`). 113 // The name should be in a canonical form (e.g., leading "." is 114 // not accepted). 115 // * An HTTP GET on the URL must yield a [google.protobuf.Type][] 116 // value in binary format, or produce an error. 117 // * Applications are allowed to cache lookup results based on the 118 // URL, or have them precompiled into a binary to avoid any 119 // lookup. Therefore, binary compatibility needs to be preserved 120 // on changes to types. (Use versioned type names to manage 121 // breaking changes.) 122 // 123 // Schemas other than `http`, `https` (or the empty schema) might be 124 // used with implementation specific semantics. 125 // 126 string type_url = 1; 127 128 // Must be a valid serialized protocol buffer of the above specified type. 129 bytes value = 2; 130 } 131
