any.proto 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  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. syntax = "proto3";
  31. package google.protobuf;
  32. option csharp_namespace = "Google.Protobuf.WellKnownTypes";
  33. option go_package = "github.com/golang/protobuf/ptypes/any";
  34. option java_package = "com.google.protobuf";
  35. option java_outer_classname = "AnyProto";
  36. option java_multiple_files = true;
  37. option objc_class_prefix = "GPB";
  38. option php_namespace = 'Hyperf\\Nacos\\Protobuf';
  39. option php_metadata_namespace = 'Hyperf\\Nacos\\Protobuf\\GPBMetadata';
  40. // `Any` contains an arbitrary serialized protocol buffer message along with a
  41. // URL that describes the type of the serialized message.
  42. //
  43. // Protobuf library provides support to pack/unpack Any values in the form
  44. // of utility functions or additional generated methods of the Any type.
  45. //
  46. // Example 1: Pack and unpack a message in C++.
  47. //
  48. // Foo foo = ...;
  49. // Any any;
  50. // any.PackFrom(foo);
  51. // ...
  52. // if (any.UnpackTo(&foo)) {
  53. // ...
  54. // }
  55. //
  56. // Example 2: Pack and unpack a message in Java.
  57. //
  58. // Foo foo = ...;
  59. // Any any = Any.pack(foo);
  60. // ...
  61. // if (any.is(Foo.class)) {
  62. // foo = any.unpack(Foo.class);
  63. // }
  64. //
  65. // Example 3: Pack and unpack a message in Python.
  66. //
  67. // foo = Foo(...)
  68. // any = Any()
  69. // any.Pack(foo)
  70. // ...
  71. // if any.Is(Foo.DESCRIPTOR):
  72. // any.Unpack(foo)
  73. // ...
  74. //
  75. // Example 4: Pack and unpack a message in Go
  76. //
  77. // foo := &pb.Foo{...}
  78. // any, err := ptypes.MarshalAny(foo)
  79. // ...
  80. // foo := &pb.Foo{}
  81. // if err := ptypes.UnmarshalAny(any, foo); err != nil {
  82. // ...
  83. // }
  84. //
  85. // The pack methods provided by protobuf library will by default use
  86. // 'type.googleapis.com/full.type.name' as the type URL and the unpack
  87. // methods only use the fully qualified type name after the last '/'
  88. // in the type URL, for example "foo.bar.com/x/y.z" will yield type
  89. // name "y.z".
  90. //
  91. //
  92. // JSON
  93. // ====
  94. // The JSON representation of an `Any` value uses the regular
  95. // representation of the deserialized, embedded message, with an
  96. // additional field `@type` which contains the type URL. Example:
  97. //
  98. // package google.profile;
  99. // message Person {
  100. // string first_name = 1;
  101. // string last_name = 2;
  102. // }
  103. //
  104. // {
  105. // "@type": "type.googleapis.com/google.profile.Person",
  106. // "firstName": <string>,
  107. // "lastName": <string>
  108. // }
  109. //
  110. // If the embedded message type is well-known and has a custom JSON
  111. // representation, that representation will be embedded adding a field
  112. // `value` which holds the custom JSON in addition to the `@type`
  113. // field. Example (for message [google.protobuf.Duration][]):
  114. //
  115. // {
  116. // "@type": "type.googleapis.com/google.protobuf.Duration",
  117. // "value": "1.212s"
  118. // }
  119. //
  120. message Any {
  121. // A URL/resource name that uniquely identifies the type of the serialized
  122. // protocol buffer message. This string must contain at least
  123. // one "/" character. The last segment of the URL's path must represent
  124. // the fully qualified name of the type (as in
  125. // `path/google.protobuf.Duration`). The name should be in a canonical form
  126. // (e.g., leading "." is not accepted).
  127. //
  128. // In practice, teams usually precompile into the binary all types that they
  129. // expect it to use in the context of Any. However, for URLs which use the
  130. // scheme `http`, `https`, or no scheme, one can optionally set up a type
  131. // server that maps type URLs to message definitions as follows:
  132. //
  133. // * If no scheme is provided, `https` is assumed.
  134. // * An HTTP GET on the URL must yield a [google.protobuf.Type][]
  135. // value in binary format, or produce an error.
  136. // * Applications are allowed to cache lookup results based on the
  137. // URL, or have them precompiled into a binary to avoid any
  138. // lookup. Therefore, binary compatibility needs to be preserved
  139. // on changes to types. (Use versioned type names to manage
  140. // breaking changes.)
  141. //
  142. // Note: this functionality is not currently available in the official
  143. // protobuf release, and it is not used for type URLs beginning with
  144. // type.googleapis.com.
  145. //
  146. // Schemes other than `http`, `https` (or the empty scheme) might be
  147. // used with implementation specific semantics.
  148. //
  149. string type_url = 1;
  150. // Must be a valid serialized protocol buffer of the above specified type.
  151. bytes value = 2;
  152. }