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 csharp_namespace = "Google.Protobuf.WellKnownTypes"; 36option go_package = "github.com/golang/protobuf/ptypes/any"; 37option java_package = "com.google.protobuf"; 38option java_outer_classname = "AnyProto"; 39option java_multiple_files = true; 40option java_generate_equals_and_hash = true; 41option 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// Example 3: Pack and unpack a message in Python. 69// 70// foo = Foo(...) 71// any = Any() 72// any.Pack(foo) 73// ... 74// if any.Is(Foo.DESCRIPTOR): 75// any.Unpack(foo) 76// ... 77// 78// The pack methods provided by protobuf library will by default use 79// 'type.googleapis.com/full.type.name' as the type URL and the unpack 80// methods only use the fully qualified type name after the last '/' 81// in the type URL, for example "foo.bar.com/x/y.z" will yield type 82// name "y.z". 83// 84// 85// JSON 86// ==== 87// The JSON representation of an `Any` value uses the regular 88// representation of the deserialized, embedded message, with an 89// additional field `@type` which contains the type URL. Example: 90// 91// package google.profile; 92// message Person { 93// string first_name = 1; 94// string last_name = 2; 95// } 96// 97// { 98// "@type": "type.googleapis.com/google.profile.Person", 99// "firstName": <string>, 100// "lastName": <string> 101// } 102// 103// If the embedded message type is well-known and has a custom JSON 104// representation, that representation will be embedded adding a field 105// `value` which holds the custom JSON in addition to the `@type` 106// field. Example (for message [google.protobuf.Duration][]): 107// 108// { 109// "@type": "type.googleapis.com/google.protobuf.Duration", 110// "value": "1.212s" 111// } 112// 113message Any { 114 // A URL/resource name whose content describes the type of the 115 // serialized protocol buffer message. 116 // 117 // For URLs which use the scheme `http`, `https`, or no scheme, the 118 // following restrictions and interpretations apply: 119 // 120 // * If no scheme is provided, `https` is assumed. 121 // * The last segment of the URL's path must represent the fully 122 // qualified name of the type (as in `path/google.protobuf.Duration`). 123 // The name should be in a canonical form (e.g., leading "." is 124 // not accepted). 125 // * An HTTP GET on the URL must yield a [google.protobuf.Type][] 126 // value in binary format, or produce an error. 127 // * Applications are allowed to cache lookup results based on the 128 // URL, or have them precompiled into a binary to avoid any 129 // lookup. Therefore, binary compatibility needs to be preserved 130 // on changes to types. (Use versioned type names to manage 131 // breaking changes.) 132 // 133 // Schemes other than `http`, `https` (or the empty scheme) might be 134 // used with implementation specific semantics. 135 // 136 string type_url = 1; 137 138 // Must be a valid serialized protocol buffer of the above specified type. 139 bytes value = 2; 140} 141