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// In its binary encoding, an `Any` is an ordinary message; but in other wire 46// forms like JSON, it has a special encoding. The format of the type URL is 47// described on the `type_url` field. 48// 49// Protobuf APIs provide utilities to interact with `Any` values: 50// 51// - A 'pack' operation accepts a message and constructs a generic `Any` wrapper 52//   around it. 53// - An 'unpack' operation reads the content of an `Any` message, either into an 54//   existing message or a new one. Unpack operations must check the type of the 55//   value they unpack against the declared `type_url`. 56// - An 'is' operation decides whether an `Any` contains a message of the given 57//   type, i.e. whether it can 'unpack' that type. 58// 59// The JSON format representation of an `Any` follows one of these cases: 60// 61// - For types without special-cased JSON encodings, the JSON format 62//   representation of the `Any` is the same as that of the message, with an 63//   additional `@type` field which contains the type URL. 64// - For types with special-cased JSON encodings (typically called 'well-known' 65//   types, listed in https://protobuf.dev/programming-guides/json/#any), the 66//   JSON format representation has a key `@type` which contains the type URL 67//   and a key `value` which contains the JSON-serialized value. 68// 69// The text format representation of an `Any` is like a message with one field 70// whose name is the type URL in brackets. For example, an `Any` containing a 71// `foo.Bar` message may be written `[type.googleapis.com/foo.Bar] { a: 2 }`. 72message Any { 73  // Identifies the type of the serialized Protobuf message with a URI reference 74  // consisting of a prefix ending in a slash and the fully-qualified type name. 75  // 76  // Example: type.googleapis.com/google.protobuf.StringValue 77  // 78  // This string must contain at least one `/` character, and the content after 79  // the last `/` must be the fully-qualified name of the type in canonical 80  // form, without a leading dot. Do not write a scheme on these URI references 81  // so that clients do not attempt to contact them. 82  // 83  // The prefix is arbitrary and Protobuf implementations are expected to 84  // simply strip off everything up to and including the last `/` to identify 85  // the type. `type.googleapis.com/` is a common default prefix that some 86  // legacy implementations require. This prefix does not indicate the origin of 87  // the type, and URIs containing it are not expected to respond to any 88  // requests. 89  // 90  // All type URL strings must be legal URI references with the additional 91  // restriction (for the text format) that the content of the reference 92  // must consist only of alphanumeric characters, percent-encoded escapes, and 93  // characters in the following set (not including the outer backticks): 94  // `/-.~_!$&()*+,;=`. Despite our allowing percent encodings, implementations 95  // should not unescape them to prevent confusion with existing parsers. For 96  // example, `type.googleapis.com%2FFoo` should be rejected. 97  // 98  // In the original design of `Any`, the possibility of launching a type 99  // resolution service at these type URLs was considered but Protobuf never100  // implemented one and considers contacting these URLs to be problematic and101  // a potential security issue. Do not attempt to contact type URLs.102  string type_url = 1;103104  // Holds a Protobuf serialization of the type described by type_url.105  bytes value = 2;106}