@maxim_mazurok/gapi.client.serviceusage-v1 0.0.20230419 → 0.0.20230428
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/index.d.ts +1012 -505
- package/package.json +1 -1
- package/tests.ts +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://serviceusage.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20230428
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -24,42 +24,54 @@ declare namespace gapi.client {
|
|
|
24
24
|
namespace serviceusage {
|
|
25
25
|
interface AdminQuotaPolicy {
|
|
26
26
|
/** The cloud resource container at which the quota policy is created. The format is `{container_type}/{container_number}` */
|
|
27
|
-
container?:
|
|
27
|
+
container?:
|
|
28
|
+
string;
|
|
28
29
|
/**
|
|
29
30
|
* If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, an policy on a limit with the unit
|
|
30
31
|
* `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the policy is only applied to quota consumed in that region. This map has the
|
|
31
32
|
* following restrictions: * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * Keys other than
|
|
32
33
|
* `region` or `zone` are not valid.
|
|
33
34
|
*/
|
|
34
|
-
dimensions?:
|
|
35
|
+
dimensions?:
|
|
36
|
+
{ [P in string]: string };
|
|
35
37
|
/** The name of the metric to which this policy applies. An example name would be: `compute.googleapis.com/cpus` */
|
|
36
|
-
metric?:
|
|
38
|
+
metric?:
|
|
39
|
+
string;
|
|
37
40
|
/**
|
|
38
41
|
* The resource name of the policy. This name is generated by the server when the policy is created. Example names would be:
|
|
39
42
|
* `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d`
|
|
40
43
|
*/
|
|
41
|
-
name?:
|
|
44
|
+
name?:
|
|
45
|
+
string;
|
|
42
46
|
/** The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota). */
|
|
43
|
-
policyValue?:
|
|
47
|
+
policyValue?:
|
|
48
|
+
string;
|
|
44
49
|
/**
|
|
45
50
|
* The limit unit of the limit to which this policy applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example;
|
|
46
51
|
* the literal characters `{` and `}` occur in the string.
|
|
47
52
|
*/
|
|
48
|
-
unit?:
|
|
53
|
+
unit?:
|
|
54
|
+
string;
|
|
49
55
|
}
|
|
50
56
|
interface Api {
|
|
51
57
|
/** The methods of this interface, in unspecified order. */
|
|
52
|
-
methods?:
|
|
58
|
+
methods?:
|
|
59
|
+
Method[];
|
|
53
60
|
/** Included interfaces. See Mixin. */
|
|
54
|
-
mixins?:
|
|
61
|
+
mixins?:
|
|
62
|
+
Mixin[];
|
|
55
63
|
/** The fully qualified name of this interface, including package name followed by the interface's simple name. */
|
|
56
|
-
name?:
|
|
64
|
+
name?:
|
|
65
|
+
string;
|
|
57
66
|
/** Any metadata attached to the interface. */
|
|
58
|
-
options?:
|
|
67
|
+
options?:
|
|
68
|
+
Option[];
|
|
59
69
|
/** Source context for the protocol buffer service represented by this message. */
|
|
60
|
-
sourceContext?:
|
|
70
|
+
sourceContext?:
|
|
71
|
+
SourceContext;
|
|
61
72
|
/** The source syntax of the service. */
|
|
62
|
-
syntax?:
|
|
73
|
+
syntax?:
|
|
74
|
+
string;
|
|
63
75
|
/**
|
|
64
76
|
* A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the
|
|
65
77
|
* entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to
|
|
@@ -68,23 +80,30 @@ declare namespace gapi.client {
|
|
|
68
80
|
* plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be
|
|
69
81
|
* omitted. Zero major versions must only be used for experimental, non-GA interfaces.
|
|
70
82
|
*/
|
|
71
|
-
version?:
|
|
83
|
+
version?:
|
|
84
|
+
string;
|
|
72
85
|
}
|
|
73
86
|
interface Authentication {
|
|
74
87
|
/** Defines a set of authentication providers that a service supports. */
|
|
75
|
-
providers?:
|
|
88
|
+
providers?:
|
|
89
|
+
AuthProvider[];
|
|
76
90
|
/** A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */
|
|
77
|
-
rules?:
|
|
91
|
+
rules?:
|
|
92
|
+
AuthenticationRule[];
|
|
78
93
|
}
|
|
79
94
|
interface AuthenticationRule {
|
|
80
95
|
/** If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests. */
|
|
81
|
-
allowWithoutCredential?:
|
|
96
|
+
allowWithoutCredential?:
|
|
97
|
+
boolean;
|
|
82
98
|
/** The requirements for OAuth credentials. */
|
|
83
|
-
oauth?:
|
|
99
|
+
oauth?:
|
|
100
|
+
OAuthRequirements;
|
|
84
101
|
/** Requirements for additional authentication providers. */
|
|
85
|
-
requirements?:
|
|
102
|
+
requirements?:
|
|
103
|
+
AuthRequirement[];
|
|
86
104
|
/** Selects the methods to which this rule applies. Refer to selector for syntax details. */
|
|
87
|
-
selector?:
|
|
105
|
+
selector?:
|
|
106
|
+
string;
|
|
88
107
|
}
|
|
89
108
|
interface AuthProvider {
|
|
90
109
|
/**
|
|
@@ -93,29 +112,35 @@ declare namespace gapi.client {
|
|
|
93
112
|
* audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService -
|
|
94
113
|
* https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
|
|
95
114
|
*/
|
|
96
|
-
audiences?:
|
|
115
|
+
audiences?:
|
|
116
|
+
string;
|
|
97
117
|
/** Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec. */
|
|
98
|
-
authorizationUrl?:
|
|
118
|
+
authorizationUrl?:
|
|
119
|
+
string;
|
|
99
120
|
/** The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth". */
|
|
100
|
-
id?:
|
|
121
|
+
id?:
|
|
122
|
+
string;
|
|
101
123
|
/**
|
|
102
124
|
* Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example:
|
|
103
125
|
* https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
|
|
104
126
|
*/
|
|
105
|
-
issuer?:
|
|
127
|
+
issuer?:
|
|
128
|
+
string;
|
|
106
129
|
/**
|
|
107
130
|
* URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional
|
|
108
131
|
* if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer. - can be inferred from the email
|
|
109
132
|
* domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs
|
|
110
133
|
*/
|
|
111
|
-
jwksUri?:
|
|
134
|
+
jwksUri?:
|
|
135
|
+
string;
|
|
112
136
|
/**
|
|
113
137
|
* Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations]
|
|
114
138
|
* (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is
|
|
115
139
|
* that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default
|
|
116
140
|
* locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token
|
|
117
141
|
*/
|
|
118
|
-
jwtLocations?:
|
|
142
|
+
jwtLocations?:
|
|
143
|
+
JwtLocation[];
|
|
119
144
|
}
|
|
120
145
|
interface AuthRequirement {
|
|
121
146
|
/**
|
|
@@ -125,13 +150,16 @@ declare namespace gapi.client {
|
|
|
125
150
|
* accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences:
|
|
126
151
|
* bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
|
|
127
152
|
*/
|
|
128
|
-
audiences?:
|
|
153
|
+
audiences?:
|
|
154
|
+
string;
|
|
129
155
|
/** id from authentication provider. Example: provider_id: bookstore_auth */
|
|
130
|
-
providerId?:
|
|
156
|
+
providerId?:
|
|
157
|
+
string;
|
|
131
158
|
}
|
|
132
159
|
interface Backend {
|
|
133
160
|
/** A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */
|
|
134
|
-
rules?:
|
|
161
|
+
rules?:
|
|
162
|
+
BackendRule[];
|
|
135
163
|
}
|
|
136
164
|
interface BackendRule {
|
|
137
165
|
/**
|
|
@@ -139,40 +167,52 @@ declare namespace gapi.client {
|
|
|
139
167
|
* https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If
|
|
140
168
|
* the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.
|
|
141
169
|
*/
|
|
142
|
-
address?:
|
|
170
|
+
address?:
|
|
171
|
+
string;
|
|
143
172
|
/** The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment. */
|
|
144
|
-
deadline?:
|
|
173
|
+
deadline?:
|
|
174
|
+
number;
|
|
145
175
|
/**
|
|
146
176
|
* When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is
|
|
147
177
|
* expected by the backend, this field must be set to true to preserve the header.
|
|
148
178
|
*/
|
|
149
|
-
disableAuth?:
|
|
179
|
+
disableAuth?:
|
|
180
|
+
boolean;
|
|
150
181
|
/** The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend. */
|
|
151
|
-
jwtAudience?:
|
|
182
|
+
jwtAudience?:
|
|
183
|
+
string;
|
|
152
184
|
/** Deprecated, do not use. */
|
|
153
|
-
minDeadline?:
|
|
185
|
+
minDeadline?:
|
|
186
|
+
number;
|
|
154
187
|
/** The number of seconds to wait for the completion of a long running operation. The default is no deadline. */
|
|
155
|
-
operationDeadline?:
|
|
188
|
+
operationDeadline?:
|
|
189
|
+
number;
|
|
156
190
|
/** The map between request protocol and the backend address. */
|
|
157
|
-
overridesByRequestProtocol?:
|
|
158
|
-
|
|
191
|
+
overridesByRequestProtocol?:
|
|
192
|
+
{ [P in string]: BackendRule };
|
|
193
|
+
pathTranslation?:
|
|
194
|
+
string;
|
|
159
195
|
/**
|
|
160
196
|
* The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME
|
|
161
197
|
* PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance.
|
|
162
198
|
* Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See
|
|
163
199
|
* https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.
|
|
164
200
|
*/
|
|
165
|
-
protocol?:
|
|
201
|
+
protocol?:
|
|
202
|
+
string;
|
|
166
203
|
/** Selects the methods to which this rule applies. Refer to selector for syntax details. */
|
|
167
|
-
selector?:
|
|
204
|
+
selector?:
|
|
205
|
+
string;
|
|
168
206
|
}
|
|
169
207
|
interface BatchCreateAdminOverridesResponse {
|
|
170
208
|
/** The overrides that were created. */
|
|
171
|
-
overrides?:
|
|
209
|
+
overrides?:
|
|
210
|
+
QuotaOverride[];
|
|
172
211
|
}
|
|
173
212
|
interface BatchCreateConsumerOverridesResponse {
|
|
174
213
|
/** The overrides that were created. */
|
|
175
|
-
overrides?:
|
|
214
|
+
overrides?:
|
|
215
|
+
QuotaOverride[];
|
|
176
216
|
}
|
|
177
217
|
interface BatchEnableServicesRequest {
|
|
178
218
|
/**
|
|
@@ -180,298 +220,388 @@ declare namespace gapi.client {
|
|
|
180
220
|
* shared with the user enabling the service. A single request can enable a maximum of 20 services at a time. If more than 20 services are specified, the request will fail, and no
|
|
181
221
|
* state changes will occur.
|
|
182
222
|
*/
|
|
183
|
-
serviceIds?:
|
|
223
|
+
serviceIds?:
|
|
224
|
+
string[];
|
|
184
225
|
}
|
|
185
226
|
interface BatchEnableServicesResponse {
|
|
186
227
|
/** If allow_partial_success is true, and one or more services could not be enabled, this field contains the details about each failure. */
|
|
187
|
-
failures?:
|
|
228
|
+
failures?:
|
|
229
|
+
EnableFailure[];
|
|
188
230
|
/** The new state of the services after enabling. */
|
|
189
|
-
services?:
|
|
231
|
+
services?:
|
|
232
|
+
GoogleApiServiceusageV1Service[];
|
|
190
233
|
}
|
|
191
234
|
interface BatchGetServicesResponse {
|
|
192
235
|
/** The requested Service states. */
|
|
193
|
-
services?:
|
|
236
|
+
services?:
|
|
237
|
+
GoogleApiServiceusageV1Service[];
|
|
194
238
|
}
|
|
195
239
|
interface Billing {
|
|
196
240
|
/**
|
|
197
241
|
* Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type.
|
|
198
242
|
* A metric can be used in at most one consumer destination.
|
|
199
243
|
*/
|
|
200
|
-
consumerDestinations?:
|
|
244
|
+
consumerDestinations?:
|
|
245
|
+
BillingDestination[];
|
|
201
246
|
}
|
|
202
247
|
interface BillingDestination {
|
|
203
248
|
/** Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section. */
|
|
204
|
-
metrics?:
|
|
249
|
+
metrics?:
|
|
250
|
+
string[];
|
|
205
251
|
/** The monitored resource type. The type must be defined in Service.monitored_resources section. */
|
|
206
|
-
monitoredResource?:
|
|
252
|
+
monitoredResource?:
|
|
253
|
+
string;
|
|
207
254
|
}
|
|
208
255
|
// tslint:disable-next-line:no-empty-interface
|
|
209
256
|
interface CancelOperationRequest {
|
|
210
257
|
}
|
|
211
258
|
interface ClientLibrarySettings {
|
|
212
259
|
/** Settings for C++ client libraries. */
|
|
213
|
-
cppSettings?:
|
|
260
|
+
cppSettings?:
|
|
261
|
+
CppSettings;
|
|
214
262
|
/** Settings for .NET client libraries. */
|
|
215
|
-
dotnetSettings?:
|
|
263
|
+
dotnetSettings?:
|
|
264
|
+
DotnetSettings;
|
|
216
265
|
/** Settings for Go client libraries. */
|
|
217
|
-
goSettings?:
|
|
266
|
+
goSettings?:
|
|
267
|
+
GoSettings;
|
|
218
268
|
/** Settings for legacy Java features, supported in the Service YAML. */
|
|
219
|
-
javaSettings?:
|
|
269
|
+
javaSettings?:
|
|
270
|
+
JavaSettings;
|
|
220
271
|
/** Launch stage of this version of the API. */
|
|
221
|
-
launchStage?:
|
|
272
|
+
launchStage?:
|
|
273
|
+
string;
|
|
222
274
|
/** Settings for Node client libraries. */
|
|
223
|
-
nodeSettings?:
|
|
275
|
+
nodeSettings?:
|
|
276
|
+
NodeSettings;
|
|
224
277
|
/** Settings for PHP client libraries. */
|
|
225
|
-
phpSettings?:
|
|
278
|
+
phpSettings?:
|
|
279
|
+
PhpSettings;
|
|
226
280
|
/** Settings for Python client libraries. */
|
|
227
|
-
pythonSettings?:
|
|
281
|
+
pythonSettings?:
|
|
282
|
+
PythonSettings;
|
|
228
283
|
/** When using transport=rest, the client request will encode enums as numbers rather than strings. */
|
|
229
|
-
restNumericEnums?:
|
|
284
|
+
restNumericEnums?:
|
|
285
|
+
boolean;
|
|
230
286
|
/** Settings for Ruby client libraries. */
|
|
231
|
-
rubySettings?:
|
|
287
|
+
rubySettings?:
|
|
288
|
+
RubySettings;
|
|
232
289
|
/**
|
|
233
290
|
* Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element. Examples: "google.cloud.speech.v1" and
|
|
234
291
|
* "google.spanner.admin.database.v1".
|
|
235
292
|
*/
|
|
236
|
-
version?:
|
|
293
|
+
version?:
|
|
294
|
+
string;
|
|
237
295
|
}
|
|
238
296
|
interface CommonLanguageSettings {
|
|
239
297
|
/** The destination where API teams want this client library to be published. */
|
|
240
|
-
destinations?:
|
|
298
|
+
destinations?:
|
|
299
|
+
string[];
|
|
241
300
|
/** Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest */
|
|
242
|
-
referenceDocsUri?:
|
|
301
|
+
referenceDocsUri?:
|
|
302
|
+
string;
|
|
243
303
|
}
|
|
244
304
|
interface ConsumerPolicy {
|
|
245
305
|
/**
|
|
246
306
|
* Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and
|
|
247
307
|
* should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations)
|
|
248
308
|
*/
|
|
249
|
-
annotations?:
|
|
309
|
+
annotations?:
|
|
310
|
+
{ [P in string]: string };
|
|
250
311
|
/** Enable rules define usable services and service groups. */
|
|
251
|
-
enableRules?:
|
|
312
|
+
enableRules?:
|
|
313
|
+
EnableRule[];
|
|
252
314
|
/** An opaque tag indicating the current version of the policy, used for concurrency control. */
|
|
253
|
-
etag?:
|
|
315
|
+
etag?:
|
|
316
|
+
string;
|
|
254
317
|
/** Output only. The resource name of the policy. For example, `projects/12345/consumerPolicy`, `folders/12345/consumerPolicy`, `organizations/12345/consumerPolicy`. */
|
|
255
|
-
name?:
|
|
318
|
+
name?:
|
|
319
|
+
string;
|
|
256
320
|
/** The last-modified time. */
|
|
257
|
-
updateTime?:
|
|
321
|
+
updateTime?:
|
|
322
|
+
string;
|
|
258
323
|
}
|
|
259
324
|
interface Context {
|
|
260
325
|
/** A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */
|
|
261
|
-
rules?:
|
|
326
|
+
rules?:
|
|
327
|
+
ContextRule[];
|
|
262
328
|
}
|
|
263
329
|
interface ContextRule {
|
|
264
330
|
/** A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend. */
|
|
265
|
-
allowedRequestExtensions?:
|
|
331
|
+
allowedRequestExtensions?:
|
|
332
|
+
string[];
|
|
266
333
|
/** A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. */
|
|
267
|
-
allowedResponseExtensions?:
|
|
334
|
+
allowedResponseExtensions?:
|
|
335
|
+
string[];
|
|
268
336
|
/** A list of full type names of provided contexts. */
|
|
269
|
-
provided?:
|
|
337
|
+
provided?:
|
|
338
|
+
string[];
|
|
270
339
|
/** A list of full type names of requested contexts. */
|
|
271
|
-
requested?:
|
|
340
|
+
requested?:
|
|
341
|
+
string[];
|
|
272
342
|
/** Selects the methods to which this rule applies. Refer to selector for syntax details. */
|
|
273
|
-
selector?:
|
|
343
|
+
selector?:
|
|
344
|
+
string;
|
|
274
345
|
}
|
|
275
346
|
interface Control {
|
|
276
347
|
/**
|
|
277
348
|
* The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is
|
|
278
349
|
* servicecontrol.googleapis.com
|
|
279
350
|
*/
|
|
280
|
-
environment?:
|
|
351
|
+
environment?:
|
|
352
|
+
string;
|
|
281
353
|
}
|
|
282
354
|
interface CppSettings {
|
|
283
355
|
/** Some settings. */
|
|
284
|
-
common?:
|
|
356
|
+
common?:
|
|
357
|
+
CommonLanguageSettings;
|
|
285
358
|
}
|
|
286
359
|
// tslint:disable-next-line:no-empty-interface
|
|
287
360
|
interface CreateAdminQuotaPolicyMetadata {
|
|
288
361
|
}
|
|
289
362
|
interface CustomError {
|
|
290
363
|
/** The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order. */
|
|
291
|
-
rules?:
|
|
364
|
+
rules?:
|
|
365
|
+
CustomErrorRule[];
|
|
292
366
|
/** The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. */
|
|
293
|
-
types?:
|
|
367
|
+
types?:
|
|
368
|
+
string[];
|
|
294
369
|
}
|
|
295
370
|
interface CustomErrorRule {
|
|
296
371
|
/** Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload. */
|
|
297
|
-
isErrorType?:
|
|
372
|
+
isErrorType?:
|
|
373
|
+
boolean;
|
|
298
374
|
/** Selects messages to which this rule applies. Refer to selector for syntax details. */
|
|
299
|
-
selector?:
|
|
375
|
+
selector?:
|
|
376
|
+
string;
|
|
300
377
|
}
|
|
301
378
|
interface CustomHttpPattern {
|
|
302
379
|
/** The name of this custom HTTP verb. */
|
|
303
|
-
kind?:
|
|
380
|
+
kind?:
|
|
381
|
+
string;
|
|
304
382
|
/** The path matched by this custom verb. */
|
|
305
|
-
path?:
|
|
383
|
+
path?:
|
|
384
|
+
string;
|
|
306
385
|
}
|
|
307
386
|
// tslint:disable-next-line:no-empty-interface
|
|
308
387
|
interface DeleteAdminQuotaPolicyMetadata {
|
|
309
388
|
}
|
|
310
389
|
interface DisableServiceRequest {
|
|
311
390
|
/** Defines the behavior for checking service usage when disabling a service. */
|
|
312
|
-
checkIfServiceHasUsage?:
|
|
391
|
+
checkIfServiceHasUsage?:
|
|
392
|
+
string;
|
|
313
393
|
/**
|
|
314
394
|
* Indicates if services that are enabled and which depend on this service should also be disabled. If not set, an error will be generated if any enabled services depend on the service
|
|
315
395
|
* to be disabled. When set, the service, and any enabled services that depend on it, will be disabled together.
|
|
316
396
|
*/
|
|
317
|
-
disableDependentServices?:
|
|
397
|
+
disableDependentServices?:
|
|
398
|
+
boolean;
|
|
318
399
|
}
|
|
319
400
|
interface DisableServiceResponse {
|
|
320
401
|
/** The new state of the service after disabling. */
|
|
321
|
-
service?:
|
|
402
|
+
service?:
|
|
403
|
+
GoogleApiServiceusageV1Service;
|
|
322
404
|
}
|
|
323
405
|
interface Documentation {
|
|
324
406
|
/** The URL to the root of documentation. */
|
|
325
|
-
documentationRootUrl?:
|
|
407
|
+
documentationRootUrl?:
|
|
408
|
+
string;
|
|
326
409
|
/**
|
|
327
410
|
* Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style):
|
|
328
411
|
* documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field.
|
|
329
412
|
*/
|
|
330
|
-
overview?:
|
|
413
|
+
overview?:
|
|
414
|
+
string;
|
|
331
415
|
/** The top level pages for the documentation set. */
|
|
332
|
-
pages?:
|
|
416
|
+
pages?:
|
|
417
|
+
Page[];
|
|
333
418
|
/** A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order. */
|
|
334
|
-
rules?:
|
|
419
|
+
rules?:
|
|
420
|
+
DocumentationRule[];
|
|
335
421
|
/**
|
|
336
422
|
* Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections
|
|
337
423
|
* that show a base that other urls are relative to.
|
|
338
424
|
*/
|
|
339
|
-
serviceRootUrl?:
|
|
425
|
+
serviceRootUrl?:
|
|
426
|
+
string;
|
|
340
427
|
/**
|
|
341
428
|
* A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is
|
|
342
429
|
* equivalent to the standard field `description`.
|
|
343
430
|
*/
|
|
344
|
-
summary?:
|
|
431
|
+
summary?:
|
|
432
|
+
string;
|
|
345
433
|
}
|
|
346
434
|
interface DocumentationRule {
|
|
347
435
|
/** Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. */
|
|
348
|
-
deprecationDescription?:
|
|
436
|
+
deprecationDescription?:
|
|
437
|
+
string;
|
|
349
438
|
/**
|
|
350
439
|
* Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source
|
|
351
440
|
* definition of the proto element.
|
|
352
441
|
*/
|
|
353
|
-
description?:
|
|
442
|
+
description?:
|
|
443
|
+
string;
|
|
444
|
+
/** String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen. */
|
|
445
|
+
disableReplacementWords?:
|
|
446
|
+
string;
|
|
354
447
|
/**
|
|
355
448
|
* The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "*",
|
|
356
449
|
* indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will
|
|
357
450
|
* match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.
|
|
358
451
|
*/
|
|
359
|
-
selector?:
|
|
452
|
+
selector?:
|
|
453
|
+
string;
|
|
360
454
|
}
|
|
361
455
|
interface DotnetSettings {
|
|
362
456
|
/** Some settings. */
|
|
363
|
-
common?:
|
|
457
|
+
common?:
|
|
458
|
+
CommonLanguageSettings;
|
|
364
459
|
/** Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision */
|
|
365
|
-
forcedNamespaceAliases?:
|
|
460
|
+
forcedNamespaceAliases?:
|
|
461
|
+
string[];
|
|
366
462
|
/** Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets *calling* these methods are still generated, however. */
|
|
367
|
-
handwrittenSignatures?:
|
|
463
|
+
handwrittenSignatures?:
|
|
464
|
+
string[];
|
|
368
465
|
/**
|
|
369
466
|
* List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were
|
|
370
467
|
* actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
|
|
371
468
|
*/
|
|
372
|
-
ignoredResources?:
|
|
469
|
+
ignoredResources?:
|
|
470
|
+
string[];
|
|
373
471
|
/**
|
|
374
472
|
* Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example
|
|
375
473
|
* entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
|
|
376
474
|
*/
|
|
377
|
-
renamedResources?:
|
|
475
|
+
renamedResources?:
|
|
476
|
+
{ [P in string]: string };
|
|
378
477
|
/**
|
|
379
478
|
* Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example:
|
|
380
479
|
* Subscriber to SubscriberServiceApi.
|
|
381
480
|
*/
|
|
382
|
-
renamedServices?:
|
|
481
|
+
renamedServices?:
|
|
482
|
+
{ [P in string]: string };
|
|
383
483
|
}
|
|
384
484
|
// tslint:disable-next-line:no-empty-interface
|
|
385
485
|
interface Empty {
|
|
386
486
|
}
|
|
387
487
|
interface EnableFailure {
|
|
388
488
|
/** An error message describing why the service could not be enabled. */
|
|
389
|
-
errorMessage?:
|
|
489
|
+
errorMessage?:
|
|
490
|
+
string;
|
|
390
491
|
/** The service id of a service that could not be enabled. */
|
|
391
|
-
serviceId?:
|
|
492
|
+
serviceId?:
|
|
493
|
+
string;
|
|
392
494
|
}
|
|
393
495
|
interface EnableRule {
|
|
394
496
|
/** Client and resource project enable type. */
|
|
395
|
-
enableType?:
|
|
497
|
+
enableType?:
|
|
498
|
+
string;
|
|
396
499
|
/**
|
|
397
500
|
* DEPRECATED: Please use field `values`. Service group should have prefix `groups/`. The names of the service groups that are enabled (Not Implemented). go/predefined-service-groups.
|
|
398
501
|
* Example: `groups/googleServices`.
|
|
399
502
|
*/
|
|
400
|
-
groups?:
|
|
503
|
+
groups?:
|
|
504
|
+
string[];
|
|
401
505
|
/** DEPRECATED: Please use field `values`. Service should have prefix `services/`. The names of the services that are enabled. Example: `storage.googleapis.com`. */
|
|
402
|
-
services?:
|
|
506
|
+
services?:
|
|
507
|
+
string[];
|
|
403
508
|
/** The names of the services or service groups that are enabled. Example: `services/storage.googleapis.com`, groups/googleServices`, groups/allServices`. */
|
|
404
|
-
values?:
|
|
509
|
+
values?:
|
|
510
|
+
string[];
|
|
405
511
|
}
|
|
406
512
|
// tslint:disable-next-line:no-empty-interface
|
|
407
513
|
interface EnableServiceRequest {
|
|
408
514
|
}
|
|
409
515
|
interface EnableServiceResponse {
|
|
410
516
|
/** The new state of the service after enabling. */
|
|
411
|
-
service?:
|
|
517
|
+
service?:
|
|
518
|
+
GoogleApiServiceusageV1Service;
|
|
412
519
|
}
|
|
413
520
|
interface Endpoint {
|
|
414
521
|
/**
|
|
415
522
|
* Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases.
|
|
416
523
|
* Additional names that this endpoint will be hosted on.
|
|
417
524
|
*/
|
|
418
|
-
aliases?:
|
|
525
|
+
aliases?:
|
|
526
|
+
string[];
|
|
419
527
|
/**
|
|
420
528
|
* Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to
|
|
421
529
|
* HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
|
|
422
530
|
*/
|
|
423
|
-
allowCors?:
|
|
531
|
+
allowCors?:
|
|
532
|
+
boolean;
|
|
424
533
|
/** The canonical name of this endpoint. */
|
|
425
|
-
name?:
|
|
534
|
+
name?:
|
|
535
|
+
string;
|
|
426
536
|
/**
|
|
427
537
|
* The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be
|
|
428
538
|
* either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
|
|
429
539
|
*/
|
|
430
|
-
target?:
|
|
540
|
+
target?:
|
|
541
|
+
string;
|
|
431
542
|
}
|
|
432
543
|
interface Enum {
|
|
433
544
|
/** The source edition string, only valid when syntax is SYNTAX_EDITIONS. */
|
|
434
|
-
edition?:
|
|
545
|
+
edition?:
|
|
546
|
+
string;
|
|
435
547
|
/** Enum value definitions. */
|
|
436
|
-
enumvalue?:
|
|
548
|
+
enumvalue?:
|
|
549
|
+
EnumValue[];
|
|
437
550
|
/** Enum type name. */
|
|
438
|
-
name?:
|
|
551
|
+
name?:
|
|
552
|
+
string;
|
|
439
553
|
/** Protocol buffer options. */
|
|
440
|
-
options?:
|
|
554
|
+
options?:
|
|
555
|
+
Option[];
|
|
441
556
|
/** The source context. */
|
|
442
|
-
sourceContext?:
|
|
557
|
+
sourceContext?:
|
|
558
|
+
SourceContext;
|
|
443
559
|
/** The source syntax. */
|
|
444
|
-
syntax?:
|
|
560
|
+
syntax?:
|
|
561
|
+
string;
|
|
445
562
|
}
|
|
446
563
|
interface EnumValue {
|
|
447
564
|
/** Enum value name. */
|
|
448
|
-
name?:
|
|
565
|
+
name?:
|
|
566
|
+
string;
|
|
449
567
|
/** Enum value number. */
|
|
450
|
-
number?:
|
|
568
|
+
number?:
|
|
569
|
+
number;
|
|
451
570
|
/** Protocol buffer options. */
|
|
452
|
-
options?:
|
|
571
|
+
options?:
|
|
572
|
+
Option[];
|
|
453
573
|
}
|
|
454
574
|
interface Field {
|
|
455
575
|
/** The field cardinality. */
|
|
456
|
-
cardinality?:
|
|
576
|
+
cardinality?:
|
|
577
|
+
string;
|
|
457
578
|
/** The string value of the default value of this field. Proto2 syntax only. */
|
|
458
|
-
defaultValue?:
|
|
579
|
+
defaultValue?:
|
|
580
|
+
string;
|
|
459
581
|
/** The field JSON name. */
|
|
460
|
-
jsonName?:
|
|
582
|
+
jsonName?:
|
|
583
|
+
string;
|
|
461
584
|
/** The field type. */
|
|
462
|
-
kind?:
|
|
585
|
+
kind?:
|
|
586
|
+
string;
|
|
463
587
|
/** The field name. */
|
|
464
|
-
name?:
|
|
588
|
+
name?:
|
|
589
|
+
string;
|
|
465
590
|
/** The field number. */
|
|
466
|
-
number?:
|
|
591
|
+
number?:
|
|
592
|
+
number;
|
|
467
593
|
/** The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. */
|
|
468
|
-
oneofIndex?:
|
|
594
|
+
oneofIndex?:
|
|
595
|
+
number;
|
|
469
596
|
/** The protocol buffer options. */
|
|
470
|
-
options?:
|
|
597
|
+
options?:
|
|
598
|
+
Option[];
|
|
471
599
|
/** Whether to use alternative packed wire representation. */
|
|
472
|
-
packed?:
|
|
600
|
+
packed?:
|
|
601
|
+
boolean;
|
|
473
602
|
/** The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. */
|
|
474
|
-
typeUrl?:
|
|
603
|
+
typeUrl?:
|
|
604
|
+
string;
|
|
475
605
|
}
|
|
476
606
|
// tslint:disable-next-line:no-empty-interface
|
|
477
607
|
interface GetServiceIdentityMetadata {
|
|
@@ -481,314 +611,412 @@ declare namespace gapi.client {
|
|
|
481
611
|
* Service identity that service producer can use to access consumer resources. If exists is true, it contains email and unique_id. If exists is false, it contains pre-constructed
|
|
482
612
|
* email and empty unique_id.
|
|
483
613
|
*/
|
|
484
|
-
identity?:
|
|
614
|
+
identity?:
|
|
615
|
+
ServiceIdentity;
|
|
485
616
|
/** Service identity state. */
|
|
486
|
-
state?:
|
|
617
|
+
state?:
|
|
618
|
+
string;
|
|
487
619
|
}
|
|
488
620
|
interface GoogleApiService {
|
|
489
621
|
/**
|
|
490
622
|
* A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be
|
|
491
623
|
* derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.
|
|
492
624
|
*/
|
|
493
|
-
apis?:
|
|
625
|
+
apis?:
|
|
626
|
+
Api[];
|
|
494
627
|
/** Auth configuration. */
|
|
495
|
-
authentication?:
|
|
628
|
+
authentication?:
|
|
629
|
+
Authentication;
|
|
496
630
|
/** API backend configuration. */
|
|
497
|
-
backend?:
|
|
631
|
+
backend?:
|
|
632
|
+
Backend;
|
|
498
633
|
/** Billing configuration. */
|
|
499
|
-
billing?:
|
|
634
|
+
billing?:
|
|
635
|
+
Billing;
|
|
500
636
|
/** Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`. */
|
|
501
|
-
configVersion?:
|
|
637
|
+
configVersion?:
|
|
638
|
+
number;
|
|
502
639
|
/** Context configuration. */
|
|
503
|
-
context?:
|
|
640
|
+
context?:
|
|
641
|
+
Context;
|
|
504
642
|
/** Configuration for the service control plane. */
|
|
505
|
-
control?:
|
|
643
|
+
control?:
|
|
644
|
+
Control;
|
|
506
645
|
/** Custom error configuration. */
|
|
507
|
-
customError?:
|
|
646
|
+
customError?:
|
|
647
|
+
CustomError;
|
|
508
648
|
/** Additional API documentation. */
|
|
509
|
-
documentation?:
|
|
649
|
+
documentation?:
|
|
650
|
+
Documentation;
|
|
510
651
|
/** Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. */
|
|
511
|
-
endpoints?:
|
|
652
|
+
endpoints?:
|
|
653
|
+
Endpoint[];
|
|
512
654
|
/**
|
|
513
655
|
* A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be
|
|
514
656
|
* included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum
|
|
515
657
|
*/
|
|
516
|
-
enums?:
|
|
658
|
+
enums?:
|
|
659
|
+
Enum[];
|
|
517
660
|
/** HTTP configuration. */
|
|
518
|
-
http?:
|
|
661
|
+
http?:
|
|
662
|
+
Http;
|
|
519
663
|
/**
|
|
520
664
|
* A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits,
|
|
521
665
|
* '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead.
|
|
522
666
|
*/
|
|
523
|
-
id?:
|
|
667
|
+
id?:
|
|
668
|
+
string;
|
|
524
669
|
/** Logging configuration. */
|
|
525
|
-
logging?:
|
|
670
|
+
logging?:
|
|
671
|
+
Logging;
|
|
526
672
|
/** Defines the logs used by this service. */
|
|
527
|
-
logs?:
|
|
673
|
+
logs?:
|
|
674
|
+
LogDescriptor[];
|
|
528
675
|
/** Defines the metrics used by this service. */
|
|
529
|
-
metrics?:
|
|
676
|
+
metrics?:
|
|
677
|
+
MetricDescriptor[];
|
|
530
678
|
/** Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. */
|
|
531
|
-
monitoredResources?:
|
|
679
|
+
monitoredResources?:
|
|
680
|
+
MonitoredResourceDescriptor[];
|
|
532
681
|
/** Monitoring configuration. */
|
|
533
|
-
monitoring?:
|
|
682
|
+
monitoring?:
|
|
683
|
+
Monitoring;
|
|
534
684
|
/**
|
|
535
685
|
* The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure
|
|
536
686
|
* the owner of the service also owns the DNS name.
|
|
537
687
|
*/
|
|
538
|
-
name?:
|
|
688
|
+
name?:
|
|
689
|
+
string;
|
|
539
690
|
/** The Google project that owns this service. */
|
|
540
|
-
producerProjectId?:
|
|
691
|
+
producerProjectId?:
|
|
692
|
+
string;
|
|
541
693
|
/** Settings for [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from APIs defined as protocol buffers. */
|
|
542
|
-
publishing?:
|
|
694
|
+
publishing?:
|
|
695
|
+
Publishing;
|
|
543
696
|
/** Quota configuration. */
|
|
544
|
-
quota?:
|
|
697
|
+
quota?:
|
|
698
|
+
Quota;
|
|
545
699
|
/** Output only. The source information for this configuration if available. */
|
|
546
|
-
sourceInfo?:
|
|
700
|
+
sourceInfo?:
|
|
701
|
+
SourceInfo;
|
|
547
702
|
/** System parameter configuration. */
|
|
548
|
-
systemParameters?:
|
|
703
|
+
systemParameters?:
|
|
704
|
+
SystemParameters;
|
|
549
705
|
/**
|
|
550
706
|
* A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs.
|
|
551
707
|
* Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
|
|
552
708
|
*/
|
|
553
|
-
systemTypes?:
|
|
709
|
+
systemTypes?:
|
|
710
|
+
Type[];
|
|
554
711
|
/** The product title for this service, it is the name displayed in Google Cloud Console. */
|
|
555
|
-
title?:
|
|
712
|
+
title?:
|
|
713
|
+
string;
|
|
556
714
|
/**
|
|
557
715
|
* A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced
|
|
558
716
|
* but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32
|
|
559
717
|
*/
|
|
560
|
-
types?:
|
|
718
|
+
types?:
|
|
719
|
+
Type[];
|
|
561
720
|
/** Configuration controlling usage of this service. */
|
|
562
|
-
usage?:
|
|
721
|
+
usage?:
|
|
722
|
+
Usage;
|
|
563
723
|
}
|
|
564
724
|
interface GoogleApiServiceusageV1beta1GetServiceIdentityResponse {
|
|
565
725
|
/**
|
|
566
726
|
* Service identity that service producer can use to access consumer resources. If exists is true, it contains email and unique_id. If exists is false, it contains pre-constructed
|
|
567
727
|
* email and empty unique_id.
|
|
568
728
|
*/
|
|
569
|
-
identity?:
|
|
729
|
+
identity?:
|
|
730
|
+
GoogleApiServiceusageV1beta1ServiceIdentity;
|
|
570
731
|
/** Service identity state. */
|
|
571
|
-
state?:
|
|
732
|
+
state?:
|
|
733
|
+
string;
|
|
572
734
|
}
|
|
573
735
|
interface GoogleApiServiceusageV1beta1ServiceIdentity {
|
|
574
736
|
/** The email address of the service account that a service producer would use to access consumer resources. */
|
|
575
|
-
email?:
|
|
737
|
+
email?:
|
|
738
|
+
string;
|
|
576
739
|
/** The unique and stable id of the service account. https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount */
|
|
577
|
-
uniqueId?:
|
|
740
|
+
uniqueId?:
|
|
741
|
+
string;
|
|
578
742
|
}
|
|
579
743
|
interface GoogleApiServiceusageV1OperationMetadata {
|
|
580
744
|
/** The full name of the resources that this operation is directly associated with. */
|
|
581
|
-
resourceNames?:
|
|
745
|
+
resourceNames?:
|
|
746
|
+
string[];
|
|
582
747
|
}
|
|
583
748
|
interface GoogleApiServiceusageV1Service {
|
|
584
749
|
/**
|
|
585
750
|
* The service configuration of the available service. Some fields may be filtered out of the configuration in responses to the `ListServices` method. These fields are present only in
|
|
586
751
|
* responses to the `GetService` method.
|
|
587
752
|
*/
|
|
588
|
-
config?:
|
|
753
|
+
config?:
|
|
754
|
+
GoogleApiServiceusageV1ServiceConfig;
|
|
589
755
|
/** The resource name of the consumer and service. A valid name would be: - projects/123/services/serviceusage.googleapis.com */
|
|
590
|
-
name?:
|
|
756
|
+
name?:
|
|
757
|
+
string;
|
|
591
758
|
/** The resource name of the consumer. A valid name would be: - projects/123 */
|
|
592
|
-
parent?:
|
|
759
|
+
parent?:
|
|
760
|
+
string;
|
|
593
761
|
/** Whether or not the service has been enabled for use by the consumer. */
|
|
594
|
-
state?:
|
|
762
|
+
state?:
|
|
763
|
+
string;
|
|
595
764
|
}
|
|
596
765
|
interface GoogleApiServiceusageV1ServiceConfig {
|
|
597
766
|
/** A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces. */
|
|
598
|
-
apis?:
|
|
767
|
+
apis?:
|
|
768
|
+
Api[];
|
|
599
769
|
/** Auth configuration. Contains only the OAuth rules. */
|
|
600
|
-
authentication?:
|
|
770
|
+
authentication?:
|
|
771
|
+
Authentication;
|
|
601
772
|
/** Additional API documentation. Contains only the summary and the documentation URL. */
|
|
602
|
-
documentation?:
|
|
773
|
+
documentation?:
|
|
774
|
+
Documentation;
|
|
603
775
|
/** Configuration for network endpoints. Contains only the names and aliases of the endpoints. */
|
|
604
|
-
endpoints?:
|
|
776
|
+
endpoints?:
|
|
777
|
+
Endpoint[];
|
|
605
778
|
/** Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. */
|
|
606
|
-
monitoredResources?:
|
|
779
|
+
monitoredResources?:
|
|
780
|
+
MonitoredResourceDescriptor[];
|
|
607
781
|
/** Monitoring configuration. This should not include the 'producer_destinations' field. */
|
|
608
|
-
monitoring?:
|
|
782
|
+
monitoring?:
|
|
783
|
+
Monitoring;
|
|
609
784
|
/** The DNS address at which this service is available. An example DNS address would be: `calendar.googleapis.com`. */
|
|
610
|
-
name?:
|
|
785
|
+
name?:
|
|
786
|
+
string;
|
|
611
787
|
/** Quota configuration. */
|
|
612
|
-
quota?:
|
|
788
|
+
quota?:
|
|
789
|
+
Quota;
|
|
613
790
|
/** The product title for this service. */
|
|
614
|
-
title?:
|
|
791
|
+
title?:
|
|
792
|
+
string;
|
|
615
793
|
/** Configuration controlling usage of this service. */
|
|
616
|
-
usage?:
|
|
794
|
+
usage?:
|
|
795
|
+
Usage;
|
|
617
796
|
}
|
|
618
797
|
interface GoSettings {
|
|
619
798
|
/** Some settings. */
|
|
620
|
-
common?:
|
|
799
|
+
common?:
|
|
800
|
+
CommonLanguageSettings;
|
|
621
801
|
}
|
|
622
802
|
interface Http {
|
|
623
803
|
/**
|
|
624
804
|
* When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default
|
|
625
805
|
* behavior is to not decode RFC 6570 reserved characters in multi segment matches.
|
|
626
806
|
*/
|
|
627
|
-
fullyDecodeReservedExpansion?:
|
|
807
|
+
fullyDecodeReservedExpansion?:
|
|
808
|
+
boolean;
|
|
628
809
|
/** A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */
|
|
629
|
-
rules?:
|
|
810
|
+
rules?:
|
|
811
|
+
HttpRule[];
|
|
630
812
|
}
|
|
631
813
|
interface HttpRule {
|
|
632
814
|
/** Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). */
|
|
633
|
-
additionalBindings?:
|
|
815
|
+
additionalBindings?:
|
|
816
|
+
HttpRule[];
|
|
634
817
|
/**
|
|
635
818
|
* The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for
|
|
636
819
|
* not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.
|
|
637
820
|
*/
|
|
638
|
-
body?:
|
|
821
|
+
body?:
|
|
822
|
+
string;
|
|
639
823
|
/**
|
|
640
824
|
* The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The
|
|
641
825
|
* wild-card rule is useful for services that provide content to Web (HTML) clients.
|
|
642
826
|
*/
|
|
643
|
-
custom?:
|
|
827
|
+
custom?:
|
|
828
|
+
CustomHttpPattern;
|
|
644
829
|
/** Maps to HTTP DELETE. Used for deleting a resource. */
|
|
645
|
-
delete?:
|
|
830
|
+
delete?:
|
|
831
|
+
string;
|
|
646
832
|
/** Maps to HTTP GET. Used for listing and getting information about resources. */
|
|
647
|
-
get?:
|
|
833
|
+
get?:
|
|
834
|
+
string;
|
|
648
835
|
/** Maps to HTTP PATCH. Used for updating a resource. */
|
|
649
|
-
patch?:
|
|
836
|
+
patch?:
|
|
837
|
+
string;
|
|
650
838
|
/** Maps to HTTP POST. Used for creating a resource or performing an action. */
|
|
651
|
-
post?:
|
|
839
|
+
post?:
|
|
840
|
+
string;
|
|
652
841
|
/** Maps to HTTP PUT. Used for replacing a resource. */
|
|
653
|
-
put?:
|
|
842
|
+
put?:
|
|
843
|
+
string;
|
|
654
844
|
/**
|
|
655
845
|
* Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The
|
|
656
846
|
* referred field must be present at the top-level of the response message type.
|
|
657
847
|
*/
|
|
658
|
-
responseBody?:
|
|
848
|
+
responseBody?:
|
|
849
|
+
string;
|
|
659
850
|
/** Selects a method to which this rule applies. Refer to selector for syntax details. */
|
|
660
|
-
selector?:
|
|
851
|
+
selector?:
|
|
852
|
+
string;
|
|
661
853
|
}
|
|
662
854
|
// tslint:disable-next-line:no-empty-interface
|
|
663
855
|
interface ImportAdminOverridesMetadata {
|
|
664
856
|
}
|
|
665
857
|
interface ImportAdminOverridesResponse {
|
|
666
858
|
/** The overrides that were created from the imported data. */
|
|
667
|
-
overrides?:
|
|
859
|
+
overrides?:
|
|
860
|
+
QuotaOverride[];
|
|
668
861
|
}
|
|
669
862
|
// tslint:disable-next-line:no-empty-interface
|
|
670
863
|
interface ImportAdminQuotaPoliciesMetadata {
|
|
671
864
|
}
|
|
672
865
|
interface ImportAdminQuotaPoliciesResponse {
|
|
673
866
|
/** The policies that were created from the imported data. */
|
|
674
|
-
policies?:
|
|
867
|
+
policies?:
|
|
868
|
+
AdminQuotaPolicy[];
|
|
675
869
|
}
|
|
676
870
|
// tslint:disable-next-line:no-empty-interface
|
|
677
871
|
interface ImportConsumerOverridesMetadata {
|
|
678
872
|
}
|
|
679
873
|
interface ImportConsumerOverridesResponse {
|
|
680
874
|
/** The overrides that were created from the imported data. */
|
|
681
|
-
overrides?:
|
|
875
|
+
overrides?:
|
|
876
|
+
QuotaOverride[];
|
|
682
877
|
}
|
|
683
878
|
interface JavaSettings {
|
|
684
879
|
/** Some settings. */
|
|
685
|
-
common?:
|
|
880
|
+
common?:
|
|
881
|
+
CommonLanguageSettings;
|
|
686
882
|
/**
|
|
687
883
|
* The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used **only** by APIs who have already set the
|
|
688
884
|
* language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing:
|
|
689
885
|
* java_settings: library_package: com.google.cloud.pubsub.v1
|
|
690
886
|
*/
|
|
691
|
-
libraryPackage?:
|
|
887
|
+
libraryPackage?:
|
|
888
|
+
string;
|
|
692
889
|
/**
|
|
693
890
|
* Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client. Keys are fully-qualified service names as they appear in the protobuf
|
|
694
891
|
* (including the full the language_settings.java.interface_names" field in gapic.yaml. API teams should otherwise use the service name as it appears in the protobuf. Example of a YAML
|
|
695
892
|
* configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin
|
|
696
893
|
*/
|
|
697
|
-
serviceClassNames?:
|
|
894
|
+
serviceClassNames?:
|
|
895
|
+
{ [P in string]: string };
|
|
698
896
|
}
|
|
699
897
|
interface JwtLocation {
|
|
700
898
|
/** Specifies cookie name to extract JWT token. */
|
|
701
|
-
cookie?:
|
|
899
|
+
cookie?:
|
|
900
|
+
string;
|
|
702
901
|
/** Specifies HTTP header name to extract JWT token. */
|
|
703
|
-
header?:
|
|
902
|
+
header?:
|
|
903
|
+
string;
|
|
704
904
|
/** Specifies URL query parameter name to extract JWT token. */
|
|
705
|
-
query?:
|
|
905
|
+
query?:
|
|
906
|
+
string;
|
|
706
907
|
/**
|
|
707
908
|
* The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case
|
|
708
909
|
* sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}",
|
|
709
910
|
* value_prefix="Bearer " with a space at the end.
|
|
710
911
|
*/
|
|
711
|
-
valuePrefix?:
|
|
912
|
+
valuePrefix?:
|
|
913
|
+
string;
|
|
712
914
|
}
|
|
713
915
|
interface LabelDescriptor {
|
|
714
916
|
/** A human-readable description for the label. */
|
|
715
|
-
description?:
|
|
917
|
+
description?:
|
|
918
|
+
string;
|
|
716
919
|
/** The label key. */
|
|
717
|
-
key?:
|
|
920
|
+
key?:
|
|
921
|
+
string;
|
|
718
922
|
/** The type of data that can be assigned to the label. */
|
|
719
|
-
valueType?:
|
|
923
|
+
valueType?:
|
|
924
|
+
string;
|
|
720
925
|
}
|
|
721
926
|
interface ListOperationsResponse {
|
|
722
927
|
/** The standard List next-page token. */
|
|
723
|
-
nextPageToken?:
|
|
928
|
+
nextPageToken?:
|
|
929
|
+
string;
|
|
724
930
|
/** A list of operations that matches the specified filter in the request. */
|
|
725
|
-
operations?:
|
|
931
|
+
operations?:
|
|
932
|
+
Operation[];
|
|
726
933
|
}
|
|
727
934
|
interface ListServicesResponse {
|
|
728
935
|
/** Token that can be passed to `ListServices` to resume a paginated query. */
|
|
729
|
-
nextPageToken?:
|
|
936
|
+
nextPageToken?:
|
|
937
|
+
string;
|
|
730
938
|
/** The available services for the requested project. */
|
|
731
|
-
services?:
|
|
939
|
+
services?:
|
|
940
|
+
GoogleApiServiceusageV1Service[];
|
|
732
941
|
}
|
|
733
942
|
interface LogDescriptor {
|
|
734
943
|
/** A human-readable description of this log. This information appears in the documentation and can contain details. */
|
|
735
|
-
description?:
|
|
944
|
+
description?:
|
|
945
|
+
string;
|
|
736
946
|
/** The human-readable name for this log. This information appears on the user interface and should be concise. */
|
|
737
|
-
displayName?:
|
|
947
|
+
displayName?:
|
|
948
|
+
string;
|
|
738
949
|
/** The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid. */
|
|
739
|
-
labels?:
|
|
950
|
+
labels?:
|
|
951
|
+
LabelDescriptor[];
|
|
740
952
|
/**
|
|
741
953
|
* The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation
|
|
742
954
|
* characters including slash, underscore, hyphen, period [/_-.].
|
|
743
955
|
*/
|
|
744
|
-
name?:
|
|
956
|
+
name?:
|
|
957
|
+
string;
|
|
745
958
|
}
|
|
746
959
|
interface Logging {
|
|
747
960
|
/**
|
|
748
961
|
* Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be
|
|
749
962
|
* used in at most one consumer destination.
|
|
750
963
|
*/
|
|
751
|
-
consumerDestinations?:
|
|
964
|
+
consumerDestinations?:
|
|
965
|
+
LoggingDestination[];
|
|
752
966
|
/**
|
|
753
967
|
* Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be
|
|
754
968
|
* used in at most one producer destination.
|
|
755
969
|
*/
|
|
756
|
-
producerDestinations?:
|
|
970
|
+
producerDestinations?:
|
|
971
|
+
LoggingDestination[];
|
|
757
972
|
}
|
|
758
973
|
interface LoggingDestination {
|
|
759
974
|
/**
|
|
760
975
|
* Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically
|
|
761
976
|
* prefixed with the service name followed by "/".
|
|
762
977
|
*/
|
|
763
|
-
logs?:
|
|
978
|
+
logs?:
|
|
979
|
+
string[];
|
|
764
980
|
/** The monitored resource type. The type must be defined in the Service.monitored_resources section. */
|
|
765
|
-
monitoredResource?:
|
|
981
|
+
monitoredResource?:
|
|
982
|
+
string;
|
|
766
983
|
}
|
|
767
984
|
interface LongRunning {
|
|
768
985
|
/** Initial delay after which the first poll request will be made. Default value: 5 seconds. */
|
|
769
|
-
initialPollDelay?:
|
|
986
|
+
initialPollDelay?:
|
|
987
|
+
string;
|
|
770
988
|
/** Maximum time between two subsequent poll requests. Default value: 45 seconds. */
|
|
771
|
-
maxPollDelay?:
|
|
989
|
+
maxPollDelay?:
|
|
990
|
+
string;
|
|
772
991
|
/** Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5. */
|
|
773
|
-
pollDelayMultiplier?:
|
|
992
|
+
pollDelayMultiplier?:
|
|
993
|
+
number;
|
|
774
994
|
/** Total polling timeout. Default value: 5 minutes. */
|
|
775
|
-
totalPollTimeout?:
|
|
995
|
+
totalPollTimeout?:
|
|
996
|
+
string;
|
|
776
997
|
}
|
|
777
998
|
interface Method {
|
|
778
999
|
/** The simple name of this method. */
|
|
779
|
-
name?:
|
|
1000
|
+
name?:
|
|
1001
|
+
string;
|
|
780
1002
|
/** Any metadata attached to the method. */
|
|
781
|
-
options?:
|
|
1003
|
+
options?:
|
|
1004
|
+
Option[];
|
|
782
1005
|
/** If true, the request is streamed. */
|
|
783
|
-
requestStreaming?:
|
|
1006
|
+
requestStreaming?:
|
|
1007
|
+
boolean;
|
|
784
1008
|
/** A URL of the input message type. */
|
|
785
|
-
requestTypeUrl?:
|
|
1009
|
+
requestTypeUrl?:
|
|
1010
|
+
string;
|
|
786
1011
|
/** If true, the response is streamed. */
|
|
787
|
-
responseStreaming?:
|
|
1012
|
+
responseStreaming?:
|
|
1013
|
+
boolean;
|
|
788
1014
|
/** The URL of the output message type. */
|
|
789
|
-
responseTypeUrl?:
|
|
1015
|
+
responseTypeUrl?:
|
|
1016
|
+
string;
|
|
790
1017
|
/** The source syntax of this method. */
|
|
791
|
-
syntax?:
|
|
1018
|
+
syntax?:
|
|
1019
|
+
string;
|
|
792
1020
|
}
|
|
793
1021
|
interface MethodSettings {
|
|
794
1022
|
/**
|
|
@@ -796,42 +1024,53 @@ declare namespace gapi.client {
|
|
|
796
1024
|
* of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute
|
|
797
1025
|
* poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
|
|
798
1026
|
*/
|
|
799
|
-
longRunning?:
|
|
1027
|
+
longRunning?:
|
|
1028
|
+
LongRunning;
|
|
800
1029
|
/** The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options. */
|
|
801
|
-
selector?:
|
|
1030
|
+
selector?:
|
|
1031
|
+
string;
|
|
802
1032
|
}
|
|
803
1033
|
interface MetricDescriptor {
|
|
804
1034
|
/** A detailed description of the metric, which can be used in documentation. */
|
|
805
|
-
description?:
|
|
1035
|
+
description?:
|
|
1036
|
+
string;
|
|
806
1037
|
/**
|
|
807
1038
|
* A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is
|
|
808
1039
|
* recommended to be set for any metrics associated with user-visible concepts, such as Quota.
|
|
809
1040
|
*/
|
|
810
|
-
displayName?:
|
|
1041
|
+
displayName?:
|
|
1042
|
+
string;
|
|
811
1043
|
/**
|
|
812
1044
|
* The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a
|
|
813
1045
|
* label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.
|
|
814
1046
|
*/
|
|
815
|
-
labels?:
|
|
1047
|
+
labels?:
|
|
1048
|
+
LabelDescriptor[];
|
|
816
1049
|
/** Optional. The launch stage of the metric definition. */
|
|
817
|
-
launchStage?:
|
|
1050
|
+
launchStage?:
|
|
1051
|
+
string;
|
|
818
1052
|
/** Optional. Metadata which can be used to guide usage of the metric. */
|
|
819
|
-
metadata?:
|
|
1053
|
+
metadata?:
|
|
1054
|
+
MetricDescriptorMetadata;
|
|
820
1055
|
/** Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */
|
|
821
|
-
metricKind?:
|
|
1056
|
+
metricKind?:
|
|
1057
|
+
string;
|
|
822
1058
|
/**
|
|
823
1059
|
* Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be
|
|
824
1060
|
* associated with one of the monitored resource types listed here.
|
|
825
1061
|
*/
|
|
826
|
-
monitoredResourceTypes?:
|
|
1062
|
+
monitoredResourceTypes?:
|
|
1063
|
+
string[];
|
|
827
1064
|
/** The resource name of the metric descriptor. */
|
|
828
|
-
name?:
|
|
1065
|
+
name?:
|
|
1066
|
+
string;
|
|
829
1067
|
/**
|
|
830
1068
|
* The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`.
|
|
831
1069
|
* Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up"
|
|
832
1070
|
* "appengine.googleapis.com/http/server/response_latencies"
|
|
833
1071
|
*/
|
|
834
|
-
type?:
|
|
1072
|
+
type?:
|
|
1073
|
+
string;
|
|
835
1074
|
/**
|
|
836
1075
|
* The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the
|
|
837
1076
|
* stored metric values. Different systems might scale the values to be more easily displayed (so a value of `0.02kBy` _might_ be displayed as `20By`, and a value of `3523kBy` _might_
|
|
@@ -854,62 +1093,77 @@ declare namespace gapi.client {
|
|
|
854
1093
|
* giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means "3 percent"). * `10^2.%` indicates a metric contains a ratio, typically
|
|
855
1094
|
* in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means "3 percent").
|
|
856
1095
|
*/
|
|
857
|
-
unit?:
|
|
1096
|
+
unit?:
|
|
1097
|
+
string;
|
|
858
1098
|
/** Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */
|
|
859
|
-
valueType?:
|
|
1099
|
+
valueType?:
|
|
1100
|
+
string;
|
|
860
1101
|
}
|
|
861
1102
|
interface MetricDescriptorMetadata {
|
|
862
1103
|
/** The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. */
|
|
863
|
-
ingestDelay?:
|
|
1104
|
+
ingestDelay?:
|
|
1105
|
+
string;
|
|
864
1106
|
/** Deprecated. Must use the MetricDescriptor.launch_stage instead. */
|
|
865
|
-
launchStage?:
|
|
1107
|
+
launchStage?:
|
|
1108
|
+
string;
|
|
866
1109
|
/**
|
|
867
1110
|
* The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors.
|
|
868
1111
|
* Metrics with a higher granularity have a smaller sampling period.
|
|
869
1112
|
*/
|
|
870
|
-
samplePeriod?:
|
|
1113
|
+
samplePeriod?:
|
|
1114
|
+
string;
|
|
871
1115
|
}
|
|
872
1116
|
interface MetricRule {
|
|
873
1117
|
/**
|
|
874
1118
|
* Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount
|
|
875
1119
|
* increased for the metric against which the quota limits are defined. The value must not be negative.
|
|
876
1120
|
*/
|
|
877
|
-
metricCosts?:
|
|
1121
|
+
metricCosts?:
|
|
1122
|
+
{ [P in string]: string };
|
|
878
1123
|
/** Selects the methods to which this rule applies. Refer to selector for syntax details. */
|
|
879
|
-
selector?:
|
|
1124
|
+
selector?:
|
|
1125
|
+
string;
|
|
880
1126
|
}
|
|
881
1127
|
interface Mixin {
|
|
882
1128
|
/** The fully qualified name of the interface which is included. */
|
|
883
|
-
name?:
|
|
1129
|
+
name?:
|
|
1130
|
+
string;
|
|
884
1131
|
/** If non-empty specifies a path under which inherited HTTP paths are rooted. */
|
|
885
|
-
root?:
|
|
1132
|
+
root?:
|
|
1133
|
+
string;
|
|
886
1134
|
}
|
|
887
1135
|
interface MonitoredResourceDescriptor {
|
|
888
1136
|
/** Optional. A detailed description of the monitored resource type that might be used in documentation. */
|
|
889
|
-
description?:
|
|
1137
|
+
description?:
|
|
1138
|
+
string;
|
|
890
1139
|
/**
|
|
891
1140
|
* Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other
|
|
892
1141
|
* determiners. For example, `"Google Cloud SQL Database"`.
|
|
893
1142
|
*/
|
|
894
|
-
displayName?:
|
|
1143
|
+
displayName?:
|
|
1144
|
+
string;
|
|
895
1145
|
/**
|
|
896
1146
|
* Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels
|
|
897
1147
|
* `"database_id"` and `"zone"`.
|
|
898
1148
|
*/
|
|
899
|
-
labels?:
|
|
1149
|
+
labels?:
|
|
1150
|
+
LabelDescriptor[];
|
|
900
1151
|
/** Optional. The launch stage of the monitored resource definition. */
|
|
901
|
-
launchStage?:
|
|
1152
|
+
launchStage?:
|
|
1153
|
+
string;
|
|
902
1154
|
/**
|
|
903
1155
|
* Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this
|
|
904
1156
|
* object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format
|
|
905
1157
|
* `"monitoredResourceDescriptors/{type}"`.
|
|
906
1158
|
*/
|
|
907
|
-
name?:
|
|
1159
|
+
name?:
|
|
1160
|
+
string;
|
|
908
1161
|
/**
|
|
909
1162
|
* Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. For a list of types, see [Monitoring resource
|
|
910
1163
|
* types](https://cloud.google.com/monitoring/api/resources) and [Logging resource types](https://cloud.google.com/logging/docs/api/v2/resource-list).
|
|
911
1164
|
*/
|
|
912
|
-
type?:
|
|
1165
|
+
type?:
|
|
1166
|
+
string;
|
|
913
1167
|
}
|
|
914
1168
|
interface Monitoring {
|
|
915
1169
|
/**
|
|
@@ -917,122 +1171,153 @@ declare namespace gapi.client {
|
|
|
917
1171
|
* destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used
|
|
918
1172
|
* once in the Monitoring configuration.
|
|
919
1173
|
*/
|
|
920
|
-
consumerDestinations?:
|
|
1174
|
+
consumerDestinations?:
|
|
1175
|
+
MonitoringDestination[];
|
|
921
1176
|
/**
|
|
922
1177
|
* Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring
|
|
923
1178
|
* destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used
|
|
924
1179
|
* once in the Monitoring configuration.
|
|
925
1180
|
*/
|
|
926
|
-
producerDestinations?:
|
|
1181
|
+
producerDestinations?:
|
|
1182
|
+
MonitoringDestination[];
|
|
927
1183
|
}
|
|
928
1184
|
interface MonitoringDestination {
|
|
929
1185
|
/** Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section. */
|
|
930
|
-
metrics?:
|
|
1186
|
+
metrics?:
|
|
1187
|
+
string[];
|
|
931
1188
|
/** The monitored resource type. The type must be defined in Service.monitored_resources section. */
|
|
932
|
-
monitoredResource?:
|
|
1189
|
+
monitoredResource?:
|
|
1190
|
+
string;
|
|
933
1191
|
}
|
|
934
1192
|
interface NodeSettings {
|
|
935
1193
|
/** Some settings. */
|
|
936
|
-
common?:
|
|
1194
|
+
common?:
|
|
1195
|
+
CommonLanguageSettings;
|
|
937
1196
|
}
|
|
938
1197
|
interface OAuthRequirements {
|
|
939
1198
|
/**
|
|
940
1199
|
* The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes:
|
|
941
1200
|
* https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
|
|
942
1201
|
*/
|
|
943
|
-
canonicalScopes?:
|
|
1202
|
+
canonicalScopes?:
|
|
1203
|
+
string;
|
|
944
1204
|
}
|
|
945
1205
|
interface Operation {
|
|
946
1206
|
/** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
|
|
947
|
-
done?:
|
|
1207
|
+
done?:
|
|
1208
|
+
boolean;
|
|
948
1209
|
/** The error result of the operation in case of failure or cancellation. */
|
|
949
|
-
error?:
|
|
1210
|
+
error?:
|
|
1211
|
+
Status;
|
|
950
1212
|
/**
|
|
951
1213
|
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such
|
|
952
1214
|
* metadata. Any method that returns a long-running operation should document the metadata type, if any.
|
|
953
1215
|
*/
|
|
954
|
-
metadata?:
|
|
1216
|
+
metadata?:
|
|
1217
|
+
{ [P in string]: any };
|
|
955
1218
|
/**
|
|
956
1219
|
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending
|
|
957
1220
|
* with `operations/{unique_id}`.
|
|
958
1221
|
*/
|
|
959
|
-
name?:
|
|
1222
|
+
name?:
|
|
1223
|
+
string;
|
|
960
1224
|
/**
|
|
961
1225
|
* The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the
|
|
962
1226
|
* original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the
|
|
963
1227
|
* original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
|
|
964
1228
|
*/
|
|
965
|
-
response?:
|
|
1229
|
+
response?:
|
|
1230
|
+
{ [P in string]: any };
|
|
966
1231
|
}
|
|
967
1232
|
interface OperationMetadata {
|
|
968
1233
|
/** The full name of the resources that this operation is directly associated with. */
|
|
969
|
-
resourceNames?:
|
|
1234
|
+
resourceNames?:
|
|
1235
|
+
string[];
|
|
970
1236
|
}
|
|
971
1237
|
interface Option {
|
|
972
1238
|
/**
|
|
973
1239
|
* The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the
|
|
974
1240
|
* fully-qualified name. For example, `"google.api.http"`.
|
|
975
1241
|
*/
|
|
976
|
-
name?:
|
|
1242
|
+
name?:
|
|
1243
|
+
string;
|
|
977
1244
|
/**
|
|
978
1245
|
* The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an
|
|
979
1246
|
* enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
|
|
980
1247
|
*/
|
|
981
|
-
value?:
|
|
1248
|
+
value?:
|
|
1249
|
+
{ [P in string]: any };
|
|
982
1250
|
}
|
|
983
1251
|
interface Page {
|
|
984
1252
|
/**
|
|
985
1253
|
* The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML
|
|
986
1254
|
* format page.
|
|
987
1255
|
*/
|
|
988
|
-
content?:
|
|
1256
|
+
content?:
|
|
1257
|
+
string;
|
|
989
1258
|
/**
|
|
990
1259
|
* The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the
|
|
991
1260
|
* root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md
|
|
992
1261
|
* ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`.
|
|
993
1262
|
*/
|
|
994
|
-
name?:
|
|
1263
|
+
name?:
|
|
1264
|
+
string;
|
|
995
1265
|
/** Subpages of this page. The order of subpages specified here will be honored in the generated docset. */
|
|
996
|
-
subpages?:
|
|
1266
|
+
subpages?:
|
|
1267
|
+
Page[];
|
|
997
1268
|
}
|
|
998
1269
|
interface PhpSettings {
|
|
999
1270
|
/** Some settings. */
|
|
1000
|
-
common?:
|
|
1271
|
+
common?:
|
|
1272
|
+
CommonLanguageSettings;
|
|
1001
1273
|
}
|
|
1002
1274
|
interface Publishing {
|
|
1003
1275
|
/** Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech". */
|
|
1004
|
-
apiShortName?:
|
|
1276
|
+
apiShortName?:
|
|
1277
|
+
string;
|
|
1005
1278
|
/** GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API. */
|
|
1006
|
-
codeownerGithubTeams?:
|
|
1279
|
+
codeownerGithubTeams?:
|
|
1280
|
+
string[];
|
|
1007
1281
|
/** A prefix used in sample code when demarking regions to be included in documentation. */
|
|
1008
|
-
docTagPrefix?:
|
|
1282
|
+
docTagPrefix?:
|
|
1283
|
+
string;
|
|
1009
1284
|
/** Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview */
|
|
1010
|
-
documentationUri?:
|
|
1285
|
+
documentationUri?:
|
|
1286
|
+
string;
|
|
1011
1287
|
/** GitHub label to apply to issues and pull requests opened for this API. */
|
|
1012
|
-
githubLabel?:
|
|
1288
|
+
githubLabel?:
|
|
1289
|
+
string;
|
|
1013
1290
|
/**
|
|
1014
1291
|
* Client library settings. If the same version string appears multiple times in this list, then the last one wins. Settings from earlier settings with the same version string are
|
|
1015
1292
|
* discarded.
|
|
1016
1293
|
*/
|
|
1017
|
-
librarySettings?:
|
|
1294
|
+
librarySettings?:
|
|
1295
|
+
ClientLibrarySettings[];
|
|
1018
1296
|
/** A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern. */
|
|
1019
|
-
methodSettings?:
|
|
1297
|
+
methodSettings?:
|
|
1298
|
+
MethodSettings[];
|
|
1020
1299
|
/** Link to a *public* URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103 */
|
|
1021
|
-
newIssueUri?:
|
|
1300
|
+
newIssueUri?:
|
|
1301
|
+
string;
|
|
1022
1302
|
/** For whom the client library is being published. */
|
|
1023
|
-
organization?:
|
|
1303
|
+
organization?:
|
|
1304
|
+
string;
|
|
1024
1305
|
/** Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc */
|
|
1025
|
-
protoReferenceDocumentationUri?:
|
|
1306
|
+
protoReferenceDocumentationUri?:
|
|
1307
|
+
string;
|
|
1026
1308
|
}
|
|
1027
1309
|
interface PythonSettings {
|
|
1028
1310
|
/** Some settings. */
|
|
1029
|
-
common?:
|
|
1311
|
+
common?:
|
|
1312
|
+
CommonLanguageSettings;
|
|
1030
1313
|
}
|
|
1031
1314
|
interface Quota {
|
|
1032
1315
|
/** List of QuotaLimit definitions for the service. */
|
|
1033
|
-
limits?:
|
|
1316
|
+
limits?:
|
|
1317
|
+
QuotaLimit[];
|
|
1034
1318
|
/** List of MetricRule definitions, each one mapping a selected method to one or more metrics. */
|
|
1035
|
-
metricRules?:
|
|
1319
|
+
metricRules?:
|
|
1320
|
+
MetricRule[];
|
|
1036
1321
|
}
|
|
1037
1322
|
interface QuotaLimit {
|
|
1038
1323
|
/**
|
|
@@ -1040,55 +1325,66 @@ declare namespace gapi.client {
|
|
|
1040
1325
|
* his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1
|
|
1041
1326
|
* will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.
|
|
1042
1327
|
*/
|
|
1043
|
-
defaultLimit?:
|
|
1328
|
+
defaultLimit?:
|
|
1329
|
+
string;
|
|
1044
1330
|
/**
|
|
1045
1331
|
* Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name
|
|
1046
1332
|
* (see: `display_name`).
|
|
1047
1333
|
*/
|
|
1048
|
-
description?:
|
|
1334
|
+
description?:
|
|
1335
|
+
string;
|
|
1049
1336
|
/**
|
|
1050
1337
|
* User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the
|
|
1051
1338
|
* default display name generated from the configuration.
|
|
1052
1339
|
*/
|
|
1053
|
-
displayName?:
|
|
1340
|
+
displayName?:
|
|
1341
|
+
string;
|
|
1054
1342
|
/** Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only. */
|
|
1055
|
-
duration?:
|
|
1343
|
+
duration?:
|
|
1344
|
+
string;
|
|
1056
1345
|
/**
|
|
1057
1346
|
* Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled.
|
|
1058
1347
|
* This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is
|
|
1059
1348
|
* no free tier for this service. Used by group-based quotas only.
|
|
1060
1349
|
*/
|
|
1061
|
-
freeTier?:
|
|
1350
|
+
freeTier?:
|
|
1351
|
+
string;
|
|
1062
1352
|
/**
|
|
1063
1353
|
* Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this
|
|
1064
1354
|
* value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to
|
|
1065
1355
|
* -1, indicating unlimited maximum quota. Used by group-based quotas only.
|
|
1066
1356
|
*/
|
|
1067
|
-
maxLimit?:
|
|
1357
|
+
maxLimit?:
|
|
1358
|
+
string;
|
|
1068
1359
|
/**
|
|
1069
1360
|
* The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service
|
|
1070
1361
|
* config.
|
|
1071
1362
|
*/
|
|
1072
|
-
metric?:
|
|
1363
|
+
metric?:
|
|
1364
|
+
string;
|
|
1073
1365
|
/**
|
|
1074
1366
|
* Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of
|
|
1075
1367
|
* the limit name is 64 characters.
|
|
1076
1368
|
*/
|
|
1077
|
-
name?:
|
|
1369
|
+
name?:
|
|
1370
|
+
string;
|
|
1078
1371
|
/**
|
|
1079
1372
|
* Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: *
|
|
1080
1373
|
* "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.
|
|
1081
1374
|
*/
|
|
1082
|
-
unit?:
|
|
1375
|
+
unit?:
|
|
1376
|
+
string;
|
|
1083
1377
|
/**
|
|
1084
1378
|
* Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD
|
|
1085
1379
|
* is supported.
|
|
1086
1380
|
*/
|
|
1087
|
-
values?:
|
|
1381
|
+
values?:
|
|
1382
|
+
{ [P in string]: string };
|
|
1088
1383
|
}
|
|
1089
1384
|
interface QuotaOverride {
|
|
1090
1385
|
/** The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. */
|
|
1091
|
-
adminOverrideAncestor?:
|
|
1386
|
+
adminOverrideAncestor?:
|
|
1387
|
+
string;
|
|
1092
1388
|
/**
|
|
1093
1389
|
* If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit
|
|
1094
1390
|
* `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the
|
|
@@ -1097,69 +1393,87 @@ declare namespace gapi.client {
|
|
|
1097
1393
|
* apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any
|
|
1098
1394
|
* valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map.
|
|
1099
1395
|
*/
|
|
1100
|
-
dimensions?:
|
|
1396
|
+
dimensions?:
|
|
1397
|
+
{ [P in string]: string };
|
|
1101
1398
|
/** The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` */
|
|
1102
|
-
metric?:
|
|
1399
|
+
metric?:
|
|
1400
|
+
string;
|
|
1103
1401
|
/**
|
|
1104
1402
|
* The resource name of the override. This name is generated by the server when the override is created. Example names would be:
|
|
1105
1403
|
* `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
|
|
1106
1404
|
* `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` The resource name is intended
|
|
1107
1405
|
* to be opaque and should not be parsed for its component strings, since its representation could change in the future.
|
|
1108
1406
|
*/
|
|
1109
|
-
name?:
|
|
1407
|
+
name?:
|
|
1408
|
+
string;
|
|
1110
1409
|
/** The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota). */
|
|
1111
|
-
overrideValue?:
|
|
1410
|
+
overrideValue?:
|
|
1411
|
+
string;
|
|
1112
1412
|
/**
|
|
1113
1413
|
* The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this
|
|
1114
1414
|
* example; the literal characters `{` and `}` occur in the string.
|
|
1115
1415
|
*/
|
|
1116
|
-
unit?:
|
|
1416
|
+
unit?:
|
|
1417
|
+
string;
|
|
1117
1418
|
}
|
|
1118
1419
|
interface RubySettings {
|
|
1119
1420
|
/** Some settings. */
|
|
1120
|
-
common?:
|
|
1421
|
+
common?:
|
|
1422
|
+
CommonLanguageSettings;
|
|
1121
1423
|
}
|
|
1122
1424
|
interface ServiceIdentity {
|
|
1123
1425
|
/** The email address of the service account that a service producer would use to access consumer resources. */
|
|
1124
|
-
email?:
|
|
1426
|
+
email?:
|
|
1427
|
+
string;
|
|
1125
1428
|
/** The unique and stable id of the service account. https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount */
|
|
1126
|
-
uniqueId?:
|
|
1429
|
+
uniqueId?:
|
|
1430
|
+
string;
|
|
1127
1431
|
}
|
|
1128
1432
|
interface SourceContext {
|
|
1129
1433
|
/** The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`. */
|
|
1130
|
-
fileName?:
|
|
1434
|
+
fileName?:
|
|
1435
|
+
string;
|
|
1131
1436
|
}
|
|
1132
1437
|
interface SourceInfo {
|
|
1133
1438
|
/** All files used during config generation. */
|
|
1134
|
-
sourceFiles?:
|
|
1439
|
+
sourceFiles?:
|
|
1440
|
+
Array<{ [P in string]: any }>;
|
|
1135
1441
|
}
|
|
1136
1442
|
interface Status {
|
|
1137
1443
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
1138
|
-
code?:
|
|
1444
|
+
code?:
|
|
1445
|
+
number;
|
|
1139
1446
|
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
1140
|
-
details?:
|
|
1447
|
+
details?:
|
|
1448
|
+
Array<{ [P in string]: any }>;
|
|
1141
1449
|
/**
|
|
1142
1450
|
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the
|
|
1143
1451
|
* client.
|
|
1144
1452
|
*/
|
|
1145
|
-
message?:
|
|
1453
|
+
message?:
|
|
1454
|
+
string;
|
|
1146
1455
|
}
|
|
1147
1456
|
interface SystemParameter {
|
|
1148
1457
|
/** Define the HTTP header name to use for the parameter. It is case insensitive. */
|
|
1149
|
-
httpHeader?:
|
|
1458
|
+
httpHeader?:
|
|
1459
|
+
string;
|
|
1150
1460
|
/** Define the name of the parameter, such as "api_key" . It is case sensitive. */
|
|
1151
|
-
name?:
|
|
1461
|
+
name?:
|
|
1462
|
+
string;
|
|
1152
1463
|
/** Define the URL query parameter name to use for the parameter. It is case sensitive. */
|
|
1153
|
-
urlQueryParameter?:
|
|
1464
|
+
urlQueryParameter?:
|
|
1465
|
+
string;
|
|
1154
1466
|
}
|
|
1155
1467
|
interface SystemParameterRule {
|
|
1156
1468
|
/**
|
|
1157
1469
|
* Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is
|
|
1158
1470
|
* implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
|
|
1159
1471
|
*/
|
|
1160
|
-
parameters?:
|
|
1472
|
+
parameters?:
|
|
1473
|
+
SystemParameter[];
|
|
1161
1474
|
/** Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */
|
|
1162
|
-
selector?:
|
|
1475
|
+
selector?:
|
|
1476
|
+
string;
|
|
1163
1477
|
}
|
|
1164
1478
|
interface SystemParameters {
|
|
1165
1479
|
/**
|
|
@@ -1168,23 +1482,31 @@ declare namespace gapi.client {
|
|
|
1168
1482
|
* parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: -
|
|
1169
1483
|
* name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:** All service configuration rules follow "last one wins" order.
|
|
1170
1484
|
*/
|
|
1171
|
-
rules?:
|
|
1485
|
+
rules?:
|
|
1486
|
+
SystemParameterRule[];
|
|
1172
1487
|
}
|
|
1173
1488
|
interface Type {
|
|
1174
1489
|
/** The source edition string, only valid when syntax is SYNTAX_EDITIONS. */
|
|
1175
|
-
edition?:
|
|
1490
|
+
edition?:
|
|
1491
|
+
string;
|
|
1176
1492
|
/** The list of fields. */
|
|
1177
|
-
fields?:
|
|
1493
|
+
fields?:
|
|
1494
|
+
Field[];
|
|
1178
1495
|
/** The fully qualified message name. */
|
|
1179
|
-
name?:
|
|
1496
|
+
name?:
|
|
1497
|
+
string;
|
|
1180
1498
|
/** The list of types appearing in `oneof` definitions in this type. */
|
|
1181
|
-
oneofs?:
|
|
1499
|
+
oneofs?:
|
|
1500
|
+
string[];
|
|
1182
1501
|
/** The protocol buffer options. */
|
|
1183
|
-
options?:
|
|
1502
|
+
options?:
|
|
1503
|
+
Option[];
|
|
1184
1504
|
/** The source context. */
|
|
1185
|
-
sourceContext?:
|
|
1505
|
+
sourceContext?:
|
|
1506
|
+
SourceContext;
|
|
1186
1507
|
/** The source syntax. */
|
|
1187
|
-
syntax?:
|
|
1508
|
+
syntax?:
|
|
1509
|
+
string;
|
|
1188
1510
|
}
|
|
1189
1511
|
// tslint:disable-next-line:no-empty-interface
|
|
1190
1512
|
interface UpdateAdminQuotaPolicyMetadata {
|
|
@@ -1198,26 +1520,32 @@ declare namespace gapi.client {
|
|
|
1198
1520
|
* Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud
|
|
1199
1521
|
* Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.
|
|
1200
1522
|
*/
|
|
1201
|
-
producerNotificationChannel?:
|
|
1523
|
+
producerNotificationChannel?:
|
|
1524
|
+
string;
|
|
1202
1525
|
/**
|
|
1203
1526
|
* Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'. For
|
|
1204
1527
|
* Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include
|
|
1205
1528
|
* "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.
|
|
1206
1529
|
*/
|
|
1207
|
-
requirements?:
|
|
1530
|
+
requirements?:
|
|
1531
|
+
string[];
|
|
1208
1532
|
/** A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */
|
|
1209
|
-
rules?:
|
|
1533
|
+
rules?:
|
|
1534
|
+
UsageRule[];
|
|
1210
1535
|
}
|
|
1211
1536
|
interface UsageRule {
|
|
1212
1537
|
/** If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. */
|
|
1213
|
-
allowUnregisteredCalls?:
|
|
1538
|
+
allowUnregisteredCalls?:
|
|
1539
|
+
boolean;
|
|
1214
1540
|
/** Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */
|
|
1215
|
-
selector?:
|
|
1541
|
+
selector?:
|
|
1542
|
+
string;
|
|
1216
1543
|
/**
|
|
1217
1544
|
* If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud
|
|
1218
1545
|
* Endpoints to bypass checks for internal methods, such as service health check methods.
|
|
1219
1546
|
*/
|
|
1220
|
-
skipServiceControl?:
|
|
1547
|
+
skipServiceControl?:
|
|
1548
|
+
boolean;
|
|
1221
1549
|
}
|
|
1222
1550
|
interface OperationsResource {
|
|
1223
1551
|
/**
|
|
@@ -1228,57 +1556,82 @@ declare namespace gapi.client {
|
|
|
1228
1556
|
*/
|
|
1229
1557
|
cancel(request: {
|
|
1230
1558
|
/** V1 error format. */
|
|
1231
|
-
"$.xgafv"?:
|
|
1559
|
+
"$.xgafv"?:
|
|
1560
|
+
string;
|
|
1232
1561
|
/** OAuth access token. */
|
|
1233
|
-
access_token?:
|
|
1562
|
+
access_token?:
|
|
1563
|
+
string;
|
|
1234
1564
|
/** Data format for response. */
|
|
1235
|
-
alt?:
|
|
1565
|
+
alt?:
|
|
1566
|
+
string;
|
|
1236
1567
|
/** JSONP */
|
|
1237
|
-
callback?:
|
|
1568
|
+
callback?:
|
|
1569
|
+
string;
|
|
1238
1570
|
/** Selector specifying which fields to include in a partial response. */
|
|
1239
|
-
fields?:
|
|
1571
|
+
fields?:
|
|
1572
|
+
string;
|
|
1240
1573
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1241
|
-
key?:
|
|
1574
|
+
key?:
|
|
1575
|
+
string;
|
|
1242
1576
|
/** The name of the operation resource to be cancelled. */
|
|
1243
|
-
name:
|
|
1577
|
+
name:
|
|
1578
|
+
string;
|
|
1244
1579
|
/** OAuth 2.0 token for the current user. */
|
|
1245
|
-
oauth_token?:
|
|
1580
|
+
oauth_token?:
|
|
1581
|
+
string;
|
|
1246
1582
|
/** Returns response with indentations and line breaks. */
|
|
1247
|
-
prettyPrint?:
|
|
1583
|
+
prettyPrint?:
|
|
1584
|
+
boolean;
|
|
1248
1585
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1249
|
-
quotaUser?:
|
|
1586
|
+
quotaUser?:
|
|
1587
|
+
string;
|
|
1250
1588
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1251
|
-
upload_protocol?:
|
|
1589
|
+
upload_protocol?:
|
|
1590
|
+
string;
|
|
1252
1591
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1253
|
-
uploadType?:
|
|
1592
|
+
uploadType?:
|
|
1593
|
+
string;
|
|
1254
1594
|
/** Request body */
|
|
1255
|
-
resource:
|
|
1595
|
+
resource:
|
|
1596
|
+
CancelOperationRequest;
|
|
1256
1597
|
}): Request<{}>;
|
|
1257
1598
|
cancel(request: {
|
|
1258
1599
|
/** V1 error format. */
|
|
1259
|
-
"$.xgafv"?:
|
|
1600
|
+
"$.xgafv"?:
|
|
1601
|
+
string;
|
|
1260
1602
|
/** OAuth access token. */
|
|
1261
|
-
access_token?:
|
|
1603
|
+
access_token?:
|
|
1604
|
+
string;
|
|
1262
1605
|
/** Data format for response. */
|
|
1263
|
-
alt?:
|
|
1606
|
+
alt?:
|
|
1607
|
+
string;
|
|
1264
1608
|
/** JSONP */
|
|
1265
|
-
callback?:
|
|
1609
|
+
callback?:
|
|
1610
|
+
string;
|
|
1266
1611
|
/** Selector specifying which fields to include in a partial response. */
|
|
1267
|
-
fields?:
|
|
1612
|
+
fields?:
|
|
1613
|
+
string;
|
|
1268
1614
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1269
|
-
key?:
|
|
1615
|
+
key?:
|
|
1616
|
+
string;
|
|
1270
1617
|
/** The name of the operation resource to be cancelled. */
|
|
1271
|
-
name:
|
|
1618
|
+
name:
|
|
1619
|
+
string;
|
|
1272
1620
|
/** OAuth 2.0 token for the current user. */
|
|
1273
|
-
oauth_token?:
|
|
1621
|
+
oauth_token?:
|
|
1622
|
+
string;
|
|
1274
1623
|
/** Returns response with indentations and line breaks. */
|
|
1275
|
-
prettyPrint?:
|
|
1624
|
+
prettyPrint?:
|
|
1625
|
+
boolean;
|
|
1276
1626
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1277
|
-
quotaUser?:
|
|
1627
|
+
quotaUser?:
|
|
1628
|
+
string;
|
|
1278
1629
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1279
|
-
upload_protocol?:
|
|
1630
|
+
upload_protocol?:
|
|
1631
|
+
string;
|
|
1280
1632
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1281
|
-
uploadType?:
|
|
1633
|
+
uploadType?:
|
|
1634
|
+
string;
|
|
1282
1635
|
},
|
|
1283
1636
|
body: CancelOperationRequest): Request<{}>;
|
|
1284
1637
|
/**
|
|
@@ -1287,89 +1640,128 @@ declare namespace gapi.client {
|
|
|
1287
1640
|
*/
|
|
1288
1641
|
delete(request?: {
|
|
1289
1642
|
/** V1 error format. */
|
|
1290
|
-
"$.xgafv"?:
|
|
1643
|
+
"$.xgafv"?:
|
|
1644
|
+
string;
|
|
1291
1645
|
/** OAuth access token. */
|
|
1292
|
-
access_token?:
|
|
1646
|
+
access_token?:
|
|
1647
|
+
string;
|
|
1293
1648
|
/** Data format for response. */
|
|
1294
|
-
alt?:
|
|
1649
|
+
alt?:
|
|
1650
|
+
string;
|
|
1295
1651
|
/** JSONP */
|
|
1296
|
-
callback?:
|
|
1652
|
+
callback?:
|
|
1653
|
+
string;
|
|
1297
1654
|
/** Selector specifying which fields to include in a partial response. */
|
|
1298
|
-
fields?:
|
|
1655
|
+
fields?:
|
|
1656
|
+
string;
|
|
1299
1657
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1300
|
-
key?:
|
|
1658
|
+
key?:
|
|
1659
|
+
string;
|
|
1301
1660
|
/** The name of the operation resource to be deleted. */
|
|
1302
|
-
name:
|
|
1661
|
+
name:
|
|
1662
|
+
string;
|
|
1303
1663
|
/** OAuth 2.0 token for the current user. */
|
|
1304
|
-
oauth_token?:
|
|
1664
|
+
oauth_token?:
|
|
1665
|
+
string;
|
|
1305
1666
|
/** Returns response with indentations and line breaks. */
|
|
1306
|
-
prettyPrint?:
|
|
1667
|
+
prettyPrint?:
|
|
1668
|
+
boolean;
|
|
1307
1669
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1308
|
-
quotaUser?:
|
|
1670
|
+
quotaUser?:
|
|
1671
|
+
string;
|
|
1309
1672
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1310
|
-
upload_protocol?:
|
|
1673
|
+
upload_protocol?:
|
|
1674
|
+
string;
|
|
1311
1675
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1312
|
-
uploadType?:
|
|
1676
|
+
uploadType?:
|
|
1677
|
+
string;
|
|
1313
1678
|
}): Request<{}>;
|
|
1314
1679
|
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
1315
1680
|
get(request?: {
|
|
1316
1681
|
/** V1 error format. */
|
|
1317
|
-
"$.xgafv"?:
|
|
1682
|
+
"$.xgafv"?:
|
|
1683
|
+
string;
|
|
1318
1684
|
/** OAuth access token. */
|
|
1319
|
-
access_token?:
|
|
1685
|
+
access_token?:
|
|
1686
|
+
string;
|
|
1320
1687
|
/** Data format for response. */
|
|
1321
|
-
alt?:
|
|
1688
|
+
alt?:
|
|
1689
|
+
string;
|
|
1322
1690
|
/** JSONP */
|
|
1323
|
-
callback?:
|
|
1691
|
+
callback?:
|
|
1692
|
+
string;
|
|
1324
1693
|
/** Selector specifying which fields to include in a partial response. */
|
|
1325
|
-
fields?:
|
|
1694
|
+
fields?:
|
|
1695
|
+
string;
|
|
1326
1696
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1327
|
-
key?:
|
|
1697
|
+
key?:
|
|
1698
|
+
string;
|
|
1328
1699
|
/** The name of the operation resource. */
|
|
1329
|
-
name:
|
|
1700
|
+
name:
|
|
1701
|
+
string;
|
|
1330
1702
|
/** OAuth 2.0 token for the current user. */
|
|
1331
|
-
oauth_token?:
|
|
1703
|
+
oauth_token?:
|
|
1704
|
+
string;
|
|
1332
1705
|
/** Returns response with indentations and line breaks. */
|
|
1333
|
-
prettyPrint?:
|
|
1706
|
+
prettyPrint?:
|
|
1707
|
+
boolean;
|
|
1334
1708
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1335
|
-
quotaUser?:
|
|
1709
|
+
quotaUser?:
|
|
1710
|
+
string;
|
|
1336
1711
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1337
|
-
upload_protocol?:
|
|
1712
|
+
upload_protocol?:
|
|
1713
|
+
string;
|
|
1338
1714
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1339
|
-
uploadType?:
|
|
1715
|
+
uploadType?:
|
|
1716
|
+
string;
|
|
1340
1717
|
}): Request<Operation>;
|
|
1341
1718
|
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
1342
1719
|
list(request?: {
|
|
1343
1720
|
/** V1 error format. */
|
|
1344
|
-
"$.xgafv"?:
|
|
1721
|
+
"$.xgafv"?:
|
|
1722
|
+
string;
|
|
1345
1723
|
/** OAuth access token. */
|
|
1346
|
-
access_token?:
|
|
1724
|
+
access_token?:
|
|
1725
|
+
string;
|
|
1347
1726
|
/** Data format for response. */
|
|
1348
|
-
alt?:
|
|
1727
|
+
alt?:
|
|
1728
|
+
string;
|
|
1349
1729
|
/** JSONP */
|
|
1350
|
-
callback?:
|
|
1730
|
+
callback?:
|
|
1731
|
+
string;
|
|
1351
1732
|
/** Selector specifying which fields to include in a partial response. */
|
|
1352
|
-
fields?:
|
|
1733
|
+
fields?:
|
|
1734
|
+
string;
|
|
1353
1735
|
/** The standard list filter. */
|
|
1354
|
-
filter?:
|
|
1736
|
+
filter?:
|
|
1737
|
+
string;
|
|
1355
1738
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1356
|
-
key?:
|
|
1739
|
+
key?:
|
|
1740
|
+
string;
|
|
1357
1741
|
/** The name of the operation's parent resource. */
|
|
1358
|
-
name?:
|
|
1742
|
+
name?:
|
|
1743
|
+
string;
|
|
1359
1744
|
/** OAuth 2.0 token for the current user. */
|
|
1360
|
-
oauth_token?:
|
|
1745
|
+
oauth_token?:
|
|
1746
|
+
string;
|
|
1361
1747
|
/** The standard list page size. */
|
|
1362
|
-
pageSize?:
|
|
1748
|
+
pageSize?:
|
|
1749
|
+
number;
|
|
1363
1750
|
/** The standard list page token. */
|
|
1364
|
-
pageToken?:
|
|
1751
|
+
pageToken?:
|
|
1752
|
+
string;
|
|
1365
1753
|
/** Returns response with indentations and line breaks. */
|
|
1366
|
-
prettyPrint?:
|
|
1754
|
+
prettyPrint?:
|
|
1755
|
+
boolean;
|
|
1367
1756
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1368
|
-
quotaUser?:
|
|
1757
|
+
quotaUser?:
|
|
1758
|
+
string;
|
|
1369
1759
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1370
|
-
upload_protocol?:
|
|
1760
|
+
upload_protocol?:
|
|
1761
|
+
string;
|
|
1371
1762
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1372
|
-
uploadType?:
|
|
1763
|
+
uploadType?:
|
|
1764
|
+
string;
|
|
1373
1765
|
}): Request<ListOperationsResponse>;
|
|
1374
1766
|
}
|
|
1375
1767
|
interface ServicesResource {
|
|
@@ -1379,93 +1771,131 @@ declare namespace gapi.client {
|
|
|
1379
1771
|
*/
|
|
1380
1772
|
batchEnable(request: {
|
|
1381
1773
|
/** V1 error format. */
|
|
1382
|
-
"$.xgafv"?:
|
|
1774
|
+
"$.xgafv"?:
|
|
1775
|
+
string;
|
|
1383
1776
|
/** OAuth access token. */
|
|
1384
|
-
access_token?:
|
|
1777
|
+
access_token?:
|
|
1778
|
+
string;
|
|
1385
1779
|
/** Data format for response. */
|
|
1386
|
-
alt?:
|
|
1780
|
+
alt?:
|
|
1781
|
+
string;
|
|
1387
1782
|
/** JSONP */
|
|
1388
|
-
callback?:
|
|
1783
|
+
callback?:
|
|
1784
|
+
string;
|
|
1389
1785
|
/** Selector specifying which fields to include in a partial response. */
|
|
1390
|
-
fields?:
|
|
1786
|
+
fields?:
|
|
1787
|
+
string;
|
|
1391
1788
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1392
|
-
key?:
|
|
1789
|
+
key?:
|
|
1790
|
+
string;
|
|
1393
1791
|
/** OAuth 2.0 token for the current user. */
|
|
1394
|
-
oauth_token?:
|
|
1792
|
+
oauth_token?:
|
|
1793
|
+
string;
|
|
1395
1794
|
/** Parent to enable services on. An example name would be: `projects/123` where `123` is the project number. The `BatchEnableServices` method currently only supports projects. */
|
|
1396
|
-
parent:
|
|
1795
|
+
parent:
|
|
1796
|
+
string;
|
|
1397
1797
|
/** Returns response with indentations and line breaks. */
|
|
1398
|
-
prettyPrint?:
|
|
1798
|
+
prettyPrint?:
|
|
1799
|
+
boolean;
|
|
1399
1800
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1400
|
-
quotaUser?:
|
|
1801
|
+
quotaUser?:
|
|
1802
|
+
string;
|
|
1401
1803
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1402
|
-
upload_protocol?:
|
|
1804
|
+
upload_protocol?:
|
|
1805
|
+
string;
|
|
1403
1806
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1404
|
-
uploadType?:
|
|
1807
|
+
uploadType?:
|
|
1808
|
+
string;
|
|
1405
1809
|
/** Request body */
|
|
1406
|
-
resource:
|
|
1810
|
+
resource:
|
|
1811
|
+
BatchEnableServicesRequest;
|
|
1407
1812
|
}): Request<Operation>;
|
|
1408
1813
|
batchEnable(request: {
|
|
1409
1814
|
/** V1 error format. */
|
|
1410
|
-
"$.xgafv"?:
|
|
1815
|
+
"$.xgafv"?:
|
|
1816
|
+
string;
|
|
1411
1817
|
/** OAuth access token. */
|
|
1412
|
-
access_token?:
|
|
1818
|
+
access_token?:
|
|
1819
|
+
string;
|
|
1413
1820
|
/** Data format for response. */
|
|
1414
|
-
alt?:
|
|
1821
|
+
alt?:
|
|
1822
|
+
string;
|
|
1415
1823
|
/** JSONP */
|
|
1416
|
-
callback?:
|
|
1824
|
+
callback?:
|
|
1825
|
+
string;
|
|
1417
1826
|
/** Selector specifying which fields to include in a partial response. */
|
|
1418
|
-
fields?:
|
|
1827
|
+
fields?:
|
|
1828
|
+
string;
|
|
1419
1829
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1420
|
-
key?:
|
|
1830
|
+
key?:
|
|
1831
|
+
string;
|
|
1421
1832
|
/** OAuth 2.0 token for the current user. */
|
|
1422
|
-
oauth_token?:
|
|
1833
|
+
oauth_token?:
|
|
1834
|
+
string;
|
|
1423
1835
|
/** Parent to enable services on. An example name would be: `projects/123` where `123` is the project number. The `BatchEnableServices` method currently only supports projects. */
|
|
1424
|
-
parent:
|
|
1836
|
+
parent:
|
|
1837
|
+
string;
|
|
1425
1838
|
/** Returns response with indentations and line breaks. */
|
|
1426
|
-
prettyPrint?:
|
|
1839
|
+
prettyPrint?:
|
|
1840
|
+
boolean;
|
|
1427
1841
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1428
|
-
quotaUser?:
|
|
1842
|
+
quotaUser?:
|
|
1843
|
+
string;
|
|
1429
1844
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1430
|
-
upload_protocol?:
|
|
1845
|
+
upload_protocol?:
|
|
1846
|
+
string;
|
|
1431
1847
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1432
|
-
uploadType?:
|
|
1848
|
+
uploadType?:
|
|
1849
|
+
string;
|
|
1433
1850
|
},
|
|
1434
1851
|
body: BatchEnableServicesRequest): Request<Operation>;
|
|
1435
1852
|
/** Returns the service configurations and enabled states for a given list of services. */
|
|
1436
1853
|
batchGet(request?: {
|
|
1437
1854
|
/** V1 error format. */
|
|
1438
|
-
"$.xgafv"?:
|
|
1855
|
+
"$.xgafv"?:
|
|
1856
|
+
string;
|
|
1439
1857
|
/** OAuth access token. */
|
|
1440
|
-
access_token?:
|
|
1858
|
+
access_token?:
|
|
1859
|
+
string;
|
|
1441
1860
|
/** Data format for response. */
|
|
1442
|
-
alt?:
|
|
1861
|
+
alt?:
|
|
1862
|
+
string;
|
|
1443
1863
|
/** JSONP */
|
|
1444
|
-
callback?:
|
|
1864
|
+
callback?:
|
|
1865
|
+
string;
|
|
1445
1866
|
/** Selector specifying which fields to include in a partial response. */
|
|
1446
|
-
fields?:
|
|
1867
|
+
fields?:
|
|
1868
|
+
string;
|
|
1447
1869
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1448
|
-
key?:
|
|
1870
|
+
key?:
|
|
1871
|
+
string;
|
|
1449
1872
|
/**
|
|
1450
1873
|
* Names of the services to retrieve. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number. A single request can get a
|
|
1451
1874
|
* maximum of 30 services at a time.
|
|
1452
1875
|
*/
|
|
1453
|
-
names?:
|
|
1876
|
+
names?:
|
|
1877
|
+
string | string[];
|
|
1454
1878
|
/** OAuth 2.0 token for the current user. */
|
|
1455
|
-
oauth_token?:
|
|
1879
|
+
oauth_token?:
|
|
1880
|
+
string;
|
|
1456
1881
|
/**
|
|
1457
1882
|
* Parent to retrieve services from. If this is set, the parent of all of the services specified in `names` must match this field. An example name would be: `projects/123` where
|
|
1458
1883
|
* `123` is the project number. The `BatchGetServices` method currently only supports projects.
|
|
1459
1884
|
*/
|
|
1460
|
-
parent:
|
|
1885
|
+
parent:
|
|
1886
|
+
string;
|
|
1461
1887
|
/** Returns response with indentations and line breaks. */
|
|
1462
|
-
prettyPrint?:
|
|
1888
|
+
prettyPrint?:
|
|
1889
|
+
boolean;
|
|
1463
1890
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1464
|
-
quotaUser?:
|
|
1891
|
+
quotaUser?:
|
|
1892
|
+
string;
|
|
1465
1893
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1466
|
-
upload_protocol?:
|
|
1894
|
+
upload_protocol?:
|
|
1895
|
+
string;
|
|
1467
1896
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1468
|
-
uploadType?:
|
|
1897
|
+
uploadType?:
|
|
1898
|
+
string;
|
|
1469
1899
|
}): Request<BatchGetServicesResponse>;
|
|
1470
1900
|
/**
|
|
1471
1901
|
* Disable a service so that it can no longer be used with a project. This prevents unintended usage that may cause unexpected billing charges or security leaks. It is not valid to
|
|
@@ -1473,155 +1903,217 @@ declare namespace gapi.client {
|
|
|
1473
1903
|
*/
|
|
1474
1904
|
disable(request: {
|
|
1475
1905
|
/** V1 error format. */
|
|
1476
|
-
"$.xgafv"?:
|
|
1906
|
+
"$.xgafv"?:
|
|
1907
|
+
string;
|
|
1477
1908
|
/** OAuth access token. */
|
|
1478
|
-
access_token?:
|
|
1909
|
+
access_token?:
|
|
1910
|
+
string;
|
|
1479
1911
|
/** Data format for response. */
|
|
1480
|
-
alt?:
|
|
1912
|
+
alt?:
|
|
1913
|
+
string;
|
|
1481
1914
|
/** JSONP */
|
|
1482
|
-
callback?:
|
|
1915
|
+
callback?:
|
|
1916
|
+
string;
|
|
1483
1917
|
/** Selector specifying which fields to include in a partial response. */
|
|
1484
|
-
fields?:
|
|
1918
|
+
fields?:
|
|
1919
|
+
string;
|
|
1485
1920
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1486
|
-
key?:
|
|
1921
|
+
key?:
|
|
1922
|
+
string;
|
|
1487
1923
|
/**
|
|
1488
1924
|
* Name of the consumer and service to disable the service on. The enable and disable methods currently only support projects. An example name would be:
|
|
1489
1925
|
* `projects/123/services/serviceusage.googleapis.com` where `123` is the project number.
|
|
1490
1926
|
*/
|
|
1491
|
-
name:
|
|
1927
|
+
name:
|
|
1928
|
+
string;
|
|
1492
1929
|
/** OAuth 2.0 token for the current user. */
|
|
1493
|
-
oauth_token?:
|
|
1930
|
+
oauth_token?:
|
|
1931
|
+
string;
|
|
1494
1932
|
/** Returns response with indentations and line breaks. */
|
|
1495
|
-
prettyPrint?:
|
|
1933
|
+
prettyPrint?:
|
|
1934
|
+
boolean;
|
|
1496
1935
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1497
|
-
quotaUser?:
|
|
1936
|
+
quotaUser?:
|
|
1937
|
+
string;
|
|
1498
1938
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1499
|
-
upload_protocol?:
|
|
1939
|
+
upload_protocol?:
|
|
1940
|
+
string;
|
|
1500
1941
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1501
|
-
uploadType?:
|
|
1942
|
+
uploadType?:
|
|
1943
|
+
string;
|
|
1502
1944
|
/** Request body */
|
|
1503
|
-
resource:
|
|
1945
|
+
resource:
|
|
1946
|
+
DisableServiceRequest;
|
|
1504
1947
|
}): Request<Operation>;
|
|
1505
1948
|
disable(request: {
|
|
1506
1949
|
/** V1 error format. */
|
|
1507
|
-
"$.xgafv"?:
|
|
1950
|
+
"$.xgafv"?:
|
|
1951
|
+
string;
|
|
1508
1952
|
/** OAuth access token. */
|
|
1509
|
-
access_token?:
|
|
1953
|
+
access_token?:
|
|
1954
|
+
string;
|
|
1510
1955
|
/** Data format for response. */
|
|
1511
|
-
alt?:
|
|
1956
|
+
alt?:
|
|
1957
|
+
string;
|
|
1512
1958
|
/** JSONP */
|
|
1513
|
-
callback?:
|
|
1959
|
+
callback?:
|
|
1960
|
+
string;
|
|
1514
1961
|
/** Selector specifying which fields to include in a partial response. */
|
|
1515
|
-
fields?:
|
|
1962
|
+
fields?:
|
|
1963
|
+
string;
|
|
1516
1964
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1517
|
-
key?:
|
|
1965
|
+
key?:
|
|
1966
|
+
string;
|
|
1518
1967
|
/**
|
|
1519
1968
|
* Name of the consumer and service to disable the service on. The enable and disable methods currently only support projects. An example name would be:
|
|
1520
1969
|
* `projects/123/services/serviceusage.googleapis.com` where `123` is the project number.
|
|
1521
1970
|
*/
|
|
1522
|
-
name:
|
|
1971
|
+
name:
|
|
1972
|
+
string;
|
|
1523
1973
|
/** OAuth 2.0 token for the current user. */
|
|
1524
|
-
oauth_token?:
|
|
1974
|
+
oauth_token?:
|
|
1975
|
+
string;
|
|
1525
1976
|
/** Returns response with indentations and line breaks. */
|
|
1526
|
-
prettyPrint?:
|
|
1977
|
+
prettyPrint?:
|
|
1978
|
+
boolean;
|
|
1527
1979
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1528
|
-
quotaUser?:
|
|
1980
|
+
quotaUser?:
|
|
1981
|
+
string;
|
|
1529
1982
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1530
|
-
upload_protocol?:
|
|
1983
|
+
upload_protocol?:
|
|
1984
|
+
string;
|
|
1531
1985
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1532
|
-
uploadType?:
|
|
1986
|
+
uploadType?:
|
|
1987
|
+
string;
|
|
1533
1988
|
},
|
|
1534
1989
|
body: DisableServiceRequest): Request<Operation>;
|
|
1535
1990
|
/** Enable a service so that it can be used with a project. */
|
|
1536
1991
|
enable(request: {
|
|
1537
1992
|
/** V1 error format. */
|
|
1538
|
-
"$.xgafv"?:
|
|
1993
|
+
"$.xgafv"?:
|
|
1994
|
+
string;
|
|
1539
1995
|
/** OAuth access token. */
|
|
1540
|
-
access_token?:
|
|
1996
|
+
access_token?:
|
|
1997
|
+
string;
|
|
1541
1998
|
/** Data format for response. */
|
|
1542
|
-
alt?:
|
|
1999
|
+
alt?:
|
|
2000
|
+
string;
|
|
1543
2001
|
/** JSONP */
|
|
1544
|
-
callback?:
|
|
2002
|
+
callback?:
|
|
2003
|
+
string;
|
|
1545
2004
|
/** Selector specifying which fields to include in a partial response. */
|
|
1546
|
-
fields?:
|
|
2005
|
+
fields?:
|
|
2006
|
+
string;
|
|
1547
2007
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1548
|
-
key?:
|
|
2008
|
+
key?:
|
|
2009
|
+
string;
|
|
1549
2010
|
/**
|
|
1550
2011
|
* Name of the consumer and service to enable the service on. The `EnableService` and `DisableService` methods currently only support projects. Enabling a service requires that the
|
|
1551
2012
|
* service is public or is shared with the user enabling the service. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project
|
|
1552
2013
|
* number.
|
|
1553
2014
|
*/
|
|
1554
|
-
name:
|
|
2015
|
+
name:
|
|
2016
|
+
string;
|
|
1555
2017
|
/** OAuth 2.0 token for the current user. */
|
|
1556
|
-
oauth_token?:
|
|
2018
|
+
oauth_token?:
|
|
2019
|
+
string;
|
|
1557
2020
|
/** Returns response with indentations and line breaks. */
|
|
1558
|
-
prettyPrint?:
|
|
2021
|
+
prettyPrint?:
|
|
2022
|
+
boolean;
|
|
1559
2023
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1560
|
-
quotaUser?:
|
|
2024
|
+
quotaUser?:
|
|
2025
|
+
string;
|
|
1561
2026
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1562
|
-
upload_protocol?:
|
|
2027
|
+
upload_protocol?:
|
|
2028
|
+
string;
|
|
1563
2029
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1564
|
-
uploadType?:
|
|
2030
|
+
uploadType?:
|
|
2031
|
+
string;
|
|
1565
2032
|
/** Request body */
|
|
1566
|
-
resource:
|
|
2033
|
+
resource:
|
|
2034
|
+
EnableServiceRequest;
|
|
1567
2035
|
}): Request<Operation>;
|
|
1568
2036
|
enable(request: {
|
|
1569
2037
|
/** V1 error format. */
|
|
1570
|
-
"$.xgafv"?:
|
|
2038
|
+
"$.xgafv"?:
|
|
2039
|
+
string;
|
|
1571
2040
|
/** OAuth access token. */
|
|
1572
|
-
access_token?:
|
|
2041
|
+
access_token?:
|
|
2042
|
+
string;
|
|
1573
2043
|
/** Data format for response. */
|
|
1574
|
-
alt?:
|
|
2044
|
+
alt?:
|
|
2045
|
+
string;
|
|
1575
2046
|
/** JSONP */
|
|
1576
|
-
callback?:
|
|
2047
|
+
callback?:
|
|
2048
|
+
string;
|
|
1577
2049
|
/** Selector specifying which fields to include in a partial response. */
|
|
1578
|
-
fields?:
|
|
2050
|
+
fields?:
|
|
2051
|
+
string;
|
|
1579
2052
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1580
|
-
key?:
|
|
2053
|
+
key?:
|
|
2054
|
+
string;
|
|
1581
2055
|
/**
|
|
1582
2056
|
* Name of the consumer and service to enable the service on. The `EnableService` and `DisableService` methods currently only support projects. Enabling a service requires that the
|
|
1583
2057
|
* service is public or is shared with the user enabling the service. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project
|
|
1584
2058
|
* number.
|
|
1585
2059
|
*/
|
|
1586
|
-
name:
|
|
2060
|
+
name:
|
|
2061
|
+
string;
|
|
1587
2062
|
/** OAuth 2.0 token for the current user. */
|
|
1588
|
-
oauth_token?:
|
|
2063
|
+
oauth_token?:
|
|
2064
|
+
string;
|
|
1589
2065
|
/** Returns response with indentations and line breaks. */
|
|
1590
|
-
prettyPrint?:
|
|
2066
|
+
prettyPrint?:
|
|
2067
|
+
boolean;
|
|
1591
2068
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1592
|
-
quotaUser?:
|
|
2069
|
+
quotaUser?:
|
|
2070
|
+
string;
|
|
1593
2071
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1594
|
-
upload_protocol?:
|
|
2072
|
+
upload_protocol?:
|
|
2073
|
+
string;
|
|
1595
2074
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1596
|
-
uploadType?:
|
|
2075
|
+
uploadType?:
|
|
2076
|
+
string;
|
|
1597
2077
|
},
|
|
1598
2078
|
body: EnableServiceRequest): Request<Operation>;
|
|
1599
2079
|
/** Returns the service configuration and enabled state for a given service. */
|
|
1600
2080
|
get(request?: {
|
|
1601
2081
|
/** V1 error format. */
|
|
1602
|
-
"$.xgafv"?:
|
|
2082
|
+
"$.xgafv"?:
|
|
2083
|
+
string;
|
|
1603
2084
|
/** OAuth access token. */
|
|
1604
|
-
access_token?:
|
|
2085
|
+
access_token?:
|
|
2086
|
+
string;
|
|
1605
2087
|
/** Data format for response. */
|
|
1606
|
-
alt?:
|
|
2088
|
+
alt?:
|
|
2089
|
+
string;
|
|
1607
2090
|
/** JSONP */
|
|
1608
|
-
callback?:
|
|
2091
|
+
callback?:
|
|
2092
|
+
string;
|
|
1609
2093
|
/** Selector specifying which fields to include in a partial response. */
|
|
1610
|
-
fields?:
|
|
2094
|
+
fields?:
|
|
2095
|
+
string;
|
|
1611
2096
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1612
|
-
key?:
|
|
2097
|
+
key?:
|
|
2098
|
+
string;
|
|
1613
2099
|
/** Name of the consumer and service to get the `ConsumerState` for. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number. */
|
|
1614
|
-
name:
|
|
2100
|
+
name:
|
|
2101
|
+
string;
|
|
1615
2102
|
/** OAuth 2.0 token for the current user. */
|
|
1616
|
-
oauth_token?:
|
|
2103
|
+
oauth_token?:
|
|
2104
|
+
string;
|
|
1617
2105
|
/** Returns response with indentations and line breaks. */
|
|
1618
|
-
prettyPrint?:
|
|
2106
|
+
prettyPrint?:
|
|
2107
|
+
boolean;
|
|
1619
2108
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1620
|
-
quotaUser?:
|
|
2109
|
+
quotaUser?:
|
|
2110
|
+
string;
|
|
1621
2111
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1622
|
-
upload_protocol?:
|
|
2112
|
+
upload_protocol?:
|
|
2113
|
+
string;
|
|
1623
2114
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1624
|
-
uploadType?:
|
|
2115
|
+
uploadType?:
|
|
2116
|
+
string;
|
|
1625
2117
|
}): Request<GoogleApiServiceusageV1Service>;
|
|
1626
2118
|
/**
|
|
1627
2119
|
* List all services available to the specified project, and the current state of those services with respect to the project. The list includes all public services, all services for
|
|
@@ -1631,35 +2123,50 @@ declare namespace gapi.client {
|
|
|
1631
2123
|
*/
|
|
1632
2124
|
list(request?: {
|
|
1633
2125
|
/** V1 error format. */
|
|
1634
|
-
"$.xgafv"?:
|
|
2126
|
+
"$.xgafv"?:
|
|
2127
|
+
string;
|
|
1635
2128
|
/** OAuth access token. */
|
|
1636
|
-
access_token?:
|
|
2129
|
+
access_token?:
|
|
2130
|
+
string;
|
|
1637
2131
|
/** Data format for response. */
|
|
1638
|
-
alt?:
|
|
2132
|
+
alt?:
|
|
2133
|
+
string;
|
|
1639
2134
|
/** JSONP */
|
|
1640
|
-
callback?:
|
|
2135
|
+
callback?:
|
|
2136
|
+
string;
|
|
1641
2137
|
/** Selector specifying which fields to include in a partial response. */
|
|
1642
|
-
fields?:
|
|
2138
|
+
fields?:
|
|
2139
|
+
string;
|
|
1643
2140
|
/** Only list services that conform to the given filter. The allowed filter strings are `state:ENABLED` and `state:DISABLED`. */
|
|
1644
|
-
filter?:
|
|
2141
|
+
filter?:
|
|
2142
|
+
string;
|
|
1645
2143
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1646
|
-
key?:
|
|
2144
|
+
key?:
|
|
2145
|
+
string;
|
|
1647
2146
|
/** OAuth 2.0 token for the current user. */
|
|
1648
|
-
oauth_token?:
|
|
2147
|
+
oauth_token?:
|
|
2148
|
+
string;
|
|
1649
2149
|
/** Requested size of the next page of data. Requested page size cannot exceed 200. If not set, the default page size is 50. */
|
|
1650
|
-
pageSize?:
|
|
2150
|
+
pageSize?:
|
|
2151
|
+
number;
|
|
1651
2152
|
/** Token identifying which result to start with, which is returned by a previous list call. */
|
|
1652
|
-
pageToken?:
|
|
2153
|
+
pageToken?:
|
|
2154
|
+
string;
|
|
1653
2155
|
/** Parent to search for services on. An example name would be: `projects/123` where `123` is the project number. */
|
|
1654
|
-
parent:
|
|
2156
|
+
parent:
|
|
2157
|
+
string;
|
|
1655
2158
|
/** Returns response with indentations and line breaks. */
|
|
1656
|
-
prettyPrint?:
|
|
2159
|
+
prettyPrint?:
|
|
2160
|
+
boolean;
|
|
1657
2161
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1658
|
-
quotaUser?:
|
|
2162
|
+
quotaUser?:
|
|
2163
|
+
string;
|
|
1659
2164
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1660
|
-
upload_protocol?:
|
|
2165
|
+
upload_protocol?:
|
|
2166
|
+
string;
|
|
1661
2167
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1662
|
-
uploadType?:
|
|
2168
|
+
uploadType?:
|
|
2169
|
+
string;
|
|
1663
2170
|
}): Request<ListServicesResponse>;
|
|
1664
2171
|
}
|
|
1665
2172
|
|