@accrescent/console-client-sdk-angular 0.7.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/fesm2022/accrescent-console-client-sdk-angular-accrescent-console-v1alpha1.mjs +1880 -0
- package/fesm2022/accrescent-console-client-sdk-angular-accrescent-console-v1alpha1.mjs.map +1 -0
- package/fesm2022/accrescent-console-client-sdk-angular-buf-validate.mjs +364 -0
- package/fesm2022/accrescent-console-client-sdk-angular-buf-validate.mjs.map +1 -0
- package/fesm2022/accrescent-console-client-sdk-angular-google-api.mjs +584 -0
- package/fesm2022/accrescent-console-client-sdk-angular-google-api.mjs.map +1 -0
- package/fesm2022/accrescent-console-client-sdk-angular-google-longrunning.mjs +94 -0
- package/fesm2022/accrescent-console-client-sdk-angular-google-longrunning.mjs.map +1 -0
- package/fesm2022/accrescent-console-client-sdk-angular-google-rpc.mjs +32 -0
- package/fesm2022/accrescent-console-client-sdk-angular-google-rpc.mjs.map +1 -0
- package/fesm2022/accrescent-console-client-sdk-angular.mjs +3 -2282
- package/fesm2022/accrescent-console-client-sdk-angular.mjs.map +1 -1
- package/package.json +28 -10
- package/types/accrescent-console-client-sdk-angular-accrescent-console-v1alpha1.d.ts +3021 -0
- package/types/accrescent-console-client-sdk-angular-buf-validate.d.ts +4770 -0
- package/types/accrescent-console-client-sdk-angular-google-api.d.ts +1489 -0
- package/types/accrescent-console-client-sdk-angular-google-longrunning.d.ts +401 -0
- package/types/accrescent-console-client-sdk-angular-google-rpc.d.ts +52 -0
- package/types/accrescent-console-client-sdk-angular.d.ts +1 -1985
- package/README.md +0 -185
|
@@ -0,0 +1,1489 @@
|
|
|
1
|
+
import { GenMessage, GenFile, GenExtension, GenEnum } from '@bufbuild/protobuf/codegenv2';
|
|
2
|
+
import { Message } from '@bufbuild/protobuf';
|
|
3
|
+
import { MethodOptions, Duration, ServiceOptions, FieldOptions } from '@bufbuild/protobuf/wkt';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Describes the file google/api/http.proto.
|
|
7
|
+
*/
|
|
8
|
+
declare const file_google_api_http: GenFile;
|
|
9
|
+
/**
|
|
10
|
+
* Defines the HTTP configuration for an API service. It contains a list of
|
|
11
|
+
* [HttpRule][google.api.HttpRule], each specifying the mapping of an RPC method
|
|
12
|
+
* to one or more HTTP REST API methods.
|
|
13
|
+
*
|
|
14
|
+
* @generated from message google.api.Http
|
|
15
|
+
*/
|
|
16
|
+
type Http = Message<"google.api.Http"> & {
|
|
17
|
+
/**
|
|
18
|
+
* A list of HTTP configuration rules that apply to individual API methods.
|
|
19
|
+
*
|
|
20
|
+
* **NOTE:** All service configuration rules follow "last one wins" order.
|
|
21
|
+
*
|
|
22
|
+
* @generated from field: repeated google.api.HttpRule rules = 1;
|
|
23
|
+
*/
|
|
24
|
+
rules: HttpRule[];
|
|
25
|
+
/**
|
|
26
|
+
* When set to true, URL path parameters will be fully URI-decoded except in
|
|
27
|
+
* cases of single segment matches in reserved expansion, where "%2F" will be
|
|
28
|
+
* left encoded.
|
|
29
|
+
*
|
|
30
|
+
* The default behavior is to not decode RFC 6570 reserved characters in multi
|
|
31
|
+
* segment matches.
|
|
32
|
+
*
|
|
33
|
+
* @generated from field: bool fully_decode_reserved_expansion = 2;
|
|
34
|
+
*/
|
|
35
|
+
fullyDecodeReservedExpansion: boolean;
|
|
36
|
+
};
|
|
37
|
+
/**
|
|
38
|
+
* Describes the message google.api.Http.
|
|
39
|
+
* Use `create(HttpSchema)` to create a new message.
|
|
40
|
+
*/
|
|
41
|
+
declare const HttpSchema: GenMessage<Http>;
|
|
42
|
+
/**
|
|
43
|
+
* gRPC Transcoding
|
|
44
|
+
*
|
|
45
|
+
* gRPC Transcoding is a feature for mapping between a gRPC method and one or
|
|
46
|
+
* more HTTP REST endpoints. It allows developers to build a single API service
|
|
47
|
+
* that supports both gRPC APIs and REST APIs. Many systems, including [Google
|
|
48
|
+
* APIs](https://github.com/googleapis/googleapis),
|
|
49
|
+
* [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC
|
|
50
|
+
* Gateway](https://github.com/grpc-ecosystem/grpc-gateway),
|
|
51
|
+
* and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature
|
|
52
|
+
* and use it for large scale production services.
|
|
53
|
+
*
|
|
54
|
+
* `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies
|
|
55
|
+
* how different portions of the gRPC request message are mapped to the URL
|
|
56
|
+
* path, URL query parameters, and HTTP request body. It also controls how the
|
|
57
|
+
* gRPC response message is mapped to the HTTP response body. `HttpRule` is
|
|
58
|
+
* typically specified as an `google.api.http` annotation on the gRPC method.
|
|
59
|
+
*
|
|
60
|
+
* Each mapping specifies a URL path template and an HTTP method. The path
|
|
61
|
+
* template may refer to one or more fields in the gRPC request message, as long
|
|
62
|
+
* as each field is a non-repeated field with a primitive (non-message) type.
|
|
63
|
+
* The path template controls how fields of the request message are mapped to
|
|
64
|
+
* the URL path.
|
|
65
|
+
*
|
|
66
|
+
* Example:
|
|
67
|
+
*
|
|
68
|
+
* service Messaging {
|
|
69
|
+
* rpc GetMessage(GetMessageRequest) returns (Message) {
|
|
70
|
+
* option (google.api.http) = {
|
|
71
|
+
* get: "/v1/{name=messages/*}"
|
|
72
|
+
* };
|
|
73
|
+
* }
|
|
74
|
+
* }
|
|
75
|
+
* message GetMessageRequest {
|
|
76
|
+
* string name = 1; // Mapped to URL path.
|
|
77
|
+
* }
|
|
78
|
+
* message Message {
|
|
79
|
+
* string text = 1; // The resource content.
|
|
80
|
+
* }
|
|
81
|
+
*
|
|
82
|
+
* This enables an HTTP REST to gRPC mapping as below:
|
|
83
|
+
*
|
|
84
|
+
* - HTTP: `GET /v1/messages/123456`
|
|
85
|
+
* - gRPC: `GetMessage(name: "messages/123456")`
|
|
86
|
+
*
|
|
87
|
+
* Any fields in the request message which are not bound by the path template
|
|
88
|
+
* automatically become HTTP query parameters if there is no HTTP request body.
|
|
89
|
+
* For example:
|
|
90
|
+
*
|
|
91
|
+
* service Messaging {
|
|
92
|
+
* rpc GetMessage(GetMessageRequest) returns (Message) {
|
|
93
|
+
* option (google.api.http) = {
|
|
94
|
+
* get:"/v1/messages/{message_id}"
|
|
95
|
+
* };
|
|
96
|
+
* }
|
|
97
|
+
* }
|
|
98
|
+
* message GetMessageRequest {
|
|
99
|
+
* message SubMessage {
|
|
100
|
+
* string subfield = 1;
|
|
101
|
+
* }
|
|
102
|
+
* string message_id = 1; // Mapped to URL path.
|
|
103
|
+
* int64 revision = 2; // Mapped to URL query parameter `revision`.
|
|
104
|
+
* SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`.
|
|
105
|
+
* }
|
|
106
|
+
*
|
|
107
|
+
* This enables a HTTP JSON to RPC mapping as below:
|
|
108
|
+
*
|
|
109
|
+
* - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo`
|
|
110
|
+
* - gRPC: `GetMessage(message_id: "123456" revision: 2 sub:
|
|
111
|
+
* SubMessage(subfield: "foo"))`
|
|
112
|
+
*
|
|
113
|
+
* Note that fields which are mapped to URL query parameters must have a
|
|
114
|
+
* primitive type or a repeated primitive type or a non-repeated message type.
|
|
115
|
+
* In the case of a repeated type, the parameter can be repeated in the URL
|
|
116
|
+
* as `...?param=A¶m=B`. In the case of a message type, each field of the
|
|
117
|
+
* message is mapped to a separate parameter, such as
|
|
118
|
+
* `...?foo.a=A&foo.b=B&foo.c=C`.
|
|
119
|
+
*
|
|
120
|
+
* For HTTP methods that allow a request body, the `body` field
|
|
121
|
+
* specifies the mapping. Consider a REST update method on the
|
|
122
|
+
* message resource collection:
|
|
123
|
+
*
|
|
124
|
+
* service Messaging {
|
|
125
|
+
* rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
|
|
126
|
+
* option (google.api.http) = {
|
|
127
|
+
* patch: "/v1/messages/{message_id}"
|
|
128
|
+
* body: "message"
|
|
129
|
+
* };
|
|
130
|
+
* }
|
|
131
|
+
* }
|
|
132
|
+
* message UpdateMessageRequest {
|
|
133
|
+
* string message_id = 1; // mapped to the URL
|
|
134
|
+
* Message message = 2; // mapped to the body
|
|
135
|
+
* }
|
|
136
|
+
*
|
|
137
|
+
* The following HTTP JSON to RPC mapping is enabled, where the
|
|
138
|
+
* representation of the JSON in the request body is determined by
|
|
139
|
+
* protos JSON encoding:
|
|
140
|
+
*
|
|
141
|
+
* - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }`
|
|
142
|
+
* - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })`
|
|
143
|
+
*
|
|
144
|
+
* The special name `*` can be used in the body mapping to define that
|
|
145
|
+
* every field not bound by the path template should be mapped to the
|
|
146
|
+
* request body. This enables the following alternative definition of
|
|
147
|
+
* the update method:
|
|
148
|
+
*
|
|
149
|
+
* service Messaging {
|
|
150
|
+
* rpc UpdateMessage(Message) returns (Message) {
|
|
151
|
+
* option (google.api.http) = {
|
|
152
|
+
* patch: "/v1/messages/{message_id}"
|
|
153
|
+
* body: "*"
|
|
154
|
+
* };
|
|
155
|
+
* }
|
|
156
|
+
* }
|
|
157
|
+
* message Message {
|
|
158
|
+
* string message_id = 1;
|
|
159
|
+
* string text = 2;
|
|
160
|
+
* }
|
|
161
|
+
*
|
|
162
|
+
*
|
|
163
|
+
* The following HTTP JSON to RPC mapping is enabled:
|
|
164
|
+
*
|
|
165
|
+
* - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }`
|
|
166
|
+
* - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")`
|
|
167
|
+
*
|
|
168
|
+
* Note that when using `*` in the body mapping, it is not possible to
|
|
169
|
+
* have HTTP parameters, as all fields not bound by the path end in
|
|
170
|
+
* the body. This makes this option more rarely used in practice when
|
|
171
|
+
* defining REST APIs. The common usage of `*` is in custom methods
|
|
172
|
+
* which don't use the URL at all for transferring data.
|
|
173
|
+
*
|
|
174
|
+
* It is possible to define multiple HTTP methods for one RPC by using
|
|
175
|
+
* the `additional_bindings` option. Example:
|
|
176
|
+
*
|
|
177
|
+
* service Messaging {
|
|
178
|
+
* rpc GetMessage(GetMessageRequest) returns (Message) {
|
|
179
|
+
* option (google.api.http) = {
|
|
180
|
+
* get: "/v1/messages/{message_id}"
|
|
181
|
+
* additional_bindings {
|
|
182
|
+
* get: "/v1/users/{user_id}/messages/{message_id}"
|
|
183
|
+
* }
|
|
184
|
+
* };
|
|
185
|
+
* }
|
|
186
|
+
* }
|
|
187
|
+
* message GetMessageRequest {
|
|
188
|
+
* string message_id = 1;
|
|
189
|
+
* string user_id = 2;
|
|
190
|
+
* }
|
|
191
|
+
*
|
|
192
|
+
* This enables the following two alternative HTTP JSON to RPC mappings:
|
|
193
|
+
*
|
|
194
|
+
* - HTTP: `GET /v1/messages/123456`
|
|
195
|
+
* - gRPC: `GetMessage(message_id: "123456")`
|
|
196
|
+
*
|
|
197
|
+
* - HTTP: `GET /v1/users/me/messages/123456`
|
|
198
|
+
* - gRPC: `GetMessage(user_id: "me" message_id: "123456")`
|
|
199
|
+
*
|
|
200
|
+
* Rules for HTTP mapping
|
|
201
|
+
*
|
|
202
|
+
* 1. Leaf request fields (recursive expansion nested messages in the request
|
|
203
|
+
* message) are classified into three categories:
|
|
204
|
+
* - Fields referred by the path template. They are passed via the URL path.
|
|
205
|
+
* - Fields referred by the [HttpRule.body][google.api.HttpRule.body]. They
|
|
206
|
+
* are passed via the HTTP
|
|
207
|
+
* request body.
|
|
208
|
+
* - All other fields are passed via the URL query parameters, and the
|
|
209
|
+
* parameter name is the field path in the request message. A repeated
|
|
210
|
+
* field can be represented as multiple query parameters under the same
|
|
211
|
+
* name.
|
|
212
|
+
* 2. If [HttpRule.body][google.api.HttpRule.body] is "*", there is no URL
|
|
213
|
+
* query parameter, all fields
|
|
214
|
+
* are passed via URL path and HTTP request body.
|
|
215
|
+
* 3. If [HttpRule.body][google.api.HttpRule.body] is omitted, there is no HTTP
|
|
216
|
+
* request body, all
|
|
217
|
+
* fields are passed via URL path and URL query parameters.
|
|
218
|
+
*
|
|
219
|
+
* Path template syntax
|
|
220
|
+
*
|
|
221
|
+
* Template = "/" Segments [ Verb ] ;
|
|
222
|
+
* Segments = Segment { "/" Segment } ;
|
|
223
|
+
* Segment = "*" | "**" | LITERAL | Variable ;
|
|
224
|
+
* Variable = "{" FieldPath [ "=" Segments ] "}" ;
|
|
225
|
+
* FieldPath = IDENT { "." IDENT } ;
|
|
226
|
+
* Verb = ":" LITERAL ;
|
|
227
|
+
*
|
|
228
|
+
* The syntax `*` matches a single URL path segment. The syntax `**` matches
|
|
229
|
+
* zero or more URL path segments, which must be the last part of the URL path
|
|
230
|
+
* except the `Verb`.
|
|
231
|
+
*
|
|
232
|
+
* The syntax `Variable` matches part of the URL path as specified by its
|
|
233
|
+
* template. A variable template must not contain other variables. If a variable
|
|
234
|
+
* matches a single path segment, its template may be omitted, e.g. `{var}`
|
|
235
|
+
* is equivalent to `{var=*}`.
|
|
236
|
+
*
|
|
237
|
+
* The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL`
|
|
238
|
+
* contains any reserved character, such characters should be percent-encoded
|
|
239
|
+
* before the matching.
|
|
240
|
+
*
|
|
241
|
+
* If a variable contains exactly one path segment, such as `"{var}"` or
|
|
242
|
+
* `"{var=*}"`, when such a variable is expanded into a URL path on the client
|
|
243
|
+
* side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The
|
|
244
|
+
* server side does the reverse decoding. Such variables show up in the
|
|
245
|
+
* [Discovery
|
|
246
|
+
* Document](https://developers.google.com/discovery/v1/reference/apis) as
|
|
247
|
+
* `{var}`.
|
|
248
|
+
*
|
|
249
|
+
* If a variable contains multiple path segments, such as `"{var=foo/*}"`
|
|
250
|
+
* or `"{var=**}"`, when such a variable is expanded into a URL path on the
|
|
251
|
+
* client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded.
|
|
252
|
+
* The server side does the reverse decoding, except "%2F" and "%2f" are left
|
|
253
|
+
* unchanged. Such variables show up in the
|
|
254
|
+
* [Discovery
|
|
255
|
+
* Document](https://developers.google.com/discovery/v1/reference/apis) as
|
|
256
|
+
* `{+var}`.
|
|
257
|
+
*
|
|
258
|
+
* Using gRPC API Service Configuration
|
|
259
|
+
*
|
|
260
|
+
* gRPC API Service Configuration (service config) is a configuration language
|
|
261
|
+
* for configuring a gRPC service to become a user-facing product. The
|
|
262
|
+
* service config is simply the YAML representation of the `google.api.Service`
|
|
263
|
+
* proto message.
|
|
264
|
+
*
|
|
265
|
+
* As an alternative to annotating your proto file, you can configure gRPC
|
|
266
|
+
* transcoding in your service config YAML files. You do this by specifying a
|
|
267
|
+
* `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same
|
|
268
|
+
* effect as the proto annotation. This can be particularly useful if you
|
|
269
|
+
* have a proto that is reused in multiple services. Note that any transcoding
|
|
270
|
+
* specified in the service config will override any matching transcoding
|
|
271
|
+
* configuration in the proto.
|
|
272
|
+
*
|
|
273
|
+
* The following example selects a gRPC method and applies an `HttpRule` to it:
|
|
274
|
+
*
|
|
275
|
+
* http:
|
|
276
|
+
* rules:
|
|
277
|
+
* - selector: example.v1.Messaging.GetMessage
|
|
278
|
+
* get: /v1/messages/{message_id}/{sub.subfield}
|
|
279
|
+
*
|
|
280
|
+
* Special notes
|
|
281
|
+
*
|
|
282
|
+
* When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the
|
|
283
|
+
* proto to JSON conversion must follow the [proto3
|
|
284
|
+
* specification](https://developers.google.com/protocol-buffers/docs/proto3#json).
|
|
285
|
+
*
|
|
286
|
+
* While the single segment variable follows the semantics of
|
|
287
|
+
* [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
|
|
288
|
+
* Expansion, the multi segment variable **does not** follow RFC 6570 Section
|
|
289
|
+
* 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion
|
|
290
|
+
* does not expand special characters like `?` and `#`, which would lead
|
|
291
|
+
* to invalid URLs. As the result, gRPC Transcoding uses a custom encoding
|
|
292
|
+
* for multi segment variables.
|
|
293
|
+
*
|
|
294
|
+
* The path variables **must not** refer to any repeated or mapped field,
|
|
295
|
+
* because client libraries are not capable of handling such variable expansion.
|
|
296
|
+
*
|
|
297
|
+
* The path variables **must not** capture the leading "/" character. The reason
|
|
298
|
+
* is that the most common use case "{var}" does not capture the leading "/"
|
|
299
|
+
* character. For consistency, all path variables must share the same behavior.
|
|
300
|
+
*
|
|
301
|
+
* Repeated message fields must not be mapped to URL query parameters, because
|
|
302
|
+
* no client library can support such complicated mapping.
|
|
303
|
+
*
|
|
304
|
+
* If an API needs to use a JSON array for request or response body, it can map
|
|
305
|
+
* the request or response body to a repeated field. However, some gRPC
|
|
306
|
+
* Transcoding implementations may not support this feature.
|
|
307
|
+
*
|
|
308
|
+
* @generated from message google.api.HttpRule
|
|
309
|
+
*/
|
|
310
|
+
type HttpRule = Message<"google.api.HttpRule"> & {
|
|
311
|
+
/**
|
|
312
|
+
* Selects a method to which this rule applies.
|
|
313
|
+
*
|
|
314
|
+
* Refer to [selector][google.api.DocumentationRule.selector] for syntax
|
|
315
|
+
* details.
|
|
316
|
+
*
|
|
317
|
+
* @generated from field: string selector = 1;
|
|
318
|
+
*/
|
|
319
|
+
selector: string;
|
|
320
|
+
/**
|
|
321
|
+
* Determines the URL pattern is matched by this rules. This pattern can be
|
|
322
|
+
* used with any of the {get|put|post|delete|patch} methods. A custom method
|
|
323
|
+
* can be defined using the 'custom' field.
|
|
324
|
+
*
|
|
325
|
+
* @generated from oneof google.api.HttpRule.pattern
|
|
326
|
+
*/
|
|
327
|
+
pattern: {
|
|
328
|
+
/**
|
|
329
|
+
* Maps to HTTP GET. Used for listing and getting information about
|
|
330
|
+
* resources.
|
|
331
|
+
*
|
|
332
|
+
* @generated from field: string get = 2;
|
|
333
|
+
*/
|
|
334
|
+
value: string;
|
|
335
|
+
case: "get";
|
|
336
|
+
} | {
|
|
337
|
+
/**
|
|
338
|
+
* Maps to HTTP PUT. Used for replacing a resource.
|
|
339
|
+
*
|
|
340
|
+
* @generated from field: string put = 3;
|
|
341
|
+
*/
|
|
342
|
+
value: string;
|
|
343
|
+
case: "put";
|
|
344
|
+
} | {
|
|
345
|
+
/**
|
|
346
|
+
* Maps to HTTP POST. Used for creating a resource or performing an action.
|
|
347
|
+
*
|
|
348
|
+
* @generated from field: string post = 4;
|
|
349
|
+
*/
|
|
350
|
+
value: string;
|
|
351
|
+
case: "post";
|
|
352
|
+
} | {
|
|
353
|
+
/**
|
|
354
|
+
* Maps to HTTP DELETE. Used for deleting a resource.
|
|
355
|
+
*
|
|
356
|
+
* @generated from field: string delete = 5;
|
|
357
|
+
*/
|
|
358
|
+
value: string;
|
|
359
|
+
case: "delete";
|
|
360
|
+
} | {
|
|
361
|
+
/**
|
|
362
|
+
* Maps to HTTP PATCH. Used for updating a resource.
|
|
363
|
+
*
|
|
364
|
+
* @generated from field: string patch = 6;
|
|
365
|
+
*/
|
|
366
|
+
value: string;
|
|
367
|
+
case: "patch";
|
|
368
|
+
} | {
|
|
369
|
+
/**
|
|
370
|
+
* The custom pattern is used for specifying an HTTP method that is not
|
|
371
|
+
* included in the `pattern` field, such as HEAD, or "*" to leave the
|
|
372
|
+
* HTTP method unspecified for this rule. The wild-card rule is useful
|
|
373
|
+
* for services that provide content to Web (HTML) clients.
|
|
374
|
+
*
|
|
375
|
+
* @generated from field: google.api.CustomHttpPattern custom = 8;
|
|
376
|
+
*/
|
|
377
|
+
value: CustomHttpPattern;
|
|
378
|
+
case: "custom";
|
|
379
|
+
} | {
|
|
380
|
+
case: undefined;
|
|
381
|
+
value?: undefined;
|
|
382
|
+
};
|
|
383
|
+
/**
|
|
384
|
+
* The name of the request field whose value is mapped to the HTTP request
|
|
385
|
+
* body, or `*` for mapping all request fields not captured by the path
|
|
386
|
+
* pattern to the HTTP body, or omitted for not having any HTTP request body.
|
|
387
|
+
*
|
|
388
|
+
* NOTE: the referred field must be present at the top-level of the request
|
|
389
|
+
* message type.
|
|
390
|
+
*
|
|
391
|
+
* @generated from field: string body = 7;
|
|
392
|
+
*/
|
|
393
|
+
body: string;
|
|
394
|
+
/**
|
|
395
|
+
* Optional. The name of the response field whose value is mapped to the HTTP
|
|
396
|
+
* response body. When omitted, the entire response message will be used
|
|
397
|
+
* as the HTTP response body.
|
|
398
|
+
*
|
|
399
|
+
* NOTE: The referred field must be present at the top-level of the response
|
|
400
|
+
* message type.
|
|
401
|
+
*
|
|
402
|
+
* @generated from field: string response_body = 12;
|
|
403
|
+
*/
|
|
404
|
+
responseBody: string;
|
|
405
|
+
/**
|
|
406
|
+
* Additional HTTP bindings for the selector. Nested bindings must
|
|
407
|
+
* not contain an `additional_bindings` field themselves (that is,
|
|
408
|
+
* the nesting may only be one level deep).
|
|
409
|
+
*
|
|
410
|
+
* @generated from field: repeated google.api.HttpRule additional_bindings = 11;
|
|
411
|
+
*/
|
|
412
|
+
additionalBindings: HttpRule[];
|
|
413
|
+
};
|
|
414
|
+
/**
|
|
415
|
+
* Describes the message google.api.HttpRule.
|
|
416
|
+
* Use `create(HttpRuleSchema)` to create a new message.
|
|
417
|
+
*/
|
|
418
|
+
declare const HttpRuleSchema: GenMessage<HttpRule>;
|
|
419
|
+
/**
|
|
420
|
+
* A custom pattern is used for defining custom HTTP verb.
|
|
421
|
+
*
|
|
422
|
+
* @generated from message google.api.CustomHttpPattern
|
|
423
|
+
*/
|
|
424
|
+
type CustomHttpPattern = Message<"google.api.CustomHttpPattern"> & {
|
|
425
|
+
/**
|
|
426
|
+
* The name of this custom HTTP verb.
|
|
427
|
+
*
|
|
428
|
+
* @generated from field: string kind = 1;
|
|
429
|
+
*/
|
|
430
|
+
kind: string;
|
|
431
|
+
/**
|
|
432
|
+
* The path matched by this custom verb.
|
|
433
|
+
*
|
|
434
|
+
* @generated from field: string path = 2;
|
|
435
|
+
*/
|
|
436
|
+
path: string;
|
|
437
|
+
};
|
|
438
|
+
/**
|
|
439
|
+
* Describes the message google.api.CustomHttpPattern.
|
|
440
|
+
* Use `create(CustomHttpPatternSchema)` to create a new message.
|
|
441
|
+
*/
|
|
442
|
+
declare const CustomHttpPatternSchema: GenMessage<CustomHttpPattern>;
|
|
443
|
+
|
|
444
|
+
/**
|
|
445
|
+
* Describes the file google/api/annotations.proto.
|
|
446
|
+
*/
|
|
447
|
+
declare const file_google_api_annotations: GenFile;
|
|
448
|
+
/**
|
|
449
|
+
* See `HttpRule`.
|
|
450
|
+
*
|
|
451
|
+
* @generated from extension: google.api.HttpRule http = 72295728;
|
|
452
|
+
*/
|
|
453
|
+
declare const http: GenExtension<MethodOptions, HttpRule>;
|
|
454
|
+
|
|
455
|
+
/**
|
|
456
|
+
* Describes the file google/api/launch_stage.proto.
|
|
457
|
+
*/
|
|
458
|
+
declare const file_google_api_launch_stage: GenFile;
|
|
459
|
+
/**
|
|
460
|
+
* The launch stage as defined by [Google Cloud Platform
|
|
461
|
+
* Launch Stages](https://cloud.google.com/terms/launch-stages).
|
|
462
|
+
*
|
|
463
|
+
* @generated from enum google.api.LaunchStage
|
|
464
|
+
*/
|
|
465
|
+
declare enum LaunchStage {
|
|
466
|
+
/**
|
|
467
|
+
* Do not use this default value.
|
|
468
|
+
*
|
|
469
|
+
* @generated from enum value: LAUNCH_STAGE_UNSPECIFIED = 0;
|
|
470
|
+
*/
|
|
471
|
+
LAUNCH_STAGE_UNSPECIFIED = 0,
|
|
472
|
+
/**
|
|
473
|
+
* The feature is not yet implemented. Users can not use it.
|
|
474
|
+
*
|
|
475
|
+
* @generated from enum value: UNIMPLEMENTED = 6;
|
|
476
|
+
*/
|
|
477
|
+
UNIMPLEMENTED = 6,
|
|
478
|
+
/**
|
|
479
|
+
* Prelaunch features are hidden from users and are only visible internally.
|
|
480
|
+
*
|
|
481
|
+
* @generated from enum value: PRELAUNCH = 7;
|
|
482
|
+
*/
|
|
483
|
+
PRELAUNCH = 7,
|
|
484
|
+
/**
|
|
485
|
+
* Early Access features are limited to a closed group of testers. To use
|
|
486
|
+
* these features, you must sign up in advance and sign a Trusted Tester
|
|
487
|
+
* agreement (which includes confidentiality provisions). These features may
|
|
488
|
+
* be unstable, changed in backward-incompatible ways, and are not
|
|
489
|
+
* guaranteed to be released.
|
|
490
|
+
*
|
|
491
|
+
* @generated from enum value: EARLY_ACCESS = 1;
|
|
492
|
+
*/
|
|
493
|
+
EARLY_ACCESS = 1,
|
|
494
|
+
/**
|
|
495
|
+
* Alpha is a limited availability test for releases before they are cleared
|
|
496
|
+
* for widespread use. By Alpha, all significant design issues are resolved
|
|
497
|
+
* and we are in the process of verifying functionality. Alpha customers
|
|
498
|
+
* need to apply for access, agree to applicable terms, and have their
|
|
499
|
+
* projects allowlisted. Alpha releases don't have to be feature complete,
|
|
500
|
+
* no SLAs are provided, and there are no technical support obligations, but
|
|
501
|
+
* they will be far enough along that customers can actually use them in
|
|
502
|
+
* test environments or for limited-use tests -- just like they would in
|
|
503
|
+
* normal production cases.
|
|
504
|
+
*
|
|
505
|
+
* @generated from enum value: ALPHA = 2;
|
|
506
|
+
*/
|
|
507
|
+
ALPHA = 2,
|
|
508
|
+
/**
|
|
509
|
+
* Beta is the point at which we are ready to open a release for any
|
|
510
|
+
* customer to use. There are no SLA or technical support obligations in a
|
|
511
|
+
* Beta release. Products will be complete from a feature perspective, but
|
|
512
|
+
* may have some open outstanding issues. Beta releases are suitable for
|
|
513
|
+
* limited production use cases.
|
|
514
|
+
*
|
|
515
|
+
* @generated from enum value: BETA = 3;
|
|
516
|
+
*/
|
|
517
|
+
BETA = 3,
|
|
518
|
+
/**
|
|
519
|
+
* GA features are open to all developers and are considered stable and
|
|
520
|
+
* fully qualified for production use.
|
|
521
|
+
*
|
|
522
|
+
* @generated from enum value: GA = 4;
|
|
523
|
+
*/
|
|
524
|
+
GA = 4,
|
|
525
|
+
/**
|
|
526
|
+
* Deprecated features are scheduled to be shut down and removed. For more
|
|
527
|
+
* information, see the "Deprecation Policy" section of our [Terms of
|
|
528
|
+
* Service](https://cloud.google.com/terms/)
|
|
529
|
+
* and the [Google Cloud Platform Subject to the Deprecation
|
|
530
|
+
* Policy](https://cloud.google.com/terms/deprecation) documentation.
|
|
531
|
+
*
|
|
532
|
+
* @generated from enum value: DEPRECATED = 5;
|
|
533
|
+
*/
|
|
534
|
+
DEPRECATED = 5
|
|
535
|
+
}
|
|
536
|
+
/**
|
|
537
|
+
* Describes the enum google.api.LaunchStage.
|
|
538
|
+
*/
|
|
539
|
+
declare const LaunchStageSchema: GenEnum<LaunchStage>;
|
|
540
|
+
|
|
541
|
+
/**
|
|
542
|
+
* Describes the file google/api/client.proto.
|
|
543
|
+
*/
|
|
544
|
+
declare const file_google_api_client: GenFile;
|
|
545
|
+
/**
|
|
546
|
+
* Required information for every language.
|
|
547
|
+
*
|
|
548
|
+
* @generated from message google.api.CommonLanguageSettings
|
|
549
|
+
*/
|
|
550
|
+
type CommonLanguageSettings = Message<"google.api.CommonLanguageSettings"> & {
|
|
551
|
+
/**
|
|
552
|
+
* Link to automatically generated reference documentation. Example:
|
|
553
|
+
* https://cloud.google.com/nodejs/docs/reference/asset/latest
|
|
554
|
+
*
|
|
555
|
+
* @generated from field: string reference_docs_uri = 1 [deprecated = true];
|
|
556
|
+
* @deprecated
|
|
557
|
+
*/
|
|
558
|
+
referenceDocsUri: string;
|
|
559
|
+
/**
|
|
560
|
+
* The destination where API teams want this client library to be published.
|
|
561
|
+
*
|
|
562
|
+
* @generated from field: repeated google.api.ClientLibraryDestination destinations = 2;
|
|
563
|
+
*/
|
|
564
|
+
destinations: ClientLibraryDestination[];
|
|
565
|
+
/**
|
|
566
|
+
* Configuration for which RPCs should be generated in the GAPIC client.
|
|
567
|
+
*
|
|
568
|
+
* @generated from field: google.api.SelectiveGapicGeneration selective_gapic_generation = 3;
|
|
569
|
+
*/
|
|
570
|
+
selectiveGapicGeneration?: SelectiveGapicGeneration;
|
|
571
|
+
};
|
|
572
|
+
/**
|
|
573
|
+
* Describes the message google.api.CommonLanguageSettings.
|
|
574
|
+
* Use `create(CommonLanguageSettingsSchema)` to create a new message.
|
|
575
|
+
*/
|
|
576
|
+
declare const CommonLanguageSettingsSchema: GenMessage<CommonLanguageSettings>;
|
|
577
|
+
/**
|
|
578
|
+
* Details about how and where to publish client libraries.
|
|
579
|
+
*
|
|
580
|
+
* @generated from message google.api.ClientLibrarySettings
|
|
581
|
+
*/
|
|
582
|
+
type ClientLibrarySettings = Message<"google.api.ClientLibrarySettings"> & {
|
|
583
|
+
/**
|
|
584
|
+
* Version of the API to apply these settings to. This is the full protobuf
|
|
585
|
+
* package for the API, ending in the version element.
|
|
586
|
+
* Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
|
|
587
|
+
*
|
|
588
|
+
* @generated from field: string version = 1;
|
|
589
|
+
*/
|
|
590
|
+
version: string;
|
|
591
|
+
/**
|
|
592
|
+
* Launch stage of this version of the API.
|
|
593
|
+
*
|
|
594
|
+
* @generated from field: google.api.LaunchStage launch_stage = 2;
|
|
595
|
+
*/
|
|
596
|
+
launchStage: LaunchStage;
|
|
597
|
+
/**
|
|
598
|
+
* When using transport=rest, the client request will encode enums as
|
|
599
|
+
* numbers rather than strings.
|
|
600
|
+
*
|
|
601
|
+
* @generated from field: bool rest_numeric_enums = 3;
|
|
602
|
+
*/
|
|
603
|
+
restNumericEnums: boolean;
|
|
604
|
+
/**
|
|
605
|
+
* Settings for legacy Java features, supported in the Service YAML.
|
|
606
|
+
*
|
|
607
|
+
* @generated from field: google.api.JavaSettings java_settings = 21;
|
|
608
|
+
*/
|
|
609
|
+
javaSettings?: JavaSettings;
|
|
610
|
+
/**
|
|
611
|
+
* Settings for C++ client libraries.
|
|
612
|
+
*
|
|
613
|
+
* @generated from field: google.api.CppSettings cpp_settings = 22;
|
|
614
|
+
*/
|
|
615
|
+
cppSettings?: CppSettings;
|
|
616
|
+
/**
|
|
617
|
+
* Settings for PHP client libraries.
|
|
618
|
+
*
|
|
619
|
+
* @generated from field: google.api.PhpSettings php_settings = 23;
|
|
620
|
+
*/
|
|
621
|
+
phpSettings?: PhpSettings;
|
|
622
|
+
/**
|
|
623
|
+
* Settings for Python client libraries.
|
|
624
|
+
*
|
|
625
|
+
* @generated from field: google.api.PythonSettings python_settings = 24;
|
|
626
|
+
*/
|
|
627
|
+
pythonSettings?: PythonSettings;
|
|
628
|
+
/**
|
|
629
|
+
* Settings for Node client libraries.
|
|
630
|
+
*
|
|
631
|
+
* @generated from field: google.api.NodeSettings node_settings = 25;
|
|
632
|
+
*/
|
|
633
|
+
nodeSettings?: NodeSettings;
|
|
634
|
+
/**
|
|
635
|
+
* Settings for .NET client libraries.
|
|
636
|
+
*
|
|
637
|
+
* @generated from field: google.api.DotnetSettings dotnet_settings = 26;
|
|
638
|
+
*/
|
|
639
|
+
dotnetSettings?: DotnetSettings;
|
|
640
|
+
/**
|
|
641
|
+
* Settings for Ruby client libraries.
|
|
642
|
+
*
|
|
643
|
+
* @generated from field: google.api.RubySettings ruby_settings = 27;
|
|
644
|
+
*/
|
|
645
|
+
rubySettings?: RubySettings;
|
|
646
|
+
/**
|
|
647
|
+
* Settings for Go client libraries.
|
|
648
|
+
*
|
|
649
|
+
* @generated from field: google.api.GoSettings go_settings = 28;
|
|
650
|
+
*/
|
|
651
|
+
goSettings?: GoSettings;
|
|
652
|
+
};
|
|
653
|
+
/**
|
|
654
|
+
* Describes the message google.api.ClientLibrarySettings.
|
|
655
|
+
* Use `create(ClientLibrarySettingsSchema)` to create a new message.
|
|
656
|
+
*/
|
|
657
|
+
declare const ClientLibrarySettingsSchema: GenMessage<ClientLibrarySettings>;
|
|
658
|
+
/**
|
|
659
|
+
* This message configures the settings for publishing [Google Cloud Client
|
|
660
|
+
* libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
|
|
661
|
+
* generated from the service config.
|
|
662
|
+
*
|
|
663
|
+
* @generated from message google.api.Publishing
|
|
664
|
+
*/
|
|
665
|
+
type Publishing = Message<"google.api.Publishing"> & {
|
|
666
|
+
/**
|
|
667
|
+
* A list of API method settings, e.g. the behavior for methods that use the
|
|
668
|
+
* long-running operation pattern.
|
|
669
|
+
*
|
|
670
|
+
* @generated from field: repeated google.api.MethodSettings method_settings = 2;
|
|
671
|
+
*/
|
|
672
|
+
methodSettings: MethodSettings[];
|
|
673
|
+
/**
|
|
674
|
+
* Link to a *public* URI where users can report issues. Example:
|
|
675
|
+
* https://issuetracker.google.com/issues/new?component=190865&template=1161103
|
|
676
|
+
*
|
|
677
|
+
* @generated from field: string new_issue_uri = 101;
|
|
678
|
+
*/
|
|
679
|
+
newIssueUri: string;
|
|
680
|
+
/**
|
|
681
|
+
* Link to product home page. Example:
|
|
682
|
+
* https://cloud.google.com/asset-inventory/docs/overview
|
|
683
|
+
*
|
|
684
|
+
* @generated from field: string documentation_uri = 102;
|
|
685
|
+
*/
|
|
686
|
+
documentationUri: string;
|
|
687
|
+
/**
|
|
688
|
+
* Used as a tracking tag when collecting data about the APIs developer
|
|
689
|
+
* relations artifacts like docs, packages delivered to package managers,
|
|
690
|
+
* etc. Example: "speech".
|
|
691
|
+
*
|
|
692
|
+
* @generated from field: string api_short_name = 103;
|
|
693
|
+
*/
|
|
694
|
+
apiShortName: string;
|
|
695
|
+
/**
|
|
696
|
+
* GitHub label to apply to issues and pull requests opened for this API.
|
|
697
|
+
*
|
|
698
|
+
* @generated from field: string github_label = 104;
|
|
699
|
+
*/
|
|
700
|
+
githubLabel: string;
|
|
701
|
+
/**
|
|
702
|
+
* GitHub teams to be added to CODEOWNERS in the directory in GitHub
|
|
703
|
+
* containing source code for the client libraries for this API.
|
|
704
|
+
*
|
|
705
|
+
* @generated from field: repeated string codeowner_github_teams = 105;
|
|
706
|
+
*/
|
|
707
|
+
codeownerGithubTeams: string[];
|
|
708
|
+
/**
|
|
709
|
+
* A prefix used in sample code when demarking regions to be included in
|
|
710
|
+
* documentation.
|
|
711
|
+
*
|
|
712
|
+
* @generated from field: string doc_tag_prefix = 106;
|
|
713
|
+
*/
|
|
714
|
+
docTagPrefix: string;
|
|
715
|
+
/**
|
|
716
|
+
* For whom the client library is being published.
|
|
717
|
+
*
|
|
718
|
+
* @generated from field: google.api.ClientLibraryOrganization organization = 107;
|
|
719
|
+
*/
|
|
720
|
+
organization: ClientLibraryOrganization;
|
|
721
|
+
/**
|
|
722
|
+
* Client library settings. If the same version string appears multiple
|
|
723
|
+
* times in this list, then the last one wins. Settings from earlier
|
|
724
|
+
* settings with the same version string are discarded.
|
|
725
|
+
*
|
|
726
|
+
* @generated from field: repeated google.api.ClientLibrarySettings library_settings = 109;
|
|
727
|
+
*/
|
|
728
|
+
librarySettings: ClientLibrarySettings[];
|
|
729
|
+
/**
|
|
730
|
+
* Optional link to proto reference documentation. Example:
|
|
731
|
+
* https://cloud.google.com/pubsub/lite/docs/reference/rpc
|
|
732
|
+
*
|
|
733
|
+
* @generated from field: string proto_reference_documentation_uri = 110;
|
|
734
|
+
*/
|
|
735
|
+
protoReferenceDocumentationUri: string;
|
|
736
|
+
/**
|
|
737
|
+
* Optional link to REST reference documentation. Example:
|
|
738
|
+
* https://cloud.google.com/pubsub/lite/docs/reference/rest
|
|
739
|
+
*
|
|
740
|
+
* @generated from field: string rest_reference_documentation_uri = 111;
|
|
741
|
+
*/
|
|
742
|
+
restReferenceDocumentationUri: string;
|
|
743
|
+
};
|
|
744
|
+
/**
|
|
745
|
+
* Describes the message google.api.Publishing.
|
|
746
|
+
* Use `create(PublishingSchema)` to create a new message.
|
|
747
|
+
*/
|
|
748
|
+
declare const PublishingSchema: GenMessage<Publishing>;
|
|
749
|
+
/**
|
|
750
|
+
* Settings for Java client libraries.
|
|
751
|
+
*
|
|
752
|
+
* @generated from message google.api.JavaSettings
|
|
753
|
+
*/
|
|
754
|
+
type JavaSettings = Message<"google.api.JavaSettings"> & {
|
|
755
|
+
/**
|
|
756
|
+
* The package name to use in Java. Clobbers the java_package option
|
|
757
|
+
* set in the protobuf. This should be used **only** by APIs
|
|
758
|
+
* who have already set the language_settings.java.package_name" field
|
|
759
|
+
* in gapic.yaml. API teams should use the protobuf java_package option
|
|
760
|
+
* where possible.
|
|
761
|
+
*
|
|
762
|
+
* Example of a YAML configuration::
|
|
763
|
+
*
|
|
764
|
+
* publishing:
|
|
765
|
+
* java_settings:
|
|
766
|
+
* library_package: com.google.cloud.pubsub.v1
|
|
767
|
+
*
|
|
768
|
+
* @generated from field: string library_package = 1;
|
|
769
|
+
*/
|
|
770
|
+
libraryPackage: string;
|
|
771
|
+
/**
|
|
772
|
+
* Configure the Java class name to use instead of the service's for its
|
|
773
|
+
* corresponding generated GAPIC client. Keys are fully-qualified
|
|
774
|
+
* service names as they appear in the protobuf (including the full
|
|
775
|
+
* the language_settings.java.interface_names" field in gapic.yaml. API
|
|
776
|
+
* teams should otherwise use the service name as it appears in the
|
|
777
|
+
* protobuf.
|
|
778
|
+
*
|
|
779
|
+
* Example of a YAML configuration::
|
|
780
|
+
*
|
|
781
|
+
* publishing:
|
|
782
|
+
* java_settings:
|
|
783
|
+
* service_class_names:
|
|
784
|
+
* - google.pubsub.v1.Publisher: TopicAdmin
|
|
785
|
+
* - google.pubsub.v1.Subscriber: SubscriptionAdmin
|
|
786
|
+
*
|
|
787
|
+
* @generated from field: map<string, string> service_class_names = 2;
|
|
788
|
+
*/
|
|
789
|
+
serviceClassNames: {
|
|
790
|
+
[key: string]: string;
|
|
791
|
+
};
|
|
792
|
+
/**
|
|
793
|
+
* Some settings.
|
|
794
|
+
*
|
|
795
|
+
* @generated from field: google.api.CommonLanguageSettings common = 3;
|
|
796
|
+
*/
|
|
797
|
+
common?: CommonLanguageSettings;
|
|
798
|
+
};
|
|
799
|
+
/**
|
|
800
|
+
* Describes the message google.api.JavaSettings.
|
|
801
|
+
* Use `create(JavaSettingsSchema)` to create a new message.
|
|
802
|
+
*/
|
|
803
|
+
declare const JavaSettingsSchema: GenMessage<JavaSettings>;
|
|
804
|
+
/**
|
|
805
|
+
* Settings for C++ client libraries.
|
|
806
|
+
*
|
|
807
|
+
* @generated from message google.api.CppSettings
|
|
808
|
+
*/
|
|
809
|
+
type CppSettings = Message<"google.api.CppSettings"> & {
|
|
810
|
+
/**
|
|
811
|
+
* Some settings.
|
|
812
|
+
*
|
|
813
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
814
|
+
*/
|
|
815
|
+
common?: CommonLanguageSettings;
|
|
816
|
+
};
|
|
817
|
+
/**
|
|
818
|
+
* Describes the message google.api.CppSettings.
|
|
819
|
+
* Use `create(CppSettingsSchema)` to create a new message.
|
|
820
|
+
*/
|
|
821
|
+
declare const CppSettingsSchema: GenMessage<CppSettings>;
|
|
822
|
+
/**
|
|
823
|
+
* Settings for Php client libraries.
|
|
824
|
+
*
|
|
825
|
+
* @generated from message google.api.PhpSettings
|
|
826
|
+
*/
|
|
827
|
+
type PhpSettings = Message<"google.api.PhpSettings"> & {
|
|
828
|
+
/**
|
|
829
|
+
* Some settings.
|
|
830
|
+
*
|
|
831
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
832
|
+
*/
|
|
833
|
+
common?: CommonLanguageSettings;
|
|
834
|
+
};
|
|
835
|
+
/**
|
|
836
|
+
* Describes the message google.api.PhpSettings.
|
|
837
|
+
* Use `create(PhpSettingsSchema)` to create a new message.
|
|
838
|
+
*/
|
|
839
|
+
declare const PhpSettingsSchema: GenMessage<PhpSettings>;
|
|
840
|
+
/**
|
|
841
|
+
* Settings for Python client libraries.
|
|
842
|
+
*
|
|
843
|
+
* @generated from message google.api.PythonSettings
|
|
844
|
+
*/
|
|
845
|
+
type PythonSettings = Message<"google.api.PythonSettings"> & {
|
|
846
|
+
/**
|
|
847
|
+
* Some settings.
|
|
848
|
+
*
|
|
849
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
850
|
+
*/
|
|
851
|
+
common?: CommonLanguageSettings;
|
|
852
|
+
/**
|
|
853
|
+
* Experimental features to be included during client library generation.
|
|
854
|
+
*
|
|
855
|
+
* @generated from field: google.api.PythonSettings.ExperimentalFeatures experimental_features = 2;
|
|
856
|
+
*/
|
|
857
|
+
experimentalFeatures?: PythonSettings_ExperimentalFeatures;
|
|
858
|
+
};
|
|
859
|
+
/**
|
|
860
|
+
* Describes the message google.api.PythonSettings.
|
|
861
|
+
* Use `create(PythonSettingsSchema)` to create a new message.
|
|
862
|
+
*/
|
|
863
|
+
declare const PythonSettingsSchema: GenMessage<PythonSettings>;
|
|
864
|
+
/**
|
|
865
|
+
* Experimental features to be included during client library generation.
|
|
866
|
+
* These fields will be deprecated once the feature graduates and is enabled
|
|
867
|
+
* by default.
|
|
868
|
+
*
|
|
869
|
+
* @generated from message google.api.PythonSettings.ExperimentalFeatures
|
|
870
|
+
*/
|
|
871
|
+
type PythonSettings_ExperimentalFeatures = Message<"google.api.PythonSettings.ExperimentalFeatures"> & {
|
|
872
|
+
/**
|
|
873
|
+
* Enables generation of asynchronous REST clients if `rest` transport is
|
|
874
|
+
* enabled. By default, asynchronous REST clients will not be generated.
|
|
875
|
+
* This feature will be enabled by default 1 month after launching the
|
|
876
|
+
* feature in preview packages.
|
|
877
|
+
*
|
|
878
|
+
* @generated from field: bool rest_async_io_enabled = 1;
|
|
879
|
+
*/
|
|
880
|
+
restAsyncIoEnabled: boolean;
|
|
881
|
+
/**
|
|
882
|
+
* Enables generation of protobuf code using new types that are more
|
|
883
|
+
* Pythonic which are included in `protobuf>=5.29.x`. This feature will be
|
|
884
|
+
* enabled by default 1 month after launching the feature in preview
|
|
885
|
+
* packages.
|
|
886
|
+
*
|
|
887
|
+
* @generated from field: bool protobuf_pythonic_types_enabled = 2;
|
|
888
|
+
*/
|
|
889
|
+
protobufPythonicTypesEnabled: boolean;
|
|
890
|
+
/**
|
|
891
|
+
* Disables generation of an unversioned Python package for this client
|
|
892
|
+
* library. This means that the module names will need to be versioned in
|
|
893
|
+
* import statements. For example `import google.cloud.library_v2` instead
|
|
894
|
+
* of `import google.cloud.library`.
|
|
895
|
+
*
|
|
896
|
+
* @generated from field: bool unversioned_package_disabled = 3;
|
|
897
|
+
*/
|
|
898
|
+
unversionedPackageDisabled: boolean;
|
|
899
|
+
};
|
|
900
|
+
/**
|
|
901
|
+
* Describes the message google.api.PythonSettings.ExperimentalFeatures.
|
|
902
|
+
* Use `create(PythonSettings_ExperimentalFeaturesSchema)` to create a new message.
|
|
903
|
+
*/
|
|
904
|
+
declare const PythonSettings_ExperimentalFeaturesSchema: GenMessage<PythonSettings_ExperimentalFeatures>;
|
|
905
|
+
/**
|
|
906
|
+
* Settings for Node client libraries.
|
|
907
|
+
*
|
|
908
|
+
* @generated from message google.api.NodeSettings
|
|
909
|
+
*/
|
|
910
|
+
type NodeSettings = Message<"google.api.NodeSettings"> & {
|
|
911
|
+
/**
|
|
912
|
+
* Some settings.
|
|
913
|
+
*
|
|
914
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
915
|
+
*/
|
|
916
|
+
common?: CommonLanguageSettings;
|
|
917
|
+
};
|
|
918
|
+
/**
|
|
919
|
+
* Describes the message google.api.NodeSettings.
|
|
920
|
+
* Use `create(NodeSettingsSchema)` to create a new message.
|
|
921
|
+
*/
|
|
922
|
+
declare const NodeSettingsSchema: GenMessage<NodeSettings>;
|
|
923
|
+
/**
|
|
924
|
+
* Settings for Dotnet client libraries.
|
|
925
|
+
*
|
|
926
|
+
* @generated from message google.api.DotnetSettings
|
|
927
|
+
*/
|
|
928
|
+
type DotnetSettings = Message<"google.api.DotnetSettings"> & {
|
|
929
|
+
/**
|
|
930
|
+
* Some settings.
|
|
931
|
+
*
|
|
932
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
933
|
+
*/
|
|
934
|
+
common?: CommonLanguageSettings;
|
|
935
|
+
/**
|
|
936
|
+
* Map from original service names to renamed versions.
|
|
937
|
+
* This is used when the default generated types
|
|
938
|
+
* would cause a naming conflict. (Neither name is
|
|
939
|
+
* fully-qualified.)
|
|
940
|
+
* Example: Subscriber to SubscriberServiceApi.
|
|
941
|
+
*
|
|
942
|
+
* @generated from field: map<string, string> renamed_services = 2;
|
|
943
|
+
*/
|
|
944
|
+
renamedServices: {
|
|
945
|
+
[key: string]: string;
|
|
946
|
+
};
|
|
947
|
+
/**
|
|
948
|
+
* Map from full resource types to the effective short name
|
|
949
|
+
* for the resource. This is used when otherwise resource
|
|
950
|
+
* named from different services would cause naming collisions.
|
|
951
|
+
* Example entry:
|
|
952
|
+
* "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
|
|
953
|
+
*
|
|
954
|
+
* @generated from field: map<string, string> renamed_resources = 3;
|
|
955
|
+
*/
|
|
956
|
+
renamedResources: {
|
|
957
|
+
[key: string]: string;
|
|
958
|
+
};
|
|
959
|
+
/**
|
|
960
|
+
* List of full resource types to ignore during generation.
|
|
961
|
+
* This is typically used for API-specific Location resources,
|
|
962
|
+
* which should be handled by the generator as if they were actually
|
|
963
|
+
* the common Location resources.
|
|
964
|
+
* Example entry: "documentai.googleapis.com/Location"
|
|
965
|
+
*
|
|
966
|
+
* @generated from field: repeated string ignored_resources = 4;
|
|
967
|
+
*/
|
|
968
|
+
ignoredResources: string[];
|
|
969
|
+
/**
|
|
970
|
+
* Namespaces which must be aliased in snippets due to
|
|
971
|
+
* a known (but non-generator-predictable) naming collision
|
|
972
|
+
*
|
|
973
|
+
* @generated from field: repeated string forced_namespace_aliases = 5;
|
|
974
|
+
*/
|
|
975
|
+
forcedNamespaceAliases: string[];
|
|
976
|
+
/**
|
|
977
|
+
* Method signatures (in the form "service.method(signature)")
|
|
978
|
+
* which are provided separately, so shouldn't be generated.
|
|
979
|
+
* Snippets *calling* these methods are still generated, however.
|
|
980
|
+
*
|
|
981
|
+
* @generated from field: repeated string handwritten_signatures = 6;
|
|
982
|
+
*/
|
|
983
|
+
handwrittenSignatures: string[];
|
|
984
|
+
};
|
|
985
|
+
/**
|
|
986
|
+
* Describes the message google.api.DotnetSettings.
|
|
987
|
+
* Use `create(DotnetSettingsSchema)` to create a new message.
|
|
988
|
+
*/
|
|
989
|
+
declare const DotnetSettingsSchema: GenMessage<DotnetSettings>;
|
|
990
|
+
/**
|
|
991
|
+
* Settings for Ruby client libraries.
|
|
992
|
+
*
|
|
993
|
+
* @generated from message google.api.RubySettings
|
|
994
|
+
*/
|
|
995
|
+
type RubySettings = Message<"google.api.RubySettings"> & {
|
|
996
|
+
/**
|
|
997
|
+
* Some settings.
|
|
998
|
+
*
|
|
999
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
1000
|
+
*/
|
|
1001
|
+
common?: CommonLanguageSettings;
|
|
1002
|
+
};
|
|
1003
|
+
/**
|
|
1004
|
+
* Describes the message google.api.RubySettings.
|
|
1005
|
+
* Use `create(RubySettingsSchema)` to create a new message.
|
|
1006
|
+
*/
|
|
1007
|
+
declare const RubySettingsSchema: GenMessage<RubySettings>;
|
|
1008
|
+
/**
|
|
1009
|
+
* Settings for Go client libraries.
|
|
1010
|
+
*
|
|
1011
|
+
* @generated from message google.api.GoSettings
|
|
1012
|
+
*/
|
|
1013
|
+
type GoSettings = Message<"google.api.GoSettings"> & {
|
|
1014
|
+
/**
|
|
1015
|
+
* Some settings.
|
|
1016
|
+
*
|
|
1017
|
+
* @generated from field: google.api.CommonLanguageSettings common = 1;
|
|
1018
|
+
*/
|
|
1019
|
+
common?: CommonLanguageSettings;
|
|
1020
|
+
/**
|
|
1021
|
+
* Map of service names to renamed services. Keys are the package relative
|
|
1022
|
+
* service names and values are the name to be used for the service client
|
|
1023
|
+
* and call options.
|
|
1024
|
+
*
|
|
1025
|
+
* publishing:
|
|
1026
|
+
* go_settings:
|
|
1027
|
+
* renamed_services:
|
|
1028
|
+
* Publisher: TopicAdmin
|
|
1029
|
+
*
|
|
1030
|
+
* @generated from field: map<string, string> renamed_services = 2;
|
|
1031
|
+
*/
|
|
1032
|
+
renamedServices: {
|
|
1033
|
+
[key: string]: string;
|
|
1034
|
+
};
|
|
1035
|
+
};
|
|
1036
|
+
/**
|
|
1037
|
+
* Describes the message google.api.GoSettings.
|
|
1038
|
+
* Use `create(GoSettingsSchema)` to create a new message.
|
|
1039
|
+
*/
|
|
1040
|
+
declare const GoSettingsSchema: GenMessage<GoSettings>;
|
|
1041
|
+
/**
|
|
1042
|
+
* Describes the generator configuration for a method.
|
|
1043
|
+
*
|
|
1044
|
+
* @generated from message google.api.MethodSettings
|
|
1045
|
+
*/
|
|
1046
|
+
type MethodSettings = Message<"google.api.MethodSettings"> & {
|
|
1047
|
+
/**
|
|
1048
|
+
* The fully qualified name of the method, for which the options below apply.
|
|
1049
|
+
* This is used to find the method to apply the options.
|
|
1050
|
+
*
|
|
1051
|
+
* Example:
|
|
1052
|
+
*
|
|
1053
|
+
* publishing:
|
|
1054
|
+
* method_settings:
|
|
1055
|
+
* - selector: google.storage.control.v2.StorageControl.CreateFolder
|
|
1056
|
+
* # method settings for CreateFolder...
|
|
1057
|
+
*
|
|
1058
|
+
* @generated from field: string selector = 1;
|
|
1059
|
+
*/
|
|
1060
|
+
selector: string;
|
|
1061
|
+
/**
|
|
1062
|
+
* Describes settings to use for long-running operations when generating
|
|
1063
|
+
* API methods for RPCs. Complements RPCs that use the annotations in
|
|
1064
|
+
* google/longrunning/operations.proto.
|
|
1065
|
+
*
|
|
1066
|
+
* Example of a YAML configuration::
|
|
1067
|
+
*
|
|
1068
|
+
* publishing:
|
|
1069
|
+
* method_settings:
|
|
1070
|
+
* - selector: google.cloud.speech.v2.Speech.BatchRecognize
|
|
1071
|
+
* long_running:
|
|
1072
|
+
* initial_poll_delay: 60s # 1 minute
|
|
1073
|
+
* poll_delay_multiplier: 1.5
|
|
1074
|
+
* max_poll_delay: 360s # 6 minutes
|
|
1075
|
+
* total_poll_timeout: 54000s # 90 minutes
|
|
1076
|
+
*
|
|
1077
|
+
* @generated from field: google.api.MethodSettings.LongRunning long_running = 2;
|
|
1078
|
+
*/
|
|
1079
|
+
longRunning?: MethodSettings_LongRunning;
|
|
1080
|
+
/**
|
|
1081
|
+
* List of top-level fields of the request message, that should be
|
|
1082
|
+
* automatically populated by the client libraries based on their
|
|
1083
|
+
* (google.api.field_info).format. Currently supported format: UUID4.
|
|
1084
|
+
*
|
|
1085
|
+
* Example of a YAML configuration:
|
|
1086
|
+
*
|
|
1087
|
+
* publishing:
|
|
1088
|
+
* method_settings:
|
|
1089
|
+
* - selector: google.example.v1.ExampleService.CreateExample
|
|
1090
|
+
* auto_populated_fields:
|
|
1091
|
+
* - request_id
|
|
1092
|
+
*
|
|
1093
|
+
* @generated from field: repeated string auto_populated_fields = 3;
|
|
1094
|
+
*/
|
|
1095
|
+
autoPopulatedFields: string[];
|
|
1096
|
+
};
|
|
1097
|
+
/**
|
|
1098
|
+
* Describes the message google.api.MethodSettings.
|
|
1099
|
+
* Use `create(MethodSettingsSchema)` to create a new message.
|
|
1100
|
+
*/
|
|
1101
|
+
declare const MethodSettingsSchema: GenMessage<MethodSettings>;
|
|
1102
|
+
/**
|
|
1103
|
+
* Describes settings to use when generating API methods that use the
|
|
1104
|
+
* long-running operation pattern.
|
|
1105
|
+
* All default values below are from those used in the client library
|
|
1106
|
+
* generators (e.g.
|
|
1107
|
+
* [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
|
|
1108
|
+
*
|
|
1109
|
+
* @generated from message google.api.MethodSettings.LongRunning
|
|
1110
|
+
*/
|
|
1111
|
+
type MethodSettings_LongRunning = Message<"google.api.MethodSettings.LongRunning"> & {
|
|
1112
|
+
/**
|
|
1113
|
+
* Initial delay after which the first poll request will be made.
|
|
1114
|
+
* Default value: 5 seconds.
|
|
1115
|
+
*
|
|
1116
|
+
* @generated from field: google.protobuf.Duration initial_poll_delay = 1;
|
|
1117
|
+
*/
|
|
1118
|
+
initialPollDelay?: Duration;
|
|
1119
|
+
/**
|
|
1120
|
+
* Multiplier to gradually increase delay between subsequent polls until it
|
|
1121
|
+
* reaches max_poll_delay.
|
|
1122
|
+
* Default value: 1.5.
|
|
1123
|
+
*
|
|
1124
|
+
* @generated from field: float poll_delay_multiplier = 2;
|
|
1125
|
+
*/
|
|
1126
|
+
pollDelayMultiplier: number;
|
|
1127
|
+
/**
|
|
1128
|
+
* Maximum time between two subsequent poll requests.
|
|
1129
|
+
* Default value: 45 seconds.
|
|
1130
|
+
*
|
|
1131
|
+
* @generated from field: google.protobuf.Duration max_poll_delay = 3;
|
|
1132
|
+
*/
|
|
1133
|
+
maxPollDelay?: Duration;
|
|
1134
|
+
/**
|
|
1135
|
+
* Total polling timeout.
|
|
1136
|
+
* Default value: 5 minutes.
|
|
1137
|
+
*
|
|
1138
|
+
* @generated from field: google.protobuf.Duration total_poll_timeout = 4;
|
|
1139
|
+
*/
|
|
1140
|
+
totalPollTimeout?: Duration;
|
|
1141
|
+
};
|
|
1142
|
+
/**
|
|
1143
|
+
* Describes the message google.api.MethodSettings.LongRunning.
|
|
1144
|
+
* Use `create(MethodSettings_LongRunningSchema)` to create a new message.
|
|
1145
|
+
*/
|
|
1146
|
+
declare const MethodSettings_LongRunningSchema: GenMessage<MethodSettings_LongRunning>;
|
|
1147
|
+
/**
|
|
1148
|
+
* This message is used to configure the generation of a subset of the RPCs in
|
|
1149
|
+
* a service for client libraries.
|
|
1150
|
+
*
|
|
1151
|
+
* @generated from message google.api.SelectiveGapicGeneration
|
|
1152
|
+
*/
|
|
1153
|
+
type SelectiveGapicGeneration = Message<"google.api.SelectiveGapicGeneration"> & {
|
|
1154
|
+
/**
|
|
1155
|
+
* An allowlist of the fully qualified names of RPCs that should be included
|
|
1156
|
+
* on public client surfaces.
|
|
1157
|
+
*
|
|
1158
|
+
* @generated from field: repeated string methods = 1;
|
|
1159
|
+
*/
|
|
1160
|
+
methods: string[];
|
|
1161
|
+
/**
|
|
1162
|
+
* Setting this to true indicates to the client generators that methods
|
|
1163
|
+
* that would be excluded from the generation should instead be generated
|
|
1164
|
+
* in a way that indicates these methods should not be consumed by
|
|
1165
|
+
* end users. How this is expressed is up to individual language
|
|
1166
|
+
* implementations to decide. Some examples may be: added annotations,
|
|
1167
|
+
* obfuscated identifiers, or other language idiomatic patterns.
|
|
1168
|
+
*
|
|
1169
|
+
* @generated from field: bool generate_omitted_as_internal = 2;
|
|
1170
|
+
*/
|
|
1171
|
+
generateOmittedAsInternal: boolean;
|
|
1172
|
+
};
|
|
1173
|
+
/**
|
|
1174
|
+
* Describes the message google.api.SelectiveGapicGeneration.
|
|
1175
|
+
* Use `create(SelectiveGapicGenerationSchema)` to create a new message.
|
|
1176
|
+
*/
|
|
1177
|
+
declare const SelectiveGapicGenerationSchema: GenMessage<SelectiveGapicGeneration>;
|
|
1178
|
+
/**
|
|
1179
|
+
* The organization for which the client libraries are being published.
|
|
1180
|
+
* Affects the url where generated docs are published, etc.
|
|
1181
|
+
*
|
|
1182
|
+
* @generated from enum google.api.ClientLibraryOrganization
|
|
1183
|
+
*/
|
|
1184
|
+
declare enum ClientLibraryOrganization {
|
|
1185
|
+
/**
|
|
1186
|
+
* Not useful.
|
|
1187
|
+
*
|
|
1188
|
+
* @generated from enum value: CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0;
|
|
1189
|
+
*/
|
|
1190
|
+
CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0,
|
|
1191
|
+
/**
|
|
1192
|
+
* Google Cloud Platform Org.
|
|
1193
|
+
*
|
|
1194
|
+
* @generated from enum value: CLOUD = 1;
|
|
1195
|
+
*/
|
|
1196
|
+
CLOUD = 1,
|
|
1197
|
+
/**
|
|
1198
|
+
* Ads (Advertising) Org.
|
|
1199
|
+
*
|
|
1200
|
+
* @generated from enum value: ADS = 2;
|
|
1201
|
+
*/
|
|
1202
|
+
ADS = 2,
|
|
1203
|
+
/**
|
|
1204
|
+
* Photos Org.
|
|
1205
|
+
*
|
|
1206
|
+
* @generated from enum value: PHOTOS = 3;
|
|
1207
|
+
*/
|
|
1208
|
+
PHOTOS = 3,
|
|
1209
|
+
/**
|
|
1210
|
+
* Street View Org.
|
|
1211
|
+
*
|
|
1212
|
+
* @generated from enum value: STREET_VIEW = 4;
|
|
1213
|
+
*/
|
|
1214
|
+
STREET_VIEW = 4,
|
|
1215
|
+
/**
|
|
1216
|
+
* Shopping Org.
|
|
1217
|
+
*
|
|
1218
|
+
* @generated from enum value: SHOPPING = 5;
|
|
1219
|
+
*/
|
|
1220
|
+
SHOPPING = 5,
|
|
1221
|
+
/**
|
|
1222
|
+
* Geo Org.
|
|
1223
|
+
*
|
|
1224
|
+
* @generated from enum value: GEO = 6;
|
|
1225
|
+
*/
|
|
1226
|
+
GEO = 6,
|
|
1227
|
+
/**
|
|
1228
|
+
* Generative AI - https://developers.generativeai.google
|
|
1229
|
+
*
|
|
1230
|
+
* @generated from enum value: GENERATIVE_AI = 7;
|
|
1231
|
+
*/
|
|
1232
|
+
GENERATIVE_AI = 7
|
|
1233
|
+
}
|
|
1234
|
+
/**
|
|
1235
|
+
* Describes the enum google.api.ClientLibraryOrganization.
|
|
1236
|
+
*/
|
|
1237
|
+
declare const ClientLibraryOrganizationSchema: GenEnum<ClientLibraryOrganization>;
|
|
1238
|
+
/**
|
|
1239
|
+
* To where should client libraries be published?
|
|
1240
|
+
*
|
|
1241
|
+
* @generated from enum google.api.ClientLibraryDestination
|
|
1242
|
+
*/
|
|
1243
|
+
declare enum ClientLibraryDestination {
|
|
1244
|
+
/**
|
|
1245
|
+
* Client libraries will neither be generated nor published to package
|
|
1246
|
+
* managers.
|
|
1247
|
+
*
|
|
1248
|
+
* @generated from enum value: CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0;
|
|
1249
|
+
*/
|
|
1250
|
+
CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0,
|
|
1251
|
+
/**
|
|
1252
|
+
* Generate the client library in a repo under github.com/googleapis,
|
|
1253
|
+
* but don't publish it to package managers.
|
|
1254
|
+
*
|
|
1255
|
+
* @generated from enum value: GITHUB = 10;
|
|
1256
|
+
*/
|
|
1257
|
+
GITHUB = 10,
|
|
1258
|
+
/**
|
|
1259
|
+
* Publish the library to package managers like nuget.org and npmjs.com.
|
|
1260
|
+
*
|
|
1261
|
+
* @generated from enum value: PACKAGE_MANAGER = 20;
|
|
1262
|
+
*/
|
|
1263
|
+
PACKAGE_MANAGER = 20
|
|
1264
|
+
}
|
|
1265
|
+
/**
|
|
1266
|
+
* Describes the enum google.api.ClientLibraryDestination.
|
|
1267
|
+
*/
|
|
1268
|
+
declare const ClientLibraryDestinationSchema: GenEnum<ClientLibraryDestination>;
|
|
1269
|
+
/**
|
|
1270
|
+
* A definition of a client library method signature.
|
|
1271
|
+
*
|
|
1272
|
+
* In client libraries, each proto RPC corresponds to one or more methods
|
|
1273
|
+
* which the end user is able to call, and calls the underlying RPC.
|
|
1274
|
+
* Normally, this method receives a single argument (a struct or instance
|
|
1275
|
+
* corresponding to the RPC request object). Defining this field will
|
|
1276
|
+
* add one or more overloads providing flattened or simpler method signatures
|
|
1277
|
+
* in some languages.
|
|
1278
|
+
*
|
|
1279
|
+
* The fields on the method signature are provided as a comma-separated
|
|
1280
|
+
* string.
|
|
1281
|
+
*
|
|
1282
|
+
* For example, the proto RPC and annotation:
|
|
1283
|
+
*
|
|
1284
|
+
* rpc CreateSubscription(CreateSubscriptionRequest)
|
|
1285
|
+
* returns (Subscription) {
|
|
1286
|
+
* option (google.api.method_signature) = "name,topic";
|
|
1287
|
+
* }
|
|
1288
|
+
*
|
|
1289
|
+
* Would add the following Java overload (in addition to the method accepting
|
|
1290
|
+
* the request object):
|
|
1291
|
+
*
|
|
1292
|
+
* public final Subscription createSubscription(String name, String topic)
|
|
1293
|
+
*
|
|
1294
|
+
* The following backwards-compatibility guidelines apply:
|
|
1295
|
+
*
|
|
1296
|
+
* * Adding this annotation to an unannotated method is backwards
|
|
1297
|
+
* compatible.
|
|
1298
|
+
* * Adding this annotation to a method which already has existing
|
|
1299
|
+
* method signature annotations is backwards compatible if and only if
|
|
1300
|
+
* the new method signature annotation is last in the sequence.
|
|
1301
|
+
* * Modifying or removing an existing method signature annotation is
|
|
1302
|
+
* a breaking change.
|
|
1303
|
+
* * Re-ordering existing method signature annotations is a breaking
|
|
1304
|
+
* change.
|
|
1305
|
+
*
|
|
1306
|
+
* @generated from extension: repeated string method_signature = 1051;
|
|
1307
|
+
*/
|
|
1308
|
+
declare const method_signature: GenExtension<MethodOptions, string[]>;
|
|
1309
|
+
/**
|
|
1310
|
+
* The hostname for this service.
|
|
1311
|
+
* This should be specified with no prefix or protocol.
|
|
1312
|
+
*
|
|
1313
|
+
* Example:
|
|
1314
|
+
*
|
|
1315
|
+
* service Foo {
|
|
1316
|
+
* option (google.api.default_host) = "foo.googleapi.com";
|
|
1317
|
+
* ...
|
|
1318
|
+
* }
|
|
1319
|
+
*
|
|
1320
|
+
* @generated from extension: string default_host = 1049;
|
|
1321
|
+
*/
|
|
1322
|
+
declare const default_host: GenExtension<ServiceOptions, string>;
|
|
1323
|
+
/**
|
|
1324
|
+
* OAuth scopes needed for the client.
|
|
1325
|
+
*
|
|
1326
|
+
* Example:
|
|
1327
|
+
*
|
|
1328
|
+
* service Foo {
|
|
1329
|
+
* option (google.api.oauth_scopes) = \
|
|
1330
|
+
* "https://www.googleapis.com/auth/cloud-platform";
|
|
1331
|
+
* ...
|
|
1332
|
+
* }
|
|
1333
|
+
*
|
|
1334
|
+
* If there is more than one scope, use a comma-separated string:
|
|
1335
|
+
*
|
|
1336
|
+
* Example:
|
|
1337
|
+
*
|
|
1338
|
+
* service Foo {
|
|
1339
|
+
* option (google.api.oauth_scopes) = \
|
|
1340
|
+
* "https://www.googleapis.com/auth/cloud-platform,"
|
|
1341
|
+
* "https://www.googleapis.com/auth/monitoring";
|
|
1342
|
+
* ...
|
|
1343
|
+
* }
|
|
1344
|
+
*
|
|
1345
|
+
* @generated from extension: string oauth_scopes = 1050;
|
|
1346
|
+
*/
|
|
1347
|
+
declare const oauth_scopes: GenExtension<ServiceOptions, string>;
|
|
1348
|
+
/**
|
|
1349
|
+
* The API version of this service, which should be sent by version-aware
|
|
1350
|
+
* clients to the service. This allows services to abide by the schema and
|
|
1351
|
+
* behavior of the service at the time this API version was deployed.
|
|
1352
|
+
* The format of the API version must be treated as opaque by clients.
|
|
1353
|
+
* Services may use a format with an apparent structure, but clients must
|
|
1354
|
+
* not rely on this to determine components within an API version, or attempt
|
|
1355
|
+
* to construct other valid API versions. Note that this is for upcoming
|
|
1356
|
+
* functionality and may not be implemented for all services.
|
|
1357
|
+
*
|
|
1358
|
+
* Example:
|
|
1359
|
+
*
|
|
1360
|
+
* service Foo {
|
|
1361
|
+
* option (google.api.api_version) = "v1_20230821_preview";
|
|
1362
|
+
* }
|
|
1363
|
+
*
|
|
1364
|
+
* @generated from extension: string api_version = 525000001;
|
|
1365
|
+
*/
|
|
1366
|
+
declare const api_version: GenExtension<ServiceOptions, string>;
|
|
1367
|
+
|
|
1368
|
+
/**
|
|
1369
|
+
* Describes the file google/api/field_behavior.proto.
|
|
1370
|
+
*/
|
|
1371
|
+
declare const file_google_api_field_behavior: GenFile;
|
|
1372
|
+
/**
|
|
1373
|
+
* An indicator of the behavior of a given field (for example, that a field
|
|
1374
|
+
* is required in requests, or given as output but ignored as input).
|
|
1375
|
+
* This **does not** change the behavior in protocol buffers itself; it only
|
|
1376
|
+
* denotes the behavior and may affect how API tooling handles the field.
|
|
1377
|
+
*
|
|
1378
|
+
* Note: This enum **may** receive new values in the future.
|
|
1379
|
+
*
|
|
1380
|
+
* @generated from enum google.api.FieldBehavior
|
|
1381
|
+
*/
|
|
1382
|
+
declare enum FieldBehavior {
|
|
1383
|
+
/**
|
|
1384
|
+
* Conventional default for enums. Do not use this.
|
|
1385
|
+
*
|
|
1386
|
+
* @generated from enum value: FIELD_BEHAVIOR_UNSPECIFIED = 0;
|
|
1387
|
+
*/
|
|
1388
|
+
FIELD_BEHAVIOR_UNSPECIFIED = 0,
|
|
1389
|
+
/**
|
|
1390
|
+
* Specifically denotes a field as optional.
|
|
1391
|
+
* While all fields in protocol buffers are optional, this may be specified
|
|
1392
|
+
* for emphasis if appropriate.
|
|
1393
|
+
*
|
|
1394
|
+
* @generated from enum value: OPTIONAL = 1;
|
|
1395
|
+
*/
|
|
1396
|
+
OPTIONAL = 1,
|
|
1397
|
+
/**
|
|
1398
|
+
* Denotes a field as required.
|
|
1399
|
+
* This indicates that the field **must** be provided as part of the request,
|
|
1400
|
+
* and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
|
|
1401
|
+
*
|
|
1402
|
+
* @generated from enum value: REQUIRED = 2;
|
|
1403
|
+
*/
|
|
1404
|
+
REQUIRED = 2,
|
|
1405
|
+
/**
|
|
1406
|
+
* Denotes a field as output only.
|
|
1407
|
+
* This indicates that the field is provided in responses, but including the
|
|
1408
|
+
* field in a request does nothing (the server *must* ignore it and
|
|
1409
|
+
* *must not* throw an error as a result of the field's presence).
|
|
1410
|
+
*
|
|
1411
|
+
* @generated from enum value: OUTPUT_ONLY = 3;
|
|
1412
|
+
*/
|
|
1413
|
+
OUTPUT_ONLY = 3,
|
|
1414
|
+
/**
|
|
1415
|
+
* Denotes a field as input only.
|
|
1416
|
+
* This indicates that the field is provided in requests, and the
|
|
1417
|
+
* corresponding field is not included in output.
|
|
1418
|
+
*
|
|
1419
|
+
* @generated from enum value: INPUT_ONLY = 4;
|
|
1420
|
+
*/
|
|
1421
|
+
INPUT_ONLY = 4,
|
|
1422
|
+
/**
|
|
1423
|
+
* Denotes a field as immutable.
|
|
1424
|
+
* This indicates that the field may be set once in a request to create a
|
|
1425
|
+
* resource, but may not be changed thereafter.
|
|
1426
|
+
*
|
|
1427
|
+
* @generated from enum value: IMMUTABLE = 5;
|
|
1428
|
+
*/
|
|
1429
|
+
IMMUTABLE = 5,
|
|
1430
|
+
/**
|
|
1431
|
+
* Denotes that a (repeated) field is an unordered list.
|
|
1432
|
+
* This indicates that the service may provide the elements of the list
|
|
1433
|
+
* in any arbitrary order, rather than the order the user originally
|
|
1434
|
+
* provided. Additionally, the list's order may or may not be stable.
|
|
1435
|
+
*
|
|
1436
|
+
* @generated from enum value: UNORDERED_LIST = 6;
|
|
1437
|
+
*/
|
|
1438
|
+
UNORDERED_LIST = 6,
|
|
1439
|
+
/**
|
|
1440
|
+
* Denotes that this field returns a non-empty default value if not set.
|
|
1441
|
+
* This indicates that if the user provides the empty value in a request,
|
|
1442
|
+
* a non-empty value will be returned. The user will not be aware of what
|
|
1443
|
+
* non-empty value to expect.
|
|
1444
|
+
*
|
|
1445
|
+
* @generated from enum value: NON_EMPTY_DEFAULT = 7;
|
|
1446
|
+
*/
|
|
1447
|
+
NON_EMPTY_DEFAULT = 7,
|
|
1448
|
+
/**
|
|
1449
|
+
* Denotes that the field in a resource (a message annotated with
|
|
1450
|
+
* google.api.resource) is used in the resource name to uniquely identify the
|
|
1451
|
+
* resource. For AIP-compliant APIs, this should only be applied to the
|
|
1452
|
+
* `name` field on the resource.
|
|
1453
|
+
*
|
|
1454
|
+
* This behavior should not be applied to references to other resources within
|
|
1455
|
+
* the message.
|
|
1456
|
+
*
|
|
1457
|
+
* The identifier field of resources often have different field behavior
|
|
1458
|
+
* depending on the request it is embedded in (e.g. for Create methods name
|
|
1459
|
+
* is optional and unused, while for Update methods it is required). Instead
|
|
1460
|
+
* of method-specific annotations, only `IDENTIFIER` is required.
|
|
1461
|
+
*
|
|
1462
|
+
* @generated from enum value: IDENTIFIER = 8;
|
|
1463
|
+
*/
|
|
1464
|
+
IDENTIFIER = 8
|
|
1465
|
+
}
|
|
1466
|
+
/**
|
|
1467
|
+
* Describes the enum google.api.FieldBehavior.
|
|
1468
|
+
*/
|
|
1469
|
+
declare const FieldBehaviorSchema: GenEnum<FieldBehavior>;
|
|
1470
|
+
/**
|
|
1471
|
+
* A designation of a specific field behavior (required, output only, etc.)
|
|
1472
|
+
* in protobuf messages.
|
|
1473
|
+
*
|
|
1474
|
+
* Examples:
|
|
1475
|
+
*
|
|
1476
|
+
* string name = 1 [(google.api.field_behavior) = REQUIRED];
|
|
1477
|
+
* State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
1478
|
+
* google.protobuf.Duration ttl = 1
|
|
1479
|
+
* [(google.api.field_behavior) = INPUT_ONLY];
|
|
1480
|
+
* google.protobuf.Timestamp expire_time = 1
|
|
1481
|
+
* [(google.api.field_behavior) = OUTPUT_ONLY,
|
|
1482
|
+
* (google.api.field_behavior) = IMMUTABLE];
|
|
1483
|
+
*
|
|
1484
|
+
* @generated from extension: repeated google.api.FieldBehavior field_behavior = 1052 [packed = false];
|
|
1485
|
+
*/
|
|
1486
|
+
declare const field_behavior: GenExtension<FieldOptions, FieldBehavior[]>;
|
|
1487
|
+
|
|
1488
|
+
export { ClientLibraryDestination, ClientLibraryDestinationSchema, ClientLibraryOrganization, ClientLibraryOrganizationSchema, ClientLibrarySettingsSchema, CommonLanguageSettingsSchema, CppSettingsSchema, CustomHttpPatternSchema, DotnetSettingsSchema, FieldBehavior, FieldBehaviorSchema, GoSettingsSchema, HttpRuleSchema, HttpSchema, JavaSettingsSchema, LaunchStage, LaunchStageSchema, MethodSettingsSchema, MethodSettings_LongRunningSchema, NodeSettingsSchema, PhpSettingsSchema, PublishingSchema, PythonSettingsSchema, PythonSettings_ExperimentalFeaturesSchema, RubySettingsSchema, SelectiveGapicGenerationSchema, api_version, default_host, field_behavior, file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_http, file_google_api_launch_stage, http, method_signature, oauth_scopes };
|
|
1489
|
+
export type { ClientLibrarySettings, CommonLanguageSettings, CppSettings, CustomHttpPattern, DotnetSettings, GoSettings, Http, HttpRule, JavaSettings, MethodSettings, MethodSettings_LongRunning, NodeSettings, PhpSettings, Publishing, PythonSettings, PythonSettings_ExperimentalFeatures, RubySettings, SelectiveGapicGeneration };
|