OLD | NEW |
1 // Generated by the protocol buffer compiler. DO NOT EDIT! | 1 // Generated by the protocol buffer compiler. DO NOT EDIT! |
2 // source: google/protobuf/api.proto | 2 // source: google/protobuf/api.proto |
3 | 3 |
4 #import "GPBProtocolBuffers.h" | 4 // This CPP symbol can be defined to use imports that match up to the framework |
| 5 // imports needed when using CocoaPods. |
| 6 #if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS) |
| 7 #define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0 |
| 8 #endif |
5 | 9 |
6 #if GOOGLE_PROTOBUF_OBJC_GEN_VERSION != 30001 | 10 #if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS |
7 #error This file was generated by a different version of protoc which is incompa
tible with your Protocol Buffer library sources. | 11 #import <Protobuf/GPBProtocolBuffers.h> |
| 12 #else |
| 13 #import "GPBProtocolBuffers.h" |
| 14 #endif |
| 15 |
| 16 #if GOOGLE_PROTOBUF_OBJC_VERSION < 30002 |
| 17 #error This file was generated by a newer version of protoc which is incompatibl
e with your Protocol Buffer library sources. |
| 18 #endif |
| 19 #if 30002 < GOOGLE_PROTOBUF_OBJC_MIN_SUPPORTED_VERSION |
| 20 #error This file was generated by an older version of protoc which is incompatib
le with your Protocol Buffer library sources. |
8 #endif | 21 #endif |
9 | 22 |
10 // @@protoc_insertion_point(imports) | 23 // @@protoc_insertion_point(imports) |
11 | 24 |
12 #pragma clang diagnostic push | 25 #pragma clang diagnostic push |
13 #pragma clang diagnostic ignored "-Wdeprecated-declarations" | 26 #pragma clang diagnostic ignored "-Wdeprecated-declarations" |
14 | 27 |
15 CF_EXTERN_C_BEGIN | 28 CF_EXTERN_C_BEGIN |
16 | 29 |
17 @class GPBMethod; | 30 @class GPBMethod; |
18 @class GPBMixin; | 31 @class GPBMixin; |
19 @class GPBOption; | 32 @class GPBOption; |
20 @class GPBSourceContext; | 33 @class GPBSourceContext; |
21 GPB_ENUM_FWD_DECLARE(GPBSyntax); | 34 GPB_ENUM_FWD_DECLARE(GPBSyntax); |
22 | 35 |
23 NS_ASSUME_NONNULL_BEGIN | 36 NS_ASSUME_NONNULL_BEGIN |
24 | 37 |
25 #pragma mark - GPBApiRoot | 38 #pragma mark - GPBApiRoot |
26 | 39 |
27 /// Exposes the extension registry for this file. | 40 /** |
28 /// | 41 * Exposes the extension registry for this file. |
29 /// The base class provides: | 42 * |
30 /// @code | 43 * The base class provides: |
31 /// + (GPBExtensionRegistry *)extensionRegistry; | 44 * @code |
32 /// @endcode | 45 * + (GPBExtensionRegistry *)extensionRegistry; |
33 /// which is a @c GPBExtensionRegistry that includes all the extensions defined
by | 46 * @endcode |
34 /// this file and all files that it depends on. | 47 * which is a @c GPBExtensionRegistry that includes all the extensions defined b
y |
| 48 * this file and all files that it depends on. |
| 49 **/ |
35 @interface GPBApiRoot : GPBRootObject | 50 @interface GPBApiRoot : GPBRootObject |
36 @end | 51 @end |
37 | 52 |
38 #pragma mark - GPBApi | 53 #pragma mark - GPBApi |
39 | 54 |
40 typedef GPB_ENUM(GPBApi_FieldNumber) { | 55 typedef GPB_ENUM(GPBApi_FieldNumber) { |
41 GPBApi_FieldNumber_Name = 1, | 56 GPBApi_FieldNumber_Name = 1, |
42 GPBApi_FieldNumber_MethodsArray = 2, | 57 GPBApi_FieldNumber_MethodsArray = 2, |
43 GPBApi_FieldNumber_OptionsArray = 3, | 58 GPBApi_FieldNumber_OptionsArray = 3, |
44 GPBApi_FieldNumber_Version = 4, | 59 GPBApi_FieldNumber_Version = 4, |
45 GPBApi_FieldNumber_SourceContext = 5, | 60 GPBApi_FieldNumber_SourceContext = 5, |
46 GPBApi_FieldNumber_MixinsArray = 6, | 61 GPBApi_FieldNumber_MixinsArray = 6, |
47 GPBApi_FieldNumber_Syntax = 7, | 62 GPBApi_FieldNumber_Syntax = 7, |
48 }; | 63 }; |
49 | 64 |
50 /// Api is a light-weight descriptor for a protocol buffer service. | 65 /** |
| 66 * Api is a light-weight descriptor for a protocol buffer service. |
| 67 **/ |
51 @interface GPBApi : GPBMessage | 68 @interface GPBApi : GPBMessage |
52 | 69 |
53 /// The fully qualified name of this api, including package name | 70 /** |
54 /// followed by the api's simple name. | 71 * The fully qualified name of this api, including package name |
| 72 * followed by the api's simple name. |
| 73 **/ |
55 @property(nonatomic, readwrite, copy, null_resettable) NSString *name; | 74 @property(nonatomic, readwrite, copy, null_resettable) NSString *name; |
56 | 75 |
57 /// The methods of this api, in unspecified order. | 76 /** The methods of this api, in unspecified order. */ |
58 @property(nonatomic, readwrite, strong, null_resettable) NSMutableArray<GPBMetho
d*> *methodsArray; | 77 @property(nonatomic, readwrite, strong, null_resettable) NSMutableArray<GPBMetho
d*> *methodsArray; |
59 /// The number of items in @c methodsArray without causing the array to be creat
ed. | 78 /** The number of items in @c methodsArray without causing the array to be creat
ed. */ |
60 @property(nonatomic, readonly) NSUInteger methodsArray_Count; | 79 @property(nonatomic, readonly) NSUInteger methodsArray_Count; |
61 | 80 |
62 /// Any metadata attached to the API. | 81 /** Any metadata attached to the API. */ |
63 @property(nonatomic, readwrite, strong, null_resettable) NSMutableArray<GPBOptio
n*> *optionsArray; | 82 @property(nonatomic, readwrite, strong, null_resettable) NSMutableArray<GPBOptio
n*> *optionsArray; |
64 /// The number of items in @c optionsArray without causing the array to be creat
ed. | 83 /** The number of items in @c optionsArray without causing the array to be creat
ed. */ |
65 @property(nonatomic, readonly) NSUInteger optionsArray_Count; | 84 @property(nonatomic, readonly) NSUInteger optionsArray_Count; |
66 | 85 |
67 /// A version string for this api. If specified, must have the form | 86 /** |
68 /// `major-version.minor-version`, as in `1.10`. If the minor version | 87 * A version string for this api. If specified, must have the form |
69 /// is omitted, it defaults to zero. If the entire version field is | 88 * `major-version.minor-version`, as in `1.10`. If the minor version |
70 /// empty, the major version is derived from the package name, as | 89 * is omitted, it defaults to zero. If the entire version field is |
71 /// outlined below. If the field is not empty, the version in the | 90 * empty, the major version is derived from the package name, as |
72 /// package name will be verified to be consistent with what is | 91 * outlined below. If the field is not empty, the version in the |
73 /// provided here. | 92 * package name will be verified to be consistent with what is |
74 /// | 93 * provided here. |
75 /// The versioning schema uses [semantic | 94 * |
76 /// versioning](http://semver.org) where the major version number | 95 * The versioning schema uses [semantic |
77 /// indicates a breaking change and the minor version an additive, | 96 * versioning](http://semver.org) where the major version number |
78 /// non-breaking change. Both version numbers are signals to users | 97 * indicates a breaking change and the minor version an additive, |
79 /// what to expect from different versions, and should be carefully | 98 * non-breaking change. Both version numbers are signals to users |
80 /// chosen based on the product plan. | 99 * what to expect from different versions, and should be carefully |
81 /// | 100 * chosen based on the product plan. |
82 /// The major version is also reflected in the package name of the | 101 * |
83 /// API, which must end in `v<major-version>`, as in | 102 * The major version is also reflected in the package name of the |
84 /// `google.feature.v1`. For major versions 0 and 1, the suffix can | 103 * API, which must end in `v<major-version>`, as in |
85 /// be omitted. Zero major versions must only be used for | 104 * `google.feature.v1`. For major versions 0 and 1, the suffix can |
86 /// experimental, none-GA apis. | 105 * be omitted. Zero major versions must only be used for |
| 106 * experimental, none-GA apis. |
| 107 **/ |
87 @property(nonatomic, readwrite, copy, null_resettable) NSString *version; | 108 @property(nonatomic, readwrite, copy, null_resettable) NSString *version; |
88 | 109 |
89 /// Source context for the protocol buffer service represented by this | 110 /** |
90 /// message. | 111 * Source context for the protocol buffer service represented by this |
| 112 * message. |
| 113 **/ |
91 @property(nonatomic, readwrite, strong, null_resettable) GPBSourceContext *sourc
eContext; | 114 @property(nonatomic, readwrite, strong, null_resettable) GPBSourceContext *sourc
eContext; |
92 /// Test to see if @c sourceContext has been set. | 115 /** Test to see if @c sourceContext has been set. */ |
93 @property(nonatomic, readwrite) BOOL hasSourceContext; | 116 @property(nonatomic, readwrite) BOOL hasSourceContext; |
94 | 117 |
95 /// Included APIs. See [Mixin][]. | 118 /** Included APIs. See [Mixin][]. */ |
96 @property(nonatomic, readwrite, strong, null_resettable) NSMutableArray<GPBMixin
*> *mixinsArray; | 119 @property(nonatomic, readwrite, strong, null_resettable) NSMutableArray<GPBMixin
*> *mixinsArray; |
97 /// The number of items in @c mixinsArray without causing the array to be create
d. | 120 /** The number of items in @c mixinsArray without causing the array to be create
d. */ |
98 @property(nonatomic, readonly) NSUInteger mixinsArray_Count; | 121 @property(nonatomic, readonly) NSUInteger mixinsArray_Count; |
99 | 122 |
100 /// The source syntax of the service. | 123 /** The source syntax of the service. */ |
101 @property(nonatomic, readwrite) enum GPBSyntax syntax; | 124 @property(nonatomic, readwrite) enum GPBSyntax syntax; |
102 | 125 |
103 @end | 126 @end |
104 | 127 |
105 /// Fetches the raw value of a @c GPBApi's @c syntax property, even | 128 /** |
106 /// if the value was not defined by the enum at the time the code was generated. | 129 * Fetches the raw value of a @c GPBApi's @c syntax property, even |
| 130 * if the value was not defined by the enum at the time the code was generated. |
| 131 **/ |
107 int32_t GPBApi_Syntax_RawValue(GPBApi *message); | 132 int32_t GPBApi_Syntax_RawValue(GPBApi *message); |
108 /// Sets the raw value of an @c GPBApi's @c syntax property, allowing | 133 /** |
109 /// it to be set to a value that was not defined by the enum at the time the cod
e | 134 * Sets the raw value of an @c GPBApi's @c syntax property, allowing |
110 /// was generated. | 135 * it to be set to a value that was not defined by the enum at the time the code |
| 136 * was generated. |
| 137 **/ |
111 void SetGPBApi_Syntax_RawValue(GPBApi *message, int32_t value); | 138 void SetGPBApi_Syntax_RawValue(GPBApi *message, int32_t value); |
112 | 139 |
113 #pragma mark - GPBMethod | 140 #pragma mark - GPBMethod |
114 | 141 |
115 typedef GPB_ENUM(GPBMethod_FieldNumber) { | 142 typedef GPB_ENUM(GPBMethod_FieldNumber) { |
116 GPBMethod_FieldNumber_Name = 1, | 143 GPBMethod_FieldNumber_Name = 1, |
117 GPBMethod_FieldNumber_RequestTypeURL = 2, | 144 GPBMethod_FieldNumber_RequestTypeURL = 2, |
118 GPBMethod_FieldNumber_RequestStreaming = 3, | 145 GPBMethod_FieldNumber_RequestStreaming = 3, |
119 GPBMethod_FieldNumber_ResponseTypeURL = 4, | 146 GPBMethod_FieldNumber_ResponseTypeURL = 4, |
120 GPBMethod_FieldNumber_ResponseStreaming = 5, | 147 GPBMethod_FieldNumber_ResponseStreaming = 5, |
121 GPBMethod_FieldNumber_OptionsArray = 6, | 148 GPBMethod_FieldNumber_OptionsArray = 6, |
122 GPBMethod_FieldNumber_Syntax = 7, | 149 GPBMethod_FieldNumber_Syntax = 7, |
123 }; | 150 }; |
124 | 151 |
125 /// Method represents a method of an api. | 152 /** |
| 153 * Method represents a method of an api. |
| 154 **/ |
126 @interface GPBMethod : GPBMessage | 155 @interface GPBMethod : GPBMessage |
127 | 156 |
128 /// The simple name of this method. | 157 /** The simple name of this method. */ |
129 @property(nonatomic, readwrite, copy, null_resettable) NSString *name; | 158 @property(nonatomic, readwrite, copy, null_resettable) NSString *name; |
130 | 159 |
131 /// A URL of the input message type. | 160 /** A URL of the input message type. */ |
132 @property(nonatomic, readwrite, copy, null_resettable) NSString *requestTypeURL; | 161 @property(nonatomic, readwrite, copy, null_resettable) NSString *requestTypeURL; |
133 | 162 |
134 /// If true, the request is streamed. | 163 /** If true, the request is streamed. */ |
135 @property(nonatomic, readwrite) BOOL requestStreaming; | 164 @property(nonatomic, readwrite) BOOL requestStreaming; |
136 | 165 |
137 /// The URL of the output message type. | 166 /** The URL of the output message type. */ |
138 @property(nonatomic, readwrite, copy, null_resettable) NSString *responseTypeURL
; | 167 @property(nonatomic, readwrite, copy, null_resettable) NSString *responseTypeURL
; |
139 | 168 |
140 /// If true, the response is streamed. | 169 /** If true, the response is streamed. */ |
141 @property(nonatomic, readwrite) BOOL responseStreaming; | 170 @property(nonatomic, readwrite) BOOL responseStreaming; |
142 | 171 |
143 /// Any metadata attached to the method. | 172 /** Any metadata attached to the method. */ |
144 @property(nonatomic, readwrite, strong, null_resettable) NSMutableArray<GPBOptio
n*> *optionsArray; | 173 @property(nonatomic, readwrite, strong, null_resettable) NSMutableArray<GPBOptio
n*> *optionsArray; |
145 /// The number of items in @c optionsArray without causing the array to be creat
ed. | 174 /** The number of items in @c optionsArray without causing the array to be creat
ed. */ |
146 @property(nonatomic, readonly) NSUInteger optionsArray_Count; | 175 @property(nonatomic, readonly) NSUInteger optionsArray_Count; |
147 | 176 |
148 /// The source syntax of this method. | 177 /** The source syntax of this method. */ |
149 @property(nonatomic, readwrite) enum GPBSyntax syntax; | 178 @property(nonatomic, readwrite) enum GPBSyntax syntax; |
150 | 179 |
151 @end | 180 @end |
152 | 181 |
153 /// Fetches the raw value of a @c GPBMethod's @c syntax property, even | 182 /** |
154 /// if the value was not defined by the enum at the time the code was generated. | 183 * Fetches the raw value of a @c GPBMethod's @c syntax property, even |
| 184 * if the value was not defined by the enum at the time the code was generated. |
| 185 **/ |
155 int32_t GPBMethod_Syntax_RawValue(GPBMethod *message); | 186 int32_t GPBMethod_Syntax_RawValue(GPBMethod *message); |
156 /// Sets the raw value of an @c GPBMethod's @c syntax property, allowing | 187 /** |
157 /// it to be set to a value that was not defined by the enum at the time the cod
e | 188 * Sets the raw value of an @c GPBMethod's @c syntax property, allowing |
158 /// was generated. | 189 * it to be set to a value that was not defined by the enum at the time the code |
| 190 * was generated. |
| 191 **/ |
159 void SetGPBMethod_Syntax_RawValue(GPBMethod *message, int32_t value); | 192 void SetGPBMethod_Syntax_RawValue(GPBMethod *message, int32_t value); |
160 | 193 |
161 #pragma mark - GPBMixin | 194 #pragma mark - GPBMixin |
162 | 195 |
163 typedef GPB_ENUM(GPBMixin_FieldNumber) { | 196 typedef GPB_ENUM(GPBMixin_FieldNumber) { |
164 GPBMixin_FieldNumber_Name = 1, | 197 GPBMixin_FieldNumber_Name = 1, |
165 GPBMixin_FieldNumber_Root = 2, | 198 GPBMixin_FieldNumber_Root = 2, |
166 }; | 199 }; |
167 | 200 |
168 /// Declares an API to be included in this API. The including API must | 201 /** |
169 /// redeclare all the methods from the included API, but documentation | 202 * Declares an API to be included in this API. The including API must |
170 /// and options are inherited as follows: | 203 * redeclare all the methods from the included API, but documentation |
171 /// | 204 * and options are inherited as follows: |
172 /// - If after comment and whitespace stripping, the documentation | 205 * |
173 /// string of the redeclared method is empty, it will be inherited | 206 * - If after comment and whitespace stripping, the documentation |
174 /// from the original method. | 207 * string of the redeclared method is empty, it will be inherited |
175 /// | 208 * from the original method. |
176 /// - Each annotation belonging to the service config (http, | 209 * |
177 /// visibility) which is not set in the redeclared method will be | 210 * - Each annotation belonging to the service config (http, |
178 /// inherited. | 211 * visibility) which is not set in the redeclared method will be |
179 /// | 212 * inherited. |
180 /// - If an http annotation is inherited, the path pattern will be | 213 * |
181 /// modified as follows. Any version prefix will be replaced by the | 214 * - If an http annotation is inherited, the path pattern will be |
182 /// version of the including API plus the [root][] path if specified. | 215 * modified as follows. Any version prefix will be replaced by the |
183 /// | 216 * version of the including API plus the [root][] path if specified. |
184 /// Example of a simple mixin: | 217 * |
185 /// | 218 * Example of a simple mixin: |
186 /// package google.acl.v1; | 219 * |
187 /// service AccessControl { | 220 * package google.acl.v1; |
188 /// // Get the underlying ACL object. | 221 * service AccessControl { |
189 /// rpc GetAcl(GetAclRequest) returns (Acl) { | 222 * // Get the underlying ACL object. |
190 /// option (google.api.http).get = "/v1/{resource=**}:getAcl"; | 223 * rpc GetAcl(GetAclRequest) returns (Acl) { |
191 /// } | 224 * option (google.api.http).get = "/v1/{resource=**}:getAcl"; |
192 /// } | 225 * } |
193 /// | 226 * } |
194 /// package google.storage.v2; | 227 * |
195 /// service Storage { | 228 * package google.storage.v2; |
196 /// rpc GetAcl(GetAclRequest) returns (Acl); | 229 * service Storage { |
197 /// | 230 * rpc GetAcl(GetAclRequest) returns (Acl); |
198 /// // Get a data record. | 231 * |
199 /// rpc GetData(GetDataRequest) returns (Data) { | 232 * // Get a data record. |
200 /// option (google.api.http).get = "/v2/{resource=**}"; | 233 * rpc GetData(GetDataRequest) returns (Data) { |
201 /// } | 234 * option (google.api.http).get = "/v2/{resource=**}"; |
202 /// } | 235 * } |
203 /// | 236 * } |
204 /// Example of a mixin configuration: | 237 * |
205 /// | 238 * Example of a mixin configuration: |
206 /// apis: | 239 * |
207 /// - name: google.storage.v2.Storage | 240 * apis: |
208 /// mixins: | 241 * - name: google.storage.v2.Storage |
209 /// - name: google.acl.v1.AccessControl | 242 * mixins: |
210 /// | 243 * - name: google.acl.v1.AccessControl |
211 /// The mixin construct implies that all methods in `AccessControl` are | 244 * |
212 /// also declared with same name and request/response types in | 245 * The mixin construct implies that all methods in `AccessControl` are |
213 /// `Storage`. A documentation generator or annotation processor will | 246 * also declared with same name and request/response types in |
214 /// see the effective `Storage.GetAcl` method after inherting | 247 * `Storage`. A documentation generator or annotation processor will |
215 /// documentation and annotations as follows: | 248 * see the effective `Storage.GetAcl` method after inherting |
216 /// | 249 * documentation and annotations as follows: |
217 /// service Storage { | 250 * |
218 /// // Get the underlying ACL object. | 251 * service Storage { |
219 /// rpc GetAcl(GetAclRequest) returns (Acl) { | 252 * // Get the underlying ACL object. |
220 /// option (google.api.http).get = "/v2/{resource=**}:getAcl"; | 253 * rpc GetAcl(GetAclRequest) returns (Acl) { |
221 /// } | 254 * option (google.api.http).get = "/v2/{resource=**}:getAcl"; |
222 /// ... | 255 * } |
223 /// } | 256 * ... |
224 /// | 257 * } |
225 /// Note how the version in the path pattern changed from `v1` to `v2`. | 258 * |
226 /// | 259 * Note how the version in the path pattern changed from `v1` to `v2`. |
227 /// If the `root` field in the mixin is specified, it should be a | 260 * |
228 /// relative path under which inherited HTTP paths are placed. Example: | 261 * If the `root` field in the mixin is specified, it should be a |
229 /// | 262 * relative path under which inherited HTTP paths are placed. Example: |
230 /// apis: | 263 * |
231 /// - name: google.storage.v2.Storage | 264 * apis: |
232 /// mixins: | 265 * - name: google.storage.v2.Storage |
233 /// - name: google.acl.v1.AccessControl | 266 * mixins: |
234 /// root: acls | 267 * - name: google.acl.v1.AccessControl |
235 /// | 268 * root: acls |
236 /// This implies the following inherited HTTP annotation: | 269 * |
237 /// | 270 * This implies the following inherited HTTP annotation: |
238 /// service Storage { | 271 * |
239 /// // Get the underlying ACL object. | 272 * service Storage { |
240 /// rpc GetAcl(GetAclRequest) returns (Acl) { | 273 * // Get the underlying ACL object. |
241 /// option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; | 274 * rpc GetAcl(GetAclRequest) returns (Acl) { |
242 /// } | 275 * option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; |
243 /// ... | 276 * } |
244 /// } | 277 * ... |
| 278 * } |
| 279 **/ |
245 @interface GPBMixin : GPBMessage | 280 @interface GPBMixin : GPBMessage |
246 | 281 |
247 /// The fully qualified name of the API which is included. | 282 /** The fully qualified name of the API which is included. */ |
248 @property(nonatomic, readwrite, copy, null_resettable) NSString *name; | 283 @property(nonatomic, readwrite, copy, null_resettable) NSString *name; |
249 | 284 |
250 /// If non-empty specifies a path under which inherited HTTP paths | 285 /** |
251 /// are rooted. | 286 * If non-empty specifies a path under which inherited HTTP paths |
| 287 * are rooted. |
| 288 **/ |
252 @property(nonatomic, readwrite, copy, null_resettable) NSString *root; | 289 @property(nonatomic, readwrite, copy, null_resettable) NSString *root; |
253 | 290 |
254 @end | 291 @end |
255 | 292 |
256 NS_ASSUME_NONNULL_END | 293 NS_ASSUME_NONNULL_END |
257 | 294 |
258 CF_EXTERN_C_END | 295 CF_EXTERN_C_END |
259 | 296 |
260 #pragma clang diagnostic pop | 297 #pragma clang diagnostic pop |
261 | 298 |
262 // @@protoc_insertion_point(global_scope) | 299 // @@protoc_insertion_point(global_scope) |
OLD | NEW |