@maxim_mazurok/gapi.client.serviceusage-v1 0.0.20220811

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 ADDED
@@ -0,0 +1,1489 @@
1
+ /* Type definitions for non-npm package Service Usage API v1 0.0 */
2
+ // Project: https://cloud.google.com/service-usage/
3
+ // Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
4
+ // Nick Amoscato <https://github.com/namoscato>
5
+ // Declan Vong <https://github.com/declanvong>
6
+ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
7
+ // TypeScript Version: 2.8
8
+
9
+ // IMPORTANT
10
+ // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
11
+ // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
12
+ // Generated from: https://serviceusage.googleapis.com/$discovery/rest?version=v1
13
+ // Revision: 20220811
14
+
15
+ /// <reference types="gapi.client" />
16
+
17
+ declare namespace gapi.client {
18
+ /** Load Service Usage API v1 */
19
+ function load(urlOrObject: "https://serviceusage.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
20
+ /** @deprecated Please load APIs with discovery documents. */
21
+ function load(name: "serviceusage", version: "v1"): Promise<void>;
22
+ /** @deprecated Please load APIs with discovery documents. */
23
+ function load(name: "serviceusage", version: "v1", callback: () => any): void;
24
+
25
+ namespace serviceusage {
26
+ interface AdminQuotaPolicy {
27
+ /** The cloud resource container at which the quota policy is created. The format is `{container_type}/{container_number}` */
28
+ container?: string;
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
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
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
33
+ * `region` or `zone` are not valid.
34
+ */
35
+ dimensions?: { [P in string]: string };
36
+ /** The name of the metric to which this policy applies. An example name would be: `compute.googleapis.com/cpus` */
37
+ metric?: string;
38
+ /**
39
+ * The resource name of the policy. This name is generated by the server when the policy is created. Example names would be:
40
+ * `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d`
41
+ */
42
+ name?: string;
43
+ /** The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota). */
44
+ policyValue?: string;
45
+ /**
46
+ * 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;
47
+ * the literal characters `{` and `}` occur in the string.
48
+ */
49
+ unit?: string;
50
+ }
51
+ interface Api {
52
+ /** The methods of this interface, in unspecified order. */
53
+ methods?: Method[];
54
+ /** Included interfaces. See Mixin. */
55
+ mixins?: Mixin[];
56
+ /** The fully qualified name of this interface, including package name followed by the interface's simple name. */
57
+ name?: string;
58
+ /** Any metadata attached to the interface. */
59
+ options?: Option[];
60
+ /** Source context for the protocol buffer service represented by this message. */
61
+ sourceContext?: SourceContext;
62
+ /** The source syntax of the service. */
63
+ syntax?: string;
64
+ /**
65
+ * 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
66
+ * 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
67
+ * be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the
68
+ * minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product
69
+ * 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
70
+ * omitted. Zero major versions must only be used for experimental, non-GA interfaces.
71
+ */
72
+ version?: string;
73
+ }
74
+ interface Authentication {
75
+ /** Defines a set of authentication providers that a service supports. */
76
+ providers?: AuthProvider[];
77
+ /** A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */
78
+ rules?: AuthenticationRule[];
79
+ }
80
+ interface AuthenticationRule {
81
+ /** If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests. */
82
+ allowWithoutCredential?: boolean;
83
+ /** The requirements for OAuth credentials. */
84
+ oauth?: OAuthRequirements;
85
+ /** Requirements for additional authentication providers. */
86
+ requirements?: AuthRequirement[];
87
+ /** Selects the methods to which this rule applies. Refer to selector for syntax details. */
88
+ selector?: string;
89
+ }
90
+ interface AuthProvider {
91
+ /**
92
+ * The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will
93
+ * be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no
94
+ * audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService -
95
+ * https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
96
+ */
97
+ audiences?: string;
98
+ /** Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec. */
99
+ authorizationUrl?: string;
100
+ /** The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth". */
101
+ id?: string;
102
+ /**
103
+ * 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:
104
+ * https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
105
+ */
106
+ issuer?: string;
107
+ /**
108
+ * 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
109
+ * 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
110
+ * domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs
111
+ */
112
+ jwksUri?: string;
113
+ /**
114
+ * 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]
115
+ * (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
116
+ * 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
117
+ * locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token
118
+ */
119
+ jwtLocations?: JwtLocation[];
120
+ }
121
+ interface AuthRequirement {
122
+ /**
123
+ * NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT
124
+ * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When
125
+ * this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only
126
+ * accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences:
127
+ * bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
128
+ */
129
+ audiences?: string;
130
+ /** id from authentication provider. Example: provider_id: bookstore_auth */
131
+ providerId?: string;
132
+ }
133
+ interface Backend {
134
+ /** A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */
135
+ rules?: BackendRule[];
136
+ }
137
+ interface BackendRule {
138
+ /**
139
+ * The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None
140
+ * 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
141
+ * 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.
142
+ */
143
+ address?: string;
144
+ /** The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment. */
145
+ deadline?: number;
146
+ /**
147
+ * 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
148
+ * expected by the backend, this field must be set to true to preserve the header.
149
+ */
150
+ disableAuth?: boolean;
151
+ /** 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. */
152
+ jwtAudience?: string;
153
+ /** The number of seconds to wait for the completion of a long running operation. The default is no deadline. */
154
+ operationDeadline?: number;
155
+ pathTranslation?: string;
156
+ /**
157
+ * 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
158
+ * 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.
159
+ * Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See
160
+ * https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.
161
+ */
162
+ protocol?: string;
163
+ /** Selects the methods to which this rule applies. Refer to selector for syntax details. */
164
+ selector?: string;
165
+ }
166
+ interface BatchCreateAdminOverridesResponse {
167
+ /** The overrides that were created. */
168
+ overrides?: QuotaOverride[];
169
+ }
170
+ interface BatchCreateConsumerOverridesResponse {
171
+ /** The overrides that were created. */
172
+ overrides?: QuotaOverride[];
173
+ }
174
+ interface BatchEnableServicesRequest {
175
+ /**
176
+ * The identifiers of the services to enable on the project. A valid identifier would be: serviceusage.googleapis.com Enabling services requires that each service is public or is
177
+ * 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
178
+ * state changes will occur.
179
+ */
180
+ serviceIds?: string[];
181
+ }
182
+ interface BatchEnableServicesResponse {
183
+ /** If allow_partial_success is true, and one or more services could not be enabled, this field contains the details about each failure. */
184
+ failures?: EnableFailure[];
185
+ /** The new state of the services after enabling. */
186
+ services?: GoogleApiServiceusageV1Service[];
187
+ }
188
+ interface BatchGetServicesResponse {
189
+ /** The requested Service states. */
190
+ services?: GoogleApiServiceusageV1Service[];
191
+ }
192
+ interface Billing {
193
+ /**
194
+ * 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.
195
+ * A metric can be used in at most one consumer destination.
196
+ */
197
+ consumerDestinations?: BillingDestination[];
198
+ }
199
+ interface BillingDestination {
200
+ /** Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section. */
201
+ metrics?: string[];
202
+ /** The monitored resource type. The type must be defined in Service.monitored_resources section. */
203
+ monitoredResource?: string;
204
+ }
205
+ // tslint:disable-next-line:no-empty-interface
206
+ interface CancelOperationRequest {
207
+ }
208
+ interface Context {
209
+ /** A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */
210
+ rules?: ContextRule[];
211
+ }
212
+ interface ContextRule {
213
+ /** A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend. */
214
+ allowedRequestExtensions?: string[];
215
+ /** A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. */
216
+ allowedResponseExtensions?: string[];
217
+ /** A list of full type names of provided contexts. */
218
+ provided?: string[];
219
+ /** A list of full type names of requested contexts. */
220
+ requested?: string[];
221
+ /** Selects the methods to which this rule applies. Refer to selector for syntax details. */
222
+ selector?: string;
223
+ }
224
+ interface Control {
225
+ /**
226
+ * 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
227
+ * servicecontrol.googleapis.com
228
+ */
229
+ environment?: string;
230
+ }
231
+ // tslint:disable-next-line:no-empty-interface
232
+ interface CreateAdminQuotaPolicyMetadata {
233
+ }
234
+ interface CustomError {
235
+ /** The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order. */
236
+ rules?: CustomErrorRule[];
237
+ /** The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. */
238
+ types?: string[];
239
+ }
240
+ interface CustomErrorRule {
241
+ /** Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload. */
242
+ isErrorType?: boolean;
243
+ /** Selects messages to which this rule applies. Refer to selector for syntax details. */
244
+ selector?: string;
245
+ }
246
+ interface CustomHttpPattern {
247
+ /** The name of this custom HTTP verb. */
248
+ kind?: string;
249
+ /** The path matched by this custom verb. */
250
+ path?: string;
251
+ }
252
+ // tslint:disable-next-line:no-empty-interface
253
+ interface DeleteAdminQuotaPolicyMetadata {
254
+ }
255
+ interface DisableServiceRequest {
256
+ /** Defines the behavior for checking service usage when disabling a service. */
257
+ checkIfServiceHasUsage?: string;
258
+ /**
259
+ * 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
260
+ * to be disabled. When set, the service, and any enabled services that depend on it, will be disabled together.
261
+ */
262
+ disableDependentServices?: boolean;
263
+ }
264
+ interface DisableServiceResponse {
265
+ /** The new state of the service after disabling. */
266
+ service?: GoogleApiServiceusageV1Service;
267
+ }
268
+ interface Documentation {
269
+ /** The URL to the root of documentation. */
270
+ documentationRootUrl?: string;
271
+ /**
272
+ * Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style):
273
+ * documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field.
274
+ */
275
+ overview?: string;
276
+ /** The top level pages for the documentation set. */
277
+ pages?: Page[];
278
+ /** A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order. */
279
+ rules?: DocumentationRule[];
280
+ /**
281
+ * 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
282
+ * that show a base that other urls are relative to.
283
+ */
284
+ serviceRootUrl?: string;
285
+ /**
286
+ * 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
287
+ * equivalent to the standard field `description`.
288
+ */
289
+ summary?: string;
290
+ }
291
+ interface DocumentationRule {
292
+ /** Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. */
293
+ deprecationDescription?: string;
294
+ /**
295
+ * 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
296
+ * definition of the proto element.
297
+ */
298
+ description?: string;
299
+ /**
300
+ * 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 "*",
301
+ * 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
302
+ * match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.
303
+ */
304
+ selector?: string;
305
+ }
306
+ // tslint:disable-next-line:no-empty-interface
307
+ interface Empty {
308
+ }
309
+ interface EnableFailure {
310
+ /** An error message describing why the service could not be enabled. */
311
+ errorMessage?: string;
312
+ /** The service id of a service that could not be enabled. */
313
+ serviceId?: string;
314
+ }
315
+ // tslint:disable-next-line:no-empty-interface
316
+ interface EnableServiceRequest {
317
+ }
318
+ interface EnableServiceResponse {
319
+ /** The new state of the service after enabling. */
320
+ service?: GoogleApiServiceusageV1Service;
321
+ }
322
+ interface Endpoint {
323
+ /**
324
+ * 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
325
+ * HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
326
+ */
327
+ allowCors?: boolean;
328
+ /** The canonical name of this endpoint. */
329
+ name?: string;
330
+ /**
331
+ * 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
332
+ * either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
333
+ */
334
+ target?: string;
335
+ }
336
+ interface Enum {
337
+ /** Enum value definitions. */
338
+ enumvalue?: EnumValue[];
339
+ /** Enum type name. */
340
+ name?: string;
341
+ /** Protocol buffer options. */
342
+ options?: Option[];
343
+ /** The source context. */
344
+ sourceContext?: SourceContext;
345
+ /** The source syntax. */
346
+ syntax?: string;
347
+ }
348
+ interface EnumValue {
349
+ /** Enum value name. */
350
+ name?: string;
351
+ /** Enum value number. */
352
+ number?: number;
353
+ /** Protocol buffer options. */
354
+ options?: Option[];
355
+ }
356
+ interface Field {
357
+ /** The field cardinality. */
358
+ cardinality?: string;
359
+ /** The string value of the default value of this field. Proto2 syntax only. */
360
+ defaultValue?: string;
361
+ /** The field JSON name. */
362
+ jsonName?: string;
363
+ /** The field type. */
364
+ kind?: string;
365
+ /** The field name. */
366
+ name?: string;
367
+ /** The field number. */
368
+ number?: number;
369
+ /** 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. */
370
+ oneofIndex?: number;
371
+ /** The protocol buffer options. */
372
+ options?: Option[];
373
+ /** Whether to use alternative packed wire representation. */
374
+ packed?: boolean;
375
+ /** The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. */
376
+ typeUrl?: string;
377
+ }
378
+ // tslint:disable-next-line:no-empty-interface
379
+ interface GetServiceIdentityMetadata {
380
+ }
381
+ interface GetServiceIdentityResponse {
382
+ /**
383
+ * 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
384
+ * email and empty unique_id.
385
+ */
386
+ identity?: ServiceIdentity;
387
+ /** Service identity state. */
388
+ state?: string;
389
+ }
390
+ interface GoogleApiService {
391
+ /**
392
+ * 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
393
+ * 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.
394
+ */
395
+ apis?: Api[];
396
+ /** Auth configuration. */
397
+ authentication?: Authentication;
398
+ /** API backend configuration. */
399
+ backend?: Backend;
400
+ /** Billing configuration. */
401
+ billing?: Billing;
402
+ /** Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`. */
403
+ configVersion?: number;
404
+ /** Context configuration. */
405
+ context?: Context;
406
+ /** Configuration for the service control plane. */
407
+ control?: Control;
408
+ /** Custom error configuration. */
409
+ customError?: CustomError;
410
+ /** Additional API documentation. */
411
+ documentation?: Documentation;
412
+ /** 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. */
413
+ endpoints?: Endpoint[];
414
+ /**
415
+ * 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
416
+ * included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum
417
+ */
418
+ enums?: Enum[];
419
+ /** HTTP configuration. */
420
+ http?: Http;
421
+ /**
422
+ * 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,
423
+ * '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead.
424
+ */
425
+ id?: string;
426
+ /** Logging configuration. */
427
+ logging?: Logging;
428
+ /** Defines the logs used by this service. */
429
+ logs?: LogDescriptor[];
430
+ /** Defines the metrics used by this service. */
431
+ metrics?: MetricDescriptor[];
432
+ /** Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. */
433
+ monitoredResources?: MonitoredResourceDescriptor[];
434
+ /** Monitoring configuration. */
435
+ monitoring?: Monitoring;
436
+ /**
437
+ * 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
438
+ * the owner of the service also owns the DNS name.
439
+ */
440
+ name?: string;
441
+ /** The Google project that owns this service. */
442
+ producerProjectId?: string;
443
+ /** Quota configuration. */
444
+ quota?: Quota;
445
+ /** Output only. The source information for this configuration if available. */
446
+ sourceInfo?: SourceInfo;
447
+ /** System parameter configuration. */
448
+ systemParameters?: SystemParameters;
449
+ /**
450
+ * 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.
451
+ * Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
452
+ */
453
+ systemTypes?: Type[];
454
+ /** The product title for this service, it is the name displayed in Google Cloud Console. */
455
+ title?: string;
456
+ /**
457
+ * 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
458
+ * 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
459
+ */
460
+ types?: Type[];
461
+ /** Configuration controlling usage of this service. */
462
+ usage?: Usage;
463
+ }
464
+ interface GoogleApiServiceusageV1beta1GetServiceIdentityResponse {
465
+ /**
466
+ * 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
467
+ * email and empty unique_id.
468
+ */
469
+ identity?: GoogleApiServiceusageV1beta1ServiceIdentity;
470
+ /** Service identity state. */
471
+ state?: string;
472
+ }
473
+ interface GoogleApiServiceusageV1beta1ServiceIdentity {
474
+ /** The email address of the service account that a service producer would use to access consumer resources. */
475
+ email?: string;
476
+ /** The unique and stable id of the service account. https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount */
477
+ uniqueId?: string;
478
+ }
479
+ interface GoogleApiServiceusageV1OperationMetadata {
480
+ /** The full name of the resources that this operation is directly associated with. */
481
+ resourceNames?: string[];
482
+ }
483
+ interface GoogleApiServiceusageV1Service {
484
+ /**
485
+ * 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
486
+ * responses to the `GetService` method.
487
+ */
488
+ config?: GoogleApiServiceusageV1ServiceConfig;
489
+ /** The resource name of the consumer and service. A valid name would be: - projects/123/services/serviceusage.googleapis.com */
490
+ name?: string;
491
+ /** The resource name of the consumer. A valid name would be: - projects/123 */
492
+ parent?: string;
493
+ /** Whether or not the service has been enabled for use by the consumer. */
494
+ state?: string;
495
+ }
496
+ interface GoogleApiServiceusageV1ServiceConfig {
497
+ /** A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces. */
498
+ apis?: Api[];
499
+ /** Auth configuration. Contains only the OAuth rules. */
500
+ authentication?: Authentication;
501
+ /** Additional API documentation. Contains only the summary and the documentation URL. */
502
+ documentation?: Documentation;
503
+ /** Configuration for network endpoints. Contains only the names and aliases of the endpoints. */
504
+ endpoints?: Endpoint[];
505
+ /** Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. */
506
+ monitoredResources?: MonitoredResourceDescriptor[];
507
+ /** Monitoring configuration. This should not include the 'producer_destinations' field. */
508
+ monitoring?: Monitoring;
509
+ /** The DNS address at which this service is available. An example DNS address would be: `calendar.googleapis.com`. */
510
+ name?: string;
511
+ /** Quota configuration. */
512
+ quota?: Quota;
513
+ /** The product title for this service. */
514
+ title?: string;
515
+ /** Configuration controlling usage of this service. */
516
+ usage?: Usage;
517
+ }
518
+ interface Http {
519
+ /**
520
+ * 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
521
+ * behavior is to not decode RFC 6570 reserved characters in multi segment matches.
522
+ */
523
+ fullyDecodeReservedExpansion?: boolean;
524
+ /** A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */
525
+ rules?: HttpRule[];
526
+ }
527
+ interface HttpRule {
528
+ /** 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). */
529
+ additionalBindings?: HttpRule[];
530
+ /**
531
+ * 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
532
+ * not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.
533
+ */
534
+ body?: string;
535
+ /**
536
+ * 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
537
+ * wild-card rule is useful for services that provide content to Web (HTML) clients.
538
+ */
539
+ custom?: CustomHttpPattern;
540
+ /** Maps to HTTP DELETE. Used for deleting a resource. */
541
+ delete?: string;
542
+ /** Maps to HTTP GET. Used for listing and getting information about resources. */
543
+ get?: string;
544
+ /** Maps to HTTP PATCH. Used for updating a resource. */
545
+ patch?: string;
546
+ /** Maps to HTTP POST. Used for creating a resource or performing an action. */
547
+ post?: string;
548
+ /** Maps to HTTP PUT. Used for replacing a resource. */
549
+ put?: string;
550
+ /**
551
+ * 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
552
+ * referred field must be present at the top-level of the response message type.
553
+ */
554
+ responseBody?: string;
555
+ /** Selects a method to which this rule applies. Refer to selector for syntax details. */
556
+ selector?: string;
557
+ }
558
+ // tslint:disable-next-line:no-empty-interface
559
+ interface ImportAdminOverridesMetadata {
560
+ }
561
+ interface ImportAdminOverridesResponse {
562
+ /** The overrides that were created from the imported data. */
563
+ overrides?: QuotaOverride[];
564
+ }
565
+ // tslint:disable-next-line:no-empty-interface
566
+ interface ImportAdminQuotaPoliciesMetadata {
567
+ }
568
+ interface ImportAdminQuotaPoliciesResponse {
569
+ /** The policies that were created from the imported data. */
570
+ policies?: AdminQuotaPolicy[];
571
+ }
572
+ // tslint:disable-next-line:no-empty-interface
573
+ interface ImportConsumerOverridesMetadata {
574
+ }
575
+ interface ImportConsumerOverridesResponse {
576
+ /** The overrides that were created from the imported data. */
577
+ overrides?: QuotaOverride[];
578
+ }
579
+ interface JwtLocation {
580
+ /** Specifies cookie name to extract JWT token. */
581
+ cookie?: string;
582
+ /** Specifies HTTP header name to extract JWT token. */
583
+ header?: string;
584
+ /** Specifies URL query parameter name to extract JWT token. */
585
+ query?: string;
586
+ /**
587
+ * 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
588
+ * 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}",
589
+ * value_prefix="Bearer " with a space at the end.
590
+ */
591
+ valuePrefix?: string;
592
+ }
593
+ interface LabelDescriptor {
594
+ /** A human-readable description for the label. */
595
+ description?: string;
596
+ /** The label key. */
597
+ key?: string;
598
+ /** The type of data that can be assigned to the label. */
599
+ valueType?: string;
600
+ }
601
+ interface ListOperationsResponse {
602
+ /** The standard List next-page token. */
603
+ nextPageToken?: string;
604
+ /** A list of operations that matches the specified filter in the request. */
605
+ operations?: Operation[];
606
+ }
607
+ interface ListServicesResponse {
608
+ /** Token that can be passed to `ListServices` to resume a paginated query. */
609
+ nextPageToken?: string;
610
+ /** The available services for the requested project. */
611
+ services?: GoogleApiServiceusageV1Service[];
612
+ }
613
+ interface LogDescriptor {
614
+ /** A human-readable description of this log. This information appears in the documentation and can contain details. */
615
+ description?: string;
616
+ /** The human-readable name for this log. This information appears on the user interface and should be concise. */
617
+ displayName?: string;
618
+ /** The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid. */
619
+ labels?: LabelDescriptor[];
620
+ /**
621
+ * 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
622
+ * characters including slash, underscore, hyphen, period [/_-.].
623
+ */
624
+ name?: string;
625
+ }
626
+ interface Logging {
627
+ /**
628
+ * 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
629
+ * used in at most one consumer destination.
630
+ */
631
+ consumerDestinations?: LoggingDestination[];
632
+ /**
633
+ * 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
634
+ * used in at most one producer destination.
635
+ */
636
+ producerDestinations?: LoggingDestination[];
637
+ }
638
+ interface LoggingDestination {
639
+ /**
640
+ * 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
641
+ * prefixed with the service name followed by "/".
642
+ */
643
+ logs?: string[];
644
+ /** The monitored resource type. The type must be defined in the Service.monitored_resources section. */
645
+ monitoredResource?: string;
646
+ }
647
+ interface Method {
648
+ /** The simple name of this method. */
649
+ name?: string;
650
+ /** Any metadata attached to the method. */
651
+ options?: Option[];
652
+ /** If true, the request is streamed. */
653
+ requestStreaming?: boolean;
654
+ /** A URL of the input message type. */
655
+ requestTypeUrl?: string;
656
+ /** If true, the response is streamed. */
657
+ responseStreaming?: boolean;
658
+ /** The URL of the output message type. */
659
+ responseTypeUrl?: string;
660
+ /** The source syntax of this method. */
661
+ syntax?: string;
662
+ }
663
+ interface MetricDescriptor {
664
+ /** A detailed description of the metric, which can be used in documentation. */
665
+ description?: string;
666
+ /**
667
+ * 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
668
+ * recommended to be set for any metrics associated with user-visible concepts, such as Quota.
669
+ */
670
+ displayName?: string;
671
+ /**
672
+ * 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
673
+ * label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.
674
+ */
675
+ labels?: LabelDescriptor[];
676
+ /** Optional. The launch stage of the metric definition. */
677
+ launchStage?: string;
678
+ /** Optional. Metadata which can be used to guide usage of the metric. */
679
+ metadata?: MetricDescriptorMetadata;
680
+ /** Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */
681
+ metricKind?: string;
682
+ /**
683
+ * 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
684
+ * associated with one of the monitored resource types listed here.
685
+ */
686
+ monitoredResourceTypes?: string[];
687
+ /** The resource name of the metric descriptor. */
688
+ name?: string;
689
+ /**
690
+ * 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`.
691
+ * Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up"
692
+ * "appengine.googleapis.com/http/server/response_latencies"
693
+ */
694
+ type?: string;
695
+ /**
696
+ * 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
697
+ * 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_
698
+ * be displayed as `3.5MBy`). However, if the `unit` is `kBy`, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom
699
+ * metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the
700
+ * job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE
701
+ * CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported
702
+ * units are a subset of [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min`
703
+ * minute * `h` hour * `d` day * `1` dimensionless **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) *
704
+ * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) *
705
+ * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/`
706
+ * division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed
707
+ * at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a
708
+ * unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}"
709
+ * ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`,
710
+ * `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless
711
+ * unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, "new users per
712
+ * day" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as
713
+ * `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean "5300 page views per day"). * `%` represents dimensionless value of 1/100, and annotates values
714
+ * 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
715
+ * 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").
716
+ */
717
+ unit?: string;
718
+ /** Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */
719
+ valueType?: string;
720
+ }
721
+ interface MetricDescriptorMetadata {
722
+ /** 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. */
723
+ ingestDelay?: string;
724
+ /** Deprecated. Must use the MetricDescriptor.launch_stage instead. */
725
+ launchStage?: string;
726
+ /**
727
+ * 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.
728
+ * Metrics with a higher granularity have a smaller sampling period.
729
+ */
730
+ samplePeriod?: string;
731
+ }
732
+ interface MetricRule {
733
+ /**
734
+ * 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
735
+ * increased for the metric against which the quota limits are defined. The value must not be negative.
736
+ */
737
+ metricCosts?: { [P in string]: string };
738
+ /** Selects the methods to which this rule applies. Refer to selector for syntax details. */
739
+ selector?: string;
740
+ }
741
+ interface Mixin {
742
+ /** The fully qualified name of the interface which is included. */
743
+ name?: string;
744
+ /** If non-empty specifies a path under which inherited HTTP paths are rooted. */
745
+ root?: string;
746
+ }
747
+ interface MonitoredResourceDescriptor {
748
+ /** Optional. A detailed description of the monitored resource type that might be used in documentation. */
749
+ description?: string;
750
+ /**
751
+ * 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
752
+ * determiners. For example, `"Google Cloud SQL Database"`.
753
+ */
754
+ displayName?: string;
755
+ /**
756
+ * 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
757
+ * `"database_id"` and `"zone"`.
758
+ */
759
+ labels?: LabelDescriptor[];
760
+ /** Optional. The launch stage of the monitored resource definition. */
761
+ launchStage?: string;
762
+ /**
763
+ * 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
764
+ * 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
765
+ * `"monitoredResourceDescriptors/{type}"`.
766
+ */
767
+ name?: string;
768
+ /**
769
+ * 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
770
+ * types](https://cloud.google.com/monitoring/api/resources) and [Logging resource types](https://cloud.google.com/logging/docs/api/v2/resource-list).
771
+ */
772
+ type?: string;
773
+ }
774
+ interface Monitoring {
775
+ /**
776
+ * Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring
777
+ * 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
778
+ * once in the Monitoring configuration.
779
+ */
780
+ consumerDestinations?: MonitoringDestination[];
781
+ /**
782
+ * Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring
783
+ * 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
784
+ * once in the Monitoring configuration.
785
+ */
786
+ producerDestinations?: MonitoringDestination[];
787
+ }
788
+ interface MonitoringDestination {
789
+ /** Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section. */
790
+ metrics?: string[];
791
+ /** The monitored resource type. The type must be defined in Service.monitored_resources section. */
792
+ monitoredResource?: string;
793
+ }
794
+ interface OAuthRequirements {
795
+ /**
796
+ * 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:
797
+ * https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
798
+ */
799
+ canonicalScopes?: string;
800
+ }
801
+ interface Operation {
802
+ /** 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. */
803
+ done?: boolean;
804
+ /** The error result of the operation in case of failure or cancellation. */
805
+ error?: Status;
806
+ /**
807
+ * 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
808
+ * metadata. Any method that returns a long-running operation should document the metadata type, if any.
809
+ */
810
+ metadata?: { [P in string]: any };
811
+ /**
812
+ * 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
813
+ * with `operations/{unique_id}`.
814
+ */
815
+ name?: string;
816
+ /**
817
+ * 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
818
+ * 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
819
+ * original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
820
+ */
821
+ response?: { [P in string]: any };
822
+ }
823
+ interface OperationMetadata {
824
+ /** The full name of the resources that this operation is directly associated with. */
825
+ resourceNames?: string[];
826
+ }
827
+ interface Option {
828
+ /**
829
+ * 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
830
+ * fully-qualified name. For example, `"google.api.http"`.
831
+ */
832
+ name?: string;
833
+ /**
834
+ * 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
835
+ * enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
836
+ */
837
+ value?: { [P in string]: any };
838
+ }
839
+ interface Page {
840
+ /**
841
+ * 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
842
+ * format page.
843
+ */
844
+ content?: string;
845
+ /**
846
+ * 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
847
+ * 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
848
+ * ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`.
849
+ */
850
+ name?: string;
851
+ /** Subpages of this page. The order of subpages specified here will be honored in the generated docset. */
852
+ subpages?: Page[];
853
+ }
854
+ interface Quota {
855
+ /** List of `QuotaLimit` definitions for the service. */
856
+ limits?: QuotaLimit[];
857
+ /** List of `MetricRule` definitions, each one mapping a selected method to one or more metrics. */
858
+ metricRules?: MetricRule[];
859
+ }
860
+ interface QuotaLimit {
861
+ /**
862
+ * Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for
863
+ * 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
864
+ * will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.
865
+ */
866
+ defaultLimit?: string;
867
+ /**
868
+ * 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
869
+ * (see: `display_name`).
870
+ */
871
+ description?: string;
872
+ /**
873
+ * 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
874
+ * default display name generated from the configuration.
875
+ */
876
+ displayName?: string;
877
+ /** Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only. */
878
+ duration?: string;
879
+ /**
880
+ * 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.
881
+ * 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
882
+ * no free tier for this service. Used by group-based quotas only.
883
+ */
884
+ freeTier?: string;
885
+ /**
886
+ * 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
887
+ * 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
888
+ * -1, indicating unlimited maximum quota. Used by group-based quotas only.
889
+ */
890
+ maxLimit?: string;
891
+ /**
892
+ * 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
893
+ * config.
894
+ */
895
+ metric?: string;
896
+ /**
897
+ * 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
898
+ * the limit name is 64 characters.
899
+ */
900
+ name?: string;
901
+ /**
902
+ * 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: *
903
+ * "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.
904
+ */
905
+ unit?: string;
906
+ /**
907
+ * 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
908
+ * is supported.
909
+ */
910
+ values?: { [P in string]: string };
911
+ }
912
+ interface QuotaOverride {
913
+ /** The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. */
914
+ adminOverrideAncestor?: string;
915
+ /**
916
+ * 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
917
+ * `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
918
+ * following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a
919
+ * defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that
920
+ * 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
921
+ * 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.
922
+ */
923
+ dimensions?: { [P in string]: string };
924
+ /** The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` */
925
+ metric?: string;
926
+ /**
927
+ * The resource name of the override. This name is generated by the server when the override is created. Example names would be:
928
+ * `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
929
+ * `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` The resource name is intended
930
+ * to be opaque and should not be parsed for its component strings, since its representation could change in the future.
931
+ */
932
+ name?: string;
933
+ /** The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota). */
934
+ overrideValue?: string;
935
+ /**
936
+ * 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
937
+ * example; the literal characters `{` and `}` occur in the string.
938
+ */
939
+ unit?: string;
940
+ }
941
+ interface ServiceIdentity {
942
+ /** The email address of the service account that a service producer would use to access consumer resources. */
943
+ email?: string;
944
+ /** The unique and stable id of the service account. https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount */
945
+ uniqueId?: string;
946
+ }
947
+ interface SourceContext {
948
+ /** The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`. */
949
+ fileName?: string;
950
+ }
951
+ interface SourceInfo {
952
+ /** All files used during config generation. */
953
+ sourceFiles?: Array<{ [P in string]: any }>;
954
+ }
955
+ interface Status {
956
+ /** The status code, which should be an enum value of google.rpc.Code. */
957
+ code?: number;
958
+ /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
959
+ details?: Array<{ [P in string]: any }>;
960
+ /**
961
+ * 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
962
+ * client.
963
+ */
964
+ message?: string;
965
+ }
966
+ interface SystemParameter {
967
+ /** Define the HTTP header name to use for the parameter. It is case insensitive. */
968
+ httpHeader?: string;
969
+ /** Define the name of the parameter, such as "api_key" . It is case sensitive. */
970
+ name?: string;
971
+ /** Define the URL query parameter name to use for the parameter. It is case sensitive. */
972
+ urlQueryParameter?: string;
973
+ }
974
+ interface SystemParameterRule {
975
+ /**
976
+ * 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
977
+ * implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
978
+ */
979
+ parameters?: SystemParameter[];
980
+ /** Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */
981
+ selector?: string;
982
+ }
983
+ interface SystemParameters {
984
+ /**
985
+ * Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default
986
+ * system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*"
987
+ * 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: -
988
+ * name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:** All service configuration rules follow "last one wins" order.
989
+ */
990
+ rules?: SystemParameterRule[];
991
+ }
992
+ interface Type {
993
+ /** The list of fields. */
994
+ fields?: Field[];
995
+ /** The fully qualified message name. */
996
+ name?: string;
997
+ /** The list of types appearing in `oneof` definitions in this type. */
998
+ oneofs?: string[];
999
+ /** The protocol buffer options. */
1000
+ options?: Option[];
1001
+ /** The source context. */
1002
+ sourceContext?: SourceContext;
1003
+ /** The source syntax. */
1004
+ syntax?: string;
1005
+ }
1006
+ // tslint:disable-next-line:no-empty-interface
1007
+ interface UpdateAdminQuotaPolicyMetadata {
1008
+ }
1009
+ interface Usage {
1010
+ /**
1011
+ * The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud
1012
+ * 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
1013
+ * Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.
1014
+ */
1015
+ producerNotificationChannel?: string;
1016
+ /**
1017
+ * 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
1018
+ * 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
1019
+ * "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.
1020
+ */
1021
+ requirements?: string[];
1022
+ /** A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */
1023
+ rules?: UsageRule[];
1024
+ }
1025
+ interface UsageRule {
1026
+ /** If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. */
1027
+ allowUnregisteredCalls?: boolean;
1028
+ /** Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */
1029
+ selector?: string;
1030
+ /**
1031
+ * 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
1032
+ * Endpoints to bypass checks for internal methods, such as service health check methods.
1033
+ */
1034
+ skipServiceControl?: boolean;
1035
+ }
1036
+ interface OperationsResource {
1037
+ /**
1038
+ * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support
1039
+ * this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the
1040
+ * operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a
1041
+ * google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
1042
+ */
1043
+ cancel(request: {
1044
+ /** V1 error format. */
1045
+ "$.xgafv"?: string;
1046
+ /** OAuth access token. */
1047
+ access_token?: string;
1048
+ /** Data format for response. */
1049
+ alt?: string;
1050
+ /** JSONP */
1051
+ callback?: string;
1052
+ /** Selector specifying which fields to include in a partial response. */
1053
+ fields?: string;
1054
+ /** 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. */
1055
+ key?: string;
1056
+ /** The name of the operation resource to be cancelled. */
1057
+ name: string;
1058
+ /** OAuth 2.0 token for the current user. */
1059
+ oauth_token?: string;
1060
+ /** Returns response with indentations and line breaks. */
1061
+ prettyPrint?: boolean;
1062
+ /** 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. */
1063
+ quotaUser?: string;
1064
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1065
+ upload_protocol?: string;
1066
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1067
+ uploadType?: string;
1068
+ /** Request body */
1069
+ resource: CancelOperationRequest;
1070
+ }): Request<{}>;
1071
+ cancel(request: {
1072
+ /** V1 error format. */
1073
+ "$.xgafv"?: string;
1074
+ /** OAuth access token. */
1075
+ access_token?: string;
1076
+ /** Data format for response. */
1077
+ alt?: string;
1078
+ /** JSONP */
1079
+ callback?: string;
1080
+ /** Selector specifying which fields to include in a partial response. */
1081
+ fields?: string;
1082
+ /** 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. */
1083
+ key?: string;
1084
+ /** The name of the operation resource to be cancelled. */
1085
+ name: string;
1086
+ /** OAuth 2.0 token for the current user. */
1087
+ oauth_token?: string;
1088
+ /** Returns response with indentations and line breaks. */
1089
+ prettyPrint?: boolean;
1090
+ /** 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. */
1091
+ quotaUser?: string;
1092
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1093
+ upload_protocol?: string;
1094
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1095
+ uploadType?: string;
1096
+ },
1097
+ body: CancelOperationRequest): Request<{}>;
1098
+ /**
1099
+ * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't
1100
+ * support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
1101
+ */
1102
+ delete(request?: {
1103
+ /** V1 error format. */
1104
+ "$.xgafv"?: string;
1105
+ /** OAuth access token. */
1106
+ access_token?: string;
1107
+ /** Data format for response. */
1108
+ alt?: string;
1109
+ /** JSONP */
1110
+ callback?: string;
1111
+ /** Selector specifying which fields to include in a partial response. */
1112
+ fields?: string;
1113
+ /** 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. */
1114
+ key?: string;
1115
+ /** The name of the operation resource to be deleted. */
1116
+ name: string;
1117
+ /** OAuth 2.0 token for the current user. */
1118
+ oauth_token?: string;
1119
+ /** Returns response with indentations and line breaks. */
1120
+ prettyPrint?: boolean;
1121
+ /** 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. */
1122
+ quotaUser?: string;
1123
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1124
+ upload_protocol?: string;
1125
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1126
+ uploadType?: string;
1127
+ }): Request<{}>;
1128
+ /** 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. */
1129
+ get(request?: {
1130
+ /** V1 error format. */
1131
+ "$.xgafv"?: string;
1132
+ /** OAuth access token. */
1133
+ access_token?: string;
1134
+ /** Data format for response. */
1135
+ alt?: string;
1136
+ /** JSONP */
1137
+ callback?: string;
1138
+ /** Selector specifying which fields to include in a partial response. */
1139
+ fields?: string;
1140
+ /** 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. */
1141
+ key?: string;
1142
+ /** The name of the operation resource. */
1143
+ name: string;
1144
+ /** OAuth 2.0 token for the current user. */
1145
+ oauth_token?: string;
1146
+ /** Returns response with indentations and line breaks. */
1147
+ prettyPrint?: boolean;
1148
+ /** 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. */
1149
+ quotaUser?: string;
1150
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1151
+ upload_protocol?: string;
1152
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1153
+ uploadType?: string;
1154
+ }): Request<Operation>;
1155
+ /**
1156
+ * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
1157
+ * to override the binding to use different resource name schemes, such as `users/*‍/operations`. To override the binding, API services can add a binding such as
1158
+ * `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
1159
+ * ensure the name binding is the parent resource, without the operations collection id.
1160
+ */
1161
+ list(request?: {
1162
+ /** V1 error format. */
1163
+ "$.xgafv"?: string;
1164
+ /** OAuth access token. */
1165
+ access_token?: string;
1166
+ /** Data format for response. */
1167
+ alt?: string;
1168
+ /** JSONP */
1169
+ callback?: string;
1170
+ /** Selector specifying which fields to include in a partial response. */
1171
+ fields?: string;
1172
+ /** The standard list filter. */
1173
+ filter?: string;
1174
+ /** 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. */
1175
+ key?: string;
1176
+ /** The name of the operation's parent resource. */
1177
+ name?: string;
1178
+ /** OAuth 2.0 token for the current user. */
1179
+ oauth_token?: string;
1180
+ /** The standard list page size. */
1181
+ pageSize?: number;
1182
+ /** The standard list page token. */
1183
+ pageToken?: string;
1184
+ /** Returns response with indentations and line breaks. */
1185
+ prettyPrint?: boolean;
1186
+ /** 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. */
1187
+ quotaUser?: string;
1188
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1189
+ upload_protocol?: string;
1190
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1191
+ uploadType?: string;
1192
+ }): Request<ListOperationsResponse>;
1193
+ }
1194
+ interface ServicesResource {
1195
+ /**
1196
+ * Enable multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur. To enable a single service,
1197
+ * use the `EnableService` method instead.
1198
+ */
1199
+ batchEnable(request: {
1200
+ /** V1 error format. */
1201
+ "$.xgafv"?: string;
1202
+ /** OAuth access token. */
1203
+ access_token?: string;
1204
+ /** Data format for response. */
1205
+ alt?: string;
1206
+ /** JSONP */
1207
+ callback?: string;
1208
+ /** Selector specifying which fields to include in a partial response. */
1209
+ fields?: string;
1210
+ /** 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. */
1211
+ key?: string;
1212
+ /** OAuth 2.0 token for the current user. */
1213
+ oauth_token?: string;
1214
+ /** 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. */
1215
+ parent: string;
1216
+ /** Returns response with indentations and line breaks. */
1217
+ prettyPrint?: boolean;
1218
+ /** 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. */
1219
+ quotaUser?: string;
1220
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1221
+ upload_protocol?: string;
1222
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1223
+ uploadType?: string;
1224
+ /** Request body */
1225
+ resource: BatchEnableServicesRequest;
1226
+ }): Request<Operation>;
1227
+ batchEnable(request: {
1228
+ /** V1 error format. */
1229
+ "$.xgafv"?: string;
1230
+ /** OAuth access token. */
1231
+ access_token?: string;
1232
+ /** Data format for response. */
1233
+ alt?: string;
1234
+ /** JSONP */
1235
+ callback?: string;
1236
+ /** Selector specifying which fields to include in a partial response. */
1237
+ fields?: string;
1238
+ /** 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. */
1239
+ key?: string;
1240
+ /** OAuth 2.0 token for the current user. */
1241
+ oauth_token?: string;
1242
+ /** 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. */
1243
+ parent: string;
1244
+ /** Returns response with indentations and line breaks. */
1245
+ prettyPrint?: boolean;
1246
+ /** 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. */
1247
+ quotaUser?: string;
1248
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1249
+ upload_protocol?: string;
1250
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1251
+ uploadType?: string;
1252
+ },
1253
+ body: BatchEnableServicesRequest): Request<Operation>;
1254
+ /** Returns the service configurations and enabled states for a given list of services. */
1255
+ batchGet(request?: {
1256
+ /** V1 error format. */
1257
+ "$.xgafv"?: string;
1258
+ /** OAuth access token. */
1259
+ access_token?: string;
1260
+ /** Data format for response. */
1261
+ alt?: string;
1262
+ /** JSONP */
1263
+ callback?: string;
1264
+ /** Selector specifying which fields to include in a partial response. */
1265
+ fields?: string;
1266
+ /** 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. */
1267
+ key?: string;
1268
+ /**
1269
+ * 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
1270
+ * maximum of 30 services at a time.
1271
+ */
1272
+ names?: string | string[];
1273
+ /** OAuth 2.0 token for the current user. */
1274
+ oauth_token?: string;
1275
+ /**
1276
+ * 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
1277
+ * `123` is the project number. The `BatchGetServices` method currently only supports projects.
1278
+ */
1279
+ parent: string;
1280
+ /** Returns response with indentations and line breaks. */
1281
+ prettyPrint?: boolean;
1282
+ /** 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. */
1283
+ quotaUser?: string;
1284
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1285
+ upload_protocol?: string;
1286
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1287
+ uploadType?: string;
1288
+ }): Request<BatchGetServicesResponse>;
1289
+ /**
1290
+ * 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
1291
+ * call the disable method on a service that is not currently enabled. Callers will receive a `FAILED_PRECONDITION` status if the target service is not currently enabled.
1292
+ */
1293
+ disable(request: {
1294
+ /** V1 error format. */
1295
+ "$.xgafv"?: string;
1296
+ /** OAuth access token. */
1297
+ access_token?: string;
1298
+ /** Data format for response. */
1299
+ alt?: string;
1300
+ /** JSONP */
1301
+ callback?: string;
1302
+ /** Selector specifying which fields to include in a partial response. */
1303
+ fields?: string;
1304
+ /** 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. */
1305
+ key?: string;
1306
+ /**
1307
+ * 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:
1308
+ * `projects/123/services/serviceusage.googleapis.com` where `123` is the project number.
1309
+ */
1310
+ name: string;
1311
+ /** OAuth 2.0 token for the current user. */
1312
+ oauth_token?: string;
1313
+ /** Returns response with indentations and line breaks. */
1314
+ prettyPrint?: boolean;
1315
+ /** 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. */
1316
+ quotaUser?: string;
1317
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1318
+ upload_protocol?: string;
1319
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1320
+ uploadType?: string;
1321
+ /** Request body */
1322
+ resource: DisableServiceRequest;
1323
+ }): Request<Operation>;
1324
+ disable(request: {
1325
+ /** V1 error format. */
1326
+ "$.xgafv"?: string;
1327
+ /** OAuth access token. */
1328
+ access_token?: string;
1329
+ /** Data format for response. */
1330
+ alt?: string;
1331
+ /** JSONP */
1332
+ callback?: string;
1333
+ /** Selector specifying which fields to include in a partial response. */
1334
+ fields?: string;
1335
+ /** 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. */
1336
+ key?: string;
1337
+ /**
1338
+ * 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:
1339
+ * `projects/123/services/serviceusage.googleapis.com` where `123` is the project number.
1340
+ */
1341
+ name: string;
1342
+ /** OAuth 2.0 token for the current user. */
1343
+ oauth_token?: string;
1344
+ /** Returns response with indentations and line breaks. */
1345
+ prettyPrint?: boolean;
1346
+ /** 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. */
1347
+ quotaUser?: string;
1348
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1349
+ upload_protocol?: string;
1350
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1351
+ uploadType?: string;
1352
+ },
1353
+ body: DisableServiceRequest): Request<Operation>;
1354
+ /** Enable a service so that it can be used with a project. */
1355
+ enable(request: {
1356
+ /** V1 error format. */
1357
+ "$.xgafv"?: string;
1358
+ /** OAuth access token. */
1359
+ access_token?: string;
1360
+ /** Data format for response. */
1361
+ alt?: string;
1362
+ /** JSONP */
1363
+ callback?: string;
1364
+ /** Selector specifying which fields to include in a partial response. */
1365
+ fields?: string;
1366
+ /** 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. */
1367
+ key?: string;
1368
+ /**
1369
+ * 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
1370
+ * 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
1371
+ * number.
1372
+ */
1373
+ name: string;
1374
+ /** OAuth 2.0 token for the current user. */
1375
+ oauth_token?: string;
1376
+ /** Returns response with indentations and line breaks. */
1377
+ prettyPrint?: boolean;
1378
+ /** 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. */
1379
+ quotaUser?: string;
1380
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1381
+ upload_protocol?: string;
1382
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1383
+ uploadType?: string;
1384
+ /** Request body */
1385
+ resource: EnableServiceRequest;
1386
+ }): Request<Operation>;
1387
+ enable(request: {
1388
+ /** V1 error format. */
1389
+ "$.xgafv"?: string;
1390
+ /** OAuth access token. */
1391
+ access_token?: string;
1392
+ /** Data format for response. */
1393
+ alt?: string;
1394
+ /** JSONP */
1395
+ callback?: string;
1396
+ /** Selector specifying which fields to include in a partial response. */
1397
+ fields?: string;
1398
+ /** 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. */
1399
+ key?: string;
1400
+ /**
1401
+ * 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
1402
+ * 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
1403
+ * number.
1404
+ */
1405
+ name: string;
1406
+ /** OAuth 2.0 token for the current user. */
1407
+ oauth_token?: string;
1408
+ /** Returns response with indentations and line breaks. */
1409
+ prettyPrint?: boolean;
1410
+ /** 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. */
1411
+ quotaUser?: string;
1412
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1413
+ upload_protocol?: string;
1414
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1415
+ uploadType?: string;
1416
+ },
1417
+ body: EnableServiceRequest): Request<Operation>;
1418
+ /** Returns the service configuration and enabled state for a given service. */
1419
+ get(request?: {
1420
+ /** V1 error format. */
1421
+ "$.xgafv"?: string;
1422
+ /** OAuth access token. */
1423
+ access_token?: string;
1424
+ /** Data format for response. */
1425
+ alt?: string;
1426
+ /** JSONP */
1427
+ callback?: string;
1428
+ /** Selector specifying which fields to include in a partial response. */
1429
+ fields?: string;
1430
+ /** 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. */
1431
+ key?: string;
1432
+ /** 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. */
1433
+ name: string;
1434
+ /** OAuth 2.0 token for the current user. */
1435
+ oauth_token?: string;
1436
+ /** Returns response with indentations and line breaks. */
1437
+ prettyPrint?: boolean;
1438
+ /** 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. */
1439
+ quotaUser?: string;
1440
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1441
+ upload_protocol?: string;
1442
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1443
+ uploadType?: string;
1444
+ }): Request<GoogleApiServiceusageV1Service>;
1445
+ /**
1446
+ * 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
1447
+ * which the calling user has the `servicemanagement.services.bind` permission, and all services that have already been enabled on the project. The list can be filtered to only include
1448
+ * services in a specific state, for example to only include services enabled on the project. WARNING: If you need to query enabled services frequently or across an organization, you
1449
+ * should use [Cloud Asset Inventory API](https://cloud.google.com/asset-inventory/docs/apis), which provides higher throughput and richer filtering capability.
1450
+ */
1451
+ list(request?: {
1452
+ /** V1 error format. */
1453
+ "$.xgafv"?: string;
1454
+ /** OAuth access token. */
1455
+ access_token?: string;
1456
+ /** Data format for response. */
1457
+ alt?: string;
1458
+ /** JSONP */
1459
+ callback?: string;
1460
+ /** Selector specifying which fields to include in a partial response. */
1461
+ fields?: string;
1462
+ /** Only list services that conform to the given filter. The allowed filter strings are `state:ENABLED` and `state:DISABLED`. */
1463
+ filter?: string;
1464
+ /** 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. */
1465
+ key?: string;
1466
+ /** OAuth 2.0 token for the current user. */
1467
+ oauth_token?: string;
1468
+ /** Requested size of the next page of data. Requested page size cannot exceed 200. If not set, the default page size is 50. */
1469
+ pageSize?: number;
1470
+ /** Token identifying which result to start with, which is returned by a previous list call. */
1471
+ pageToken?: string;
1472
+ /** Parent to search for services on. An example name would be: `projects/123` where `123` is the project number. */
1473
+ parent: string;
1474
+ /** Returns response with indentations and line breaks. */
1475
+ prettyPrint?: boolean;
1476
+ /** 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. */
1477
+ quotaUser?: string;
1478
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1479
+ upload_protocol?: string;
1480
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1481
+ uploadType?: string;
1482
+ }): Request<ListServicesResponse>;
1483
+ }
1484
+
1485
+ const operations: OperationsResource;
1486
+
1487
+ const services: ServicesResource;
1488
+ }
1489
+ }