GPBAny.pbobjc.h 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185
  1. // Generated by the protocol buffer compiler. DO NOT EDIT!
  2. // NO CHECKED-IN PROTOBUF GENCODE
  3. // clang-format off
  4. // source: google/protobuf/any.proto
  5. #import "GPBDescriptor.h"
  6. #import "GPBMessage.h"
  7. #import "GPBRootObject.h"
  8. #if GOOGLE_PROTOBUF_OBJC_VERSION < 30007
  9. #error This file was generated by a newer version of protoc which is incompatible with your Protocol Buffer library sources.
  10. #endif
  11. #if 30007 < GOOGLE_PROTOBUF_OBJC_MIN_SUPPORTED_VERSION
  12. #error This file was generated by an older version of protoc which is incompatible with your Protocol Buffer library sources.
  13. #endif
  14. // @@protoc_insertion_point(imports)
  15. #pragma clang diagnostic push
  16. #pragma clang diagnostic ignored "-Wdeprecated-declarations"
  17. CF_EXTERN_C_BEGIN
  18. NS_ASSUME_NONNULL_BEGIN
  19. #pragma mark - GPBAnyRoot
  20. /**
  21. * Exposes the extension registry for this file.
  22. *
  23. * The base class provides:
  24. * @code
  25. * + (GPBExtensionRegistry *)extensionRegistry;
  26. * @endcode
  27. * which is a @c GPBExtensionRegistry that includes all the extensions defined by
  28. * this file and all files that it depends on.
  29. **/
  30. GPB_FINAL @interface GPBAnyRoot : GPBRootObject
  31. @end
  32. #pragma mark - GPBAny
  33. typedef GPB_ENUM(GPBAny_FieldNumber) {
  34. GPBAny_FieldNumber_TypeURL = 1,
  35. GPBAny_FieldNumber_Value = 2,
  36. };
  37. /**
  38. * `Any` contains an arbitrary serialized protocol buffer message along with a
  39. * URL that describes the type of the serialized message.
  40. *
  41. * Protobuf library provides support to pack/unpack Any values in the form
  42. * of utility functions or additional generated methods of the Any type.
  43. *
  44. * Example 1: Pack and unpack a message in C++.
  45. *
  46. * Foo foo = ...;
  47. * Any any;
  48. * any.PackFrom(foo);
  49. * ...
  50. * if (any.UnpackTo(&foo)) {
  51. * ...
  52. * }
  53. *
  54. * Example 2: Pack and unpack a message in Java.
  55. *
  56. * Foo foo = ...;
  57. * Any any = Any.pack(foo);
  58. * ...
  59. * if (any.is(Foo.class)) {
  60. * foo = any.unpack(Foo.class);
  61. * }
  62. * // or ...
  63. * if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  64. * foo = any.unpack(Foo.getDefaultInstance());
  65. * }
  66. *
  67. * Example 3: Pack and unpack a message in Python.
  68. *
  69. * foo = Foo(...)
  70. * any = Any()
  71. * any.Pack(foo)
  72. * ...
  73. * if any.Is(Foo.DESCRIPTOR):
  74. * any.Unpack(foo)
  75. * ...
  76. *
  77. * Example 4: Pack and unpack a message in Go
  78. *
  79. * foo := &pb.Foo{...}
  80. * any, err := anypb.New(foo)
  81. * if err != nil {
  82. * ...
  83. * }
  84. * ...
  85. * foo := &pb.Foo{}
  86. * if err := any.UnmarshalTo(foo); err != nil {
  87. * ...
  88. * }
  89. *
  90. * The pack methods provided by protobuf library will by default use
  91. * 'type.googleapis.com/full.type.name' as the type URL and the unpack
  92. * methods only use the fully qualified type name after the last '/'
  93. * in the type URL, for example "foo.bar.com/x/y.z" will yield type
  94. * name "y.z".
  95. *
  96. * JSON
  97. * ====
  98. * The JSON representation of an `Any` value uses the regular
  99. * representation of the deserialized, embedded message, with an
  100. * additional field `\@type` which contains the type URL. Example:
  101. *
  102. * package google.profile;
  103. * message Person {
  104. * string first_name = 1;
  105. * string last_name = 2;
  106. * }
  107. *
  108. * {
  109. * "\@type": "type.googleapis.com/google.profile.Person",
  110. * "firstName": <string>,
  111. * "lastName": <string>
  112. * }
  113. *
  114. * If the embedded message type is well-known and has a custom JSON
  115. * representation, that representation will be embedded adding a field
  116. * `value` which holds the custom JSON in addition to the `\@type`
  117. * field. Example (for message [google.protobuf.Duration][]):
  118. *
  119. * {
  120. * "\@type": "type.googleapis.com/google.protobuf.Duration",
  121. * "value": "1.212s"
  122. * }
  123. **/
  124. GPB_FINAL @interface GPBAny : GPBMessage
  125. /**
  126. * A URL/resource name that uniquely identifies the type of the serialized
  127. * protocol buffer message. This string must contain at least
  128. * one "/" character. The last segment of the URL's path must represent
  129. * the fully qualified name of the type (as in
  130. * `path/google.protobuf.Duration`). The name should be in a canonical form
  131. * (e.g., leading "." is not accepted).
  132. *
  133. * In practice, teams usually precompile into the binary all types that they
  134. * expect it to use in the context of Any. However, for URLs which use the
  135. * scheme `http`, `https`, or no scheme, one can optionally set up a type
  136. * server that maps type URLs to message definitions as follows:
  137. *
  138. * * If no scheme is provided, `https` is assumed.
  139. * * An HTTP GET on the URL must yield a [google.protobuf.Type][]
  140. * value in binary format, or produce an error.
  141. * * Applications are allowed to cache lookup results based on the
  142. * URL, or have them precompiled into a binary to avoid any
  143. * lookup. Therefore, binary compatibility needs to be preserved
  144. * on changes to types. (Use versioned type names to manage
  145. * breaking changes.)
  146. *
  147. * Note: this functionality is not currently available in the official
  148. * protobuf release, and it is not used for type URLs beginning with
  149. * type.googleapis.com. As of May 2023, there are no widely used type server
  150. * implementations and no plans to implement one.
  151. *
  152. * Schemes other than `http`, `https` (or the empty scheme) might be
  153. * used with implementation specific semantics.
  154. **/
  155. @property(nonatomic, readwrite, copy, null_resettable) NSString *typeURL;
  156. /** Must be a valid serialized protocol buffer of the above specified type. */
  157. @property(nonatomic, readwrite, copy, null_resettable) NSData *value;
  158. // NOTE: There are some Objective-C specific methods/properties in
  159. // GPBWellKnownTypes.h that will likely be useful.
  160. @end
  161. NS_ASSUME_NONNULL_END
  162. CF_EXTERN_C_END
  163. #pragma clang diagnostic pop
  164. // @@protoc_insertion_point(global_scope)
  165. // clang-format on