@googleapis/serviceusage 5.0.0 → 8.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +44 -0
- package/build/index.js +5 -4
- package/build/index.js.map +1 -1
- package/build/v1.d.ts +413 -519
- package/build/v1.js +21 -20
- package/build/v1.js.map +1 -1
- package/build/v1beta1.d.ts +449 -1206
- package/build/v1beta1.js +43 -42
- package/build/v1beta1.js.map +1 -1
- package/index.ts +1 -1
- package/package.json +6 -6
- package/v1.ts +400 -519
- package/v1beta1.ts +434 -1206
package/build/v1beta1.d.ts
CHANGED
|
@@ -72,6 +72,24 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
72
72
|
services: Resource$Services;
|
|
73
73
|
constructor(options: GlobalOptions, google?: GoogleConfigurable);
|
|
74
74
|
}
|
|
75
|
+
/**
|
|
76
|
+
* Metadata for the `AddEnableRules` method.
|
|
77
|
+
*/
|
|
78
|
+
export interface Schema$AddEnableRulesMetadata {
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* The response message of "AddEnableRules" method.
|
|
82
|
+
*/
|
|
83
|
+
export interface Schema$AddEnableRulesResponse {
|
|
84
|
+
/**
|
|
85
|
+
* The values added to the parent consumer policy.
|
|
86
|
+
*/
|
|
87
|
+
addedValues?: string[] | null;
|
|
88
|
+
/**
|
|
89
|
+
* The parent consumer policy. It can be `projects/12345/consumerPolicies/default`, or `folders/12345/consumerPolicies/default`, or `organizations/12345/consumerPolicies/default`.
|
|
90
|
+
*/
|
|
91
|
+
parent?: string | null;
|
|
92
|
+
}
|
|
75
93
|
/**
|
|
76
94
|
* Quota policy created by quota administrator.
|
|
77
95
|
*/
|
|
@@ -81,7 +99,7 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
81
99
|
*/
|
|
82
100
|
container?: string | null;
|
|
83
101
|
/**
|
|
84
|
-
* If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example,
|
|
102
|
+
* If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit `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 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 `region` or `zone` are not valid.
|
|
85
103
|
*/
|
|
86
104
|
dimensions?: {
|
|
87
105
|
[key: string]: string;
|
|
@@ -241,10 +259,20 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
241
259
|
* 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.
|
|
242
260
|
*/
|
|
243
261
|
jwtAudience?: string | null;
|
|
262
|
+
/**
|
|
263
|
+
* Deprecated, do not use.
|
|
264
|
+
*/
|
|
265
|
+
minDeadline?: number | null;
|
|
244
266
|
/**
|
|
245
267
|
* The number of seconds to wait for the completion of a long running operation. The default is no deadline.
|
|
246
268
|
*/
|
|
247
269
|
operationDeadline?: number | null;
|
|
270
|
+
/**
|
|
271
|
+
* The map between request protocol and the backend address.
|
|
272
|
+
*/
|
|
273
|
+
overridesByRequestProtocol?: {
|
|
274
|
+
[key: string]: Schema$BackendRule;
|
|
275
|
+
} | null;
|
|
248
276
|
pathTranslation?: string | null;
|
|
249
277
|
/**
|
|
250
278
|
* 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 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. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.
|
|
@@ -317,6 +345,95 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
317
345
|
*/
|
|
318
346
|
monitoredResource?: string | null;
|
|
319
347
|
}
|
|
348
|
+
/**
|
|
349
|
+
* Details about how and where to publish client libraries.
|
|
350
|
+
*/
|
|
351
|
+
export interface Schema$ClientLibrarySettings {
|
|
352
|
+
/**
|
|
353
|
+
* Settings for C++ client libraries.
|
|
354
|
+
*/
|
|
355
|
+
cppSettings?: Schema$CppSettings;
|
|
356
|
+
/**
|
|
357
|
+
* Settings for .NET client libraries.
|
|
358
|
+
*/
|
|
359
|
+
dotnetSettings?: Schema$DotnetSettings;
|
|
360
|
+
/**
|
|
361
|
+
* Settings for Go client libraries.
|
|
362
|
+
*/
|
|
363
|
+
goSettings?: Schema$GoSettings;
|
|
364
|
+
/**
|
|
365
|
+
* Settings for legacy Java features, supported in the Service YAML.
|
|
366
|
+
*/
|
|
367
|
+
javaSettings?: Schema$JavaSettings;
|
|
368
|
+
/**
|
|
369
|
+
* Launch stage of this version of the API.
|
|
370
|
+
*/
|
|
371
|
+
launchStage?: string | null;
|
|
372
|
+
/**
|
|
373
|
+
* Settings for Node client libraries.
|
|
374
|
+
*/
|
|
375
|
+
nodeSettings?: Schema$NodeSettings;
|
|
376
|
+
/**
|
|
377
|
+
* Settings for PHP client libraries.
|
|
378
|
+
*/
|
|
379
|
+
phpSettings?: Schema$PhpSettings;
|
|
380
|
+
/**
|
|
381
|
+
* Settings for Python client libraries.
|
|
382
|
+
*/
|
|
383
|
+
pythonSettings?: Schema$PythonSettings;
|
|
384
|
+
/**
|
|
385
|
+
* When using transport=rest, the client request will encode enums as numbers rather than strings.
|
|
386
|
+
*/
|
|
387
|
+
restNumericEnums?: boolean | null;
|
|
388
|
+
/**
|
|
389
|
+
* Settings for Ruby client libraries.
|
|
390
|
+
*/
|
|
391
|
+
rubySettings?: Schema$RubySettings;
|
|
392
|
+
/**
|
|
393
|
+
* 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 "google.spanner.admin.database.v1".
|
|
394
|
+
*/
|
|
395
|
+
version?: string | null;
|
|
396
|
+
}
|
|
397
|
+
/**
|
|
398
|
+
* Required information for every language.
|
|
399
|
+
*/
|
|
400
|
+
export interface Schema$CommonLanguageSettings {
|
|
401
|
+
/**
|
|
402
|
+
* The destination where API teams want this client library to be published.
|
|
403
|
+
*/
|
|
404
|
+
destinations?: string[] | null;
|
|
405
|
+
/**
|
|
406
|
+
* Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
|
|
407
|
+
*/
|
|
408
|
+
referenceDocsUri?: string | null;
|
|
409
|
+
}
|
|
410
|
+
/**
|
|
411
|
+
* Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy.
|
|
412
|
+
*/
|
|
413
|
+
export interface Schema$ConsumerPolicy {
|
|
414
|
+
/**
|
|
415
|
+
* 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 should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations)
|
|
416
|
+
*/
|
|
417
|
+
annotations?: {
|
|
418
|
+
[key: string]: string;
|
|
419
|
+
} | null;
|
|
420
|
+
/**
|
|
421
|
+
* Enable rules define usable services and service groups.
|
|
422
|
+
*/
|
|
423
|
+
enableRules?: Schema$EnableRule[];
|
|
424
|
+
/**
|
|
425
|
+
* An opaque tag indicating the current version of the policy, used for concurrency control.
|
|
426
|
+
*/
|
|
427
|
+
etag?: string | null;
|
|
428
|
+
/**
|
|
429
|
+
* Output only. The resource name of the policy. For example, We only allow consumer policy name as "default" for now: `projects/12345/consumerPolicies/default`, `folders/12345/consumerPolicies/default`, `organizations/12345/consumerPolicies/default`. Legacy format: `projects/12345/consumerPoly`
|
|
430
|
+
*/
|
|
431
|
+
name?: string | null;
|
|
432
|
+
/**
|
|
433
|
+
* The last-modified time.
|
|
434
|
+
*/
|
|
435
|
+
updateTime?: string | null;
|
|
436
|
+
}
|
|
320
437
|
/**
|
|
321
438
|
* Consumer quota settings for a quota limit.
|
|
322
439
|
*/
|
|
@@ -414,13 +531,26 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
414
531
|
selector?: string | null;
|
|
415
532
|
}
|
|
416
533
|
/**
|
|
417
|
-
* Selects and configures the service controller used by the service.
|
|
534
|
+
* Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com
|
|
418
535
|
*/
|
|
419
536
|
export interface Schema$Control {
|
|
420
537
|
/**
|
|
421
538
|
* 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 servicecontrol.googleapis.com
|
|
422
539
|
*/
|
|
423
540
|
environment?: string | null;
|
|
541
|
+
/**
|
|
542
|
+
* Defines policies applying to the API methods of the service.
|
|
543
|
+
*/
|
|
544
|
+
methodPolicies?: Schema$MethodPolicy[];
|
|
545
|
+
}
|
|
546
|
+
/**
|
|
547
|
+
* Settings for C++ client libraries.
|
|
548
|
+
*/
|
|
549
|
+
export interface Schema$CppSettings {
|
|
550
|
+
/**
|
|
551
|
+
* Some settings.
|
|
552
|
+
*/
|
|
553
|
+
common?: Schema$CommonLanguageSettings;
|
|
424
554
|
}
|
|
425
555
|
/**
|
|
426
556
|
* Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by CreateAdminQuotaPolicy.
|
|
@@ -486,7 +616,7 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
486
616
|
service?: Schema$GoogleApiServiceusageV1Service;
|
|
487
617
|
}
|
|
488
618
|
/**
|
|
489
|
-
* `Documentation` provides the information for describing a service. Example: documentation: summary: \> The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages
|
|
619
|
+
* `Documentation` provides the information for describing a service. Example: documentation: summary: \> The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: \> ... - selector: google.calendar.Calendar.Put description: \> ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.
|
|
490
620
|
*/
|
|
491
621
|
export interface Schema$Documentation {
|
|
492
622
|
/**
|
|
@@ -505,6 +635,10 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
505
635
|
* A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
|
|
506
636
|
*/
|
|
507
637
|
rules?: Schema$DocumentationRule[];
|
|
638
|
+
/**
|
|
639
|
+
* Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
|
|
640
|
+
*/
|
|
641
|
+
sectionOverrides?: Schema$Page[];
|
|
508
642
|
/**
|
|
509
643
|
* 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 that show a base that other urls are relative to.
|
|
510
644
|
*/
|
|
@@ -526,11 +660,48 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
526
660
|
* 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 definition of the proto element.
|
|
527
661
|
*/
|
|
528
662
|
description?: string | null;
|
|
663
|
+
/**
|
|
664
|
+
* String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
|
|
665
|
+
*/
|
|
666
|
+
disableReplacementWords?: string | null;
|
|
529
667
|
/**
|
|
530
668
|
* 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 "*", 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 match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.
|
|
531
669
|
*/
|
|
532
670
|
selector?: string | null;
|
|
533
671
|
}
|
|
672
|
+
/**
|
|
673
|
+
* Settings for Dotnet client libraries.
|
|
674
|
+
*/
|
|
675
|
+
export interface Schema$DotnetSettings {
|
|
676
|
+
/**
|
|
677
|
+
* Some settings.
|
|
678
|
+
*/
|
|
679
|
+
common?: Schema$CommonLanguageSettings;
|
|
680
|
+
/**
|
|
681
|
+
* Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
|
|
682
|
+
*/
|
|
683
|
+
forcedNamespaceAliases?: string[] | null;
|
|
684
|
+
/**
|
|
685
|
+
* 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.
|
|
686
|
+
*/
|
|
687
|
+
handwrittenSignatures?: string[] | null;
|
|
688
|
+
/**
|
|
689
|
+
* 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 actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
|
|
690
|
+
*/
|
|
691
|
+
ignoredResources?: string[] | null;
|
|
692
|
+
/**
|
|
693
|
+
* 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 entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
|
|
694
|
+
*/
|
|
695
|
+
renamedResources?: {
|
|
696
|
+
[key: string]: string;
|
|
697
|
+
} | null;
|
|
698
|
+
/**
|
|
699
|
+
* 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: Subscriber to SubscriberServiceApi.
|
|
700
|
+
*/
|
|
701
|
+
renamedServices?: {
|
|
702
|
+
[key: string]: string;
|
|
703
|
+
} | null;
|
|
704
|
+
}
|
|
534
705
|
/**
|
|
535
706
|
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
|
|
536
707
|
*/
|
|
@@ -549,6 +720,27 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
549
720
|
*/
|
|
550
721
|
serviceId?: string | null;
|
|
551
722
|
}
|
|
723
|
+
/**
|
|
724
|
+
* The consumer policy rule that defines usable services and service groups.
|
|
725
|
+
*/
|
|
726
|
+
export interface Schema$EnableRule {
|
|
727
|
+
/**
|
|
728
|
+
* Client and resource project enable type.
|
|
729
|
+
*/
|
|
730
|
+
enableType?: string | null;
|
|
731
|
+
/**
|
|
732
|
+
* 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. Example: `groups/googleServices`.
|
|
733
|
+
*/
|
|
734
|
+
groups?: string[] | null;
|
|
735
|
+
/**
|
|
736
|
+
* DEPRECATED: Please use field `values`. Service should have prefix `services/`. The names of the services that are enabled. Example: `storage.googleapis.com`.
|
|
737
|
+
*/
|
|
738
|
+
services?: string[] | null;
|
|
739
|
+
/**
|
|
740
|
+
* The names of the services or service groups that are enabled. Example: `services/storage.googleapis.com`, groups/googleServices`, groups/allServices`.
|
|
741
|
+
*/
|
|
742
|
+
values?: string[] | null;
|
|
743
|
+
}
|
|
552
744
|
/**
|
|
553
745
|
* Request message for the `EnableService` method.
|
|
554
746
|
*/
|
|
@@ -567,6 +759,10 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
567
759
|
* `Endpoint` describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example: type: google.api.Service name: library-example.googleapis.com endpoints: # Declares network address `https://library-example.googleapis.com` # for service `library-example.googleapis.com`. The `https` scheme # is implicit for all service endpoints. Other schemes may be # supported in the future. - name: library-example.googleapis.com allow_cors: false - name: content-staging-library-example.googleapis.com # Allows HTTP OPTIONS calls to be passed to the API frontend, for it # to decide whether the subsequent cross-origin request is allowed # to proceed. allow_cors: true
|
|
568
760
|
*/
|
|
569
761
|
export interface Schema$Endpoint {
|
|
762
|
+
/**
|
|
763
|
+
* 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. Additional names that this endpoint will be hosted on.
|
|
764
|
+
*/
|
|
765
|
+
aliases?: string[] | null;
|
|
570
766
|
/**
|
|
571
767
|
* 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 HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
|
|
572
768
|
*/
|
|
@@ -584,6 +780,10 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
584
780
|
* Enum type definition.
|
|
585
781
|
*/
|
|
586
782
|
export interface Schema$Enum {
|
|
783
|
+
/**
|
|
784
|
+
* The source edition string, only valid when syntax is SYNTAX_EDITIONS.
|
|
785
|
+
*/
|
|
786
|
+
edition?: string | null;
|
|
587
787
|
/**
|
|
588
788
|
* Enum value definitions.
|
|
589
789
|
*/
|
|
@@ -667,6 +867,23 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
667
867
|
*/
|
|
668
868
|
typeUrl?: string | null;
|
|
669
869
|
}
|
|
870
|
+
/**
|
|
871
|
+
* Google API Policy Annotation This message defines a simple API policy annotation that can be used to annotate API request and response message fields with applicable policies. One field may have multiple applicable policies that must all be satisfied before a request can be processed. This policy annotation is used to generate the overall policy that will be used for automatic runtime policy enforcement and documentation generation.
|
|
872
|
+
*/
|
|
873
|
+
export interface Schema$FieldPolicy {
|
|
874
|
+
/**
|
|
875
|
+
* Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
|
|
876
|
+
*/
|
|
877
|
+
resourcePermission?: string | null;
|
|
878
|
+
/**
|
|
879
|
+
* Specifies the resource type for the resource referred to by the field.
|
|
880
|
+
*/
|
|
881
|
+
resourceType?: string | null;
|
|
882
|
+
/**
|
|
883
|
+
* Selects one or more request or response message fields to apply this `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a `FieldPolicy` is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
|
|
884
|
+
*/
|
|
885
|
+
selector?: string | null;
|
|
886
|
+
}
|
|
670
887
|
/**
|
|
671
888
|
* Metadata for the `GetServiceIdentity` method.
|
|
672
889
|
*/
|
|
@@ -769,6 +986,10 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
769
986
|
* The Google project that owns this service.
|
|
770
987
|
*/
|
|
771
988
|
producerProjectId?: string | null;
|
|
989
|
+
/**
|
|
990
|
+
* Settings for [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from APIs defined as protocol buffers.
|
|
991
|
+
*/
|
|
992
|
+
publishing?: Schema$Publishing;
|
|
772
993
|
/**
|
|
773
994
|
* Quota configuration.
|
|
774
995
|
*/
|
|
@@ -899,6 +1120,15 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
899
1120
|
*/
|
|
900
1121
|
usage?: Schema$Usage;
|
|
901
1122
|
}
|
|
1123
|
+
/**
|
|
1124
|
+
* Settings for Go client libraries.
|
|
1125
|
+
*/
|
|
1126
|
+
export interface Schema$GoSettings {
|
|
1127
|
+
/**
|
|
1128
|
+
* Some settings.
|
|
1129
|
+
*/
|
|
1130
|
+
common?: Schema$CommonLanguageSettings;
|
|
1131
|
+
}
|
|
902
1132
|
/**
|
|
903
1133
|
* Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.
|
|
904
1134
|
*/
|
|
@@ -1033,6 +1263,25 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
1033
1263
|
*/
|
|
1034
1264
|
overrides?: Schema$QuotaOverride[];
|
|
1035
1265
|
}
|
|
1266
|
+
/**
|
|
1267
|
+
* Settings for Java client libraries.
|
|
1268
|
+
*/
|
|
1269
|
+
export interface Schema$JavaSettings {
|
|
1270
|
+
/**
|
|
1271
|
+
* Some settings.
|
|
1272
|
+
*/
|
|
1273
|
+
common?: Schema$CommonLanguageSettings;
|
|
1274
|
+
/**
|
|
1275
|
+
* 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 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: java_settings: library_package: com.google.cloud.pubsub.v1
|
|
1276
|
+
*/
|
|
1277
|
+
libraryPackage?: string | null;
|
|
1278
|
+
/**
|
|
1279
|
+
* 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 (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 configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin
|
|
1280
|
+
*/
|
|
1281
|
+
serviceClassNames?: {
|
|
1282
|
+
[key: string]: string;
|
|
1283
|
+
} | null;
|
|
1284
|
+
}
|
|
1036
1285
|
/**
|
|
1037
1286
|
* Specifies a location to extract JWT from an API request.
|
|
1038
1287
|
*/
|
|
@@ -1183,6 +1432,27 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
1183
1432
|
*/
|
|
1184
1433
|
monitoredResource?: string | null;
|
|
1185
1434
|
}
|
|
1435
|
+
/**
|
|
1436
|
+
* Describes settings to use when generating API methods that use the long-running operation pattern. All default values below are from those used in the client library generators (e.g. [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
|
|
1437
|
+
*/
|
|
1438
|
+
export interface Schema$LongRunning {
|
|
1439
|
+
/**
|
|
1440
|
+
* Initial delay after which the first poll request will be made. Default value: 5 seconds.
|
|
1441
|
+
*/
|
|
1442
|
+
initialPollDelay?: string | null;
|
|
1443
|
+
/**
|
|
1444
|
+
* Maximum time between two subsequent poll requests. Default value: 45 seconds.
|
|
1445
|
+
*/
|
|
1446
|
+
maxPollDelay?: string | null;
|
|
1447
|
+
/**
|
|
1448
|
+
* Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
|
|
1449
|
+
*/
|
|
1450
|
+
pollDelayMultiplier?: number | null;
|
|
1451
|
+
/**
|
|
1452
|
+
* Total polling timeout. Default value: 5 minutes.
|
|
1453
|
+
*/
|
|
1454
|
+
totalPollTimeout?: string | null;
|
|
1455
|
+
}
|
|
1186
1456
|
/**
|
|
1187
1457
|
* Method represents a method of an API interface.
|
|
1188
1458
|
*/
|
|
@@ -1216,6 +1486,32 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
1216
1486
|
*/
|
|
1217
1487
|
syntax?: string | null;
|
|
1218
1488
|
}
|
|
1489
|
+
/**
|
|
1490
|
+
* Defines policies applying to an RPC method.
|
|
1491
|
+
*/
|
|
1492
|
+
export interface Schema$MethodPolicy {
|
|
1493
|
+
/**
|
|
1494
|
+
* Policies that are applicable to the request message.
|
|
1495
|
+
*/
|
|
1496
|
+
requestPolicies?: Schema$FieldPolicy[];
|
|
1497
|
+
/**
|
|
1498
|
+
* Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
|
|
1499
|
+
*/
|
|
1500
|
+
selector?: string | null;
|
|
1501
|
+
}
|
|
1502
|
+
/**
|
|
1503
|
+
* Describes the generator configuration for a method.
|
|
1504
|
+
*/
|
|
1505
|
+
export interface Schema$MethodSettings {
|
|
1506
|
+
/**
|
|
1507
|
+
* Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
|
|
1508
|
+
*/
|
|
1509
|
+
longRunning?: Schema$LongRunning;
|
|
1510
|
+
/**
|
|
1511
|
+
* The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
|
|
1512
|
+
*/
|
|
1513
|
+
selector?: string | null;
|
|
1514
|
+
}
|
|
1219
1515
|
/**
|
|
1220
1516
|
* Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
|
|
1221
1517
|
*/
|
|
@@ -1298,7 +1594,7 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
1298
1594
|
selector?: string | null;
|
|
1299
1595
|
}
|
|
1300
1596
|
/**
|
|
1301
|
-
* Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**\}:getAcl"; \} \} package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**\}"; \} \} Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after
|
|
1597
|
+
* Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**\}:getAcl"; \} \} package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**\}"; \} \} Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**\}:getAcl"; \} ... \} Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**\}:getAcl"; \} ... \}
|
|
1302
1598
|
*/
|
|
1303
1599
|
export interface Schema$Mixin {
|
|
1304
1600
|
/**
|
|
@@ -1365,6 +1661,15 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
1365
1661
|
*/
|
|
1366
1662
|
monitoredResource?: string | null;
|
|
1367
1663
|
}
|
|
1664
|
+
/**
|
|
1665
|
+
* Settings for Node client libraries.
|
|
1666
|
+
*/
|
|
1667
|
+
export interface Schema$NodeSettings {
|
|
1668
|
+
/**
|
|
1669
|
+
* Some settings.
|
|
1670
|
+
*/
|
|
1671
|
+
common?: Schema$CommonLanguageSettings;
|
|
1672
|
+
}
|
|
1368
1673
|
/**
|
|
1369
1674
|
* OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions.
|
|
1370
1675
|
*/
|
|
@@ -1397,7 +1702,7 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
1397
1702
|
*/
|
|
1398
1703
|
name?: string | null;
|
|
1399
1704
|
/**
|
|
1400
|
-
* The normal response of the operation
|
|
1705
|
+
* The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the 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 original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
|
|
1401
1706
|
*/
|
|
1402
1707
|
response?: {
|
|
1403
1708
|
[key: string]: any;
|
|
@@ -1454,15 +1759,109 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
1454
1759
|
subpages?: Schema$Page[];
|
|
1455
1760
|
}
|
|
1456
1761
|
/**
|
|
1457
|
-
*
|
|
1762
|
+
* Settings for Php client libraries.
|
|
1763
|
+
*/
|
|
1764
|
+
export interface Schema$PhpSettings {
|
|
1765
|
+
/**
|
|
1766
|
+
* Some settings.
|
|
1767
|
+
*/
|
|
1768
|
+
common?: Schema$CommonLanguageSettings;
|
|
1769
|
+
}
|
|
1770
|
+
/**
|
|
1771
|
+
* Quota policy created by service producer.
|
|
1772
|
+
*/
|
|
1773
|
+
export interface Schema$ProducerQuotaPolicy {
|
|
1774
|
+
/**
|
|
1775
|
+
* The cloud resource container at which the quota policy is created. The format is `{container_type\}/{container_number\}`
|
|
1776
|
+
*/
|
|
1777
|
+
container?: string | null;
|
|
1778
|
+
/**
|
|
1779
|
+
* If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit `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 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 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 policies that 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 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.
|
|
1780
|
+
*/
|
|
1781
|
+
dimensions?: {
|
|
1782
|
+
[key: string]: string;
|
|
1783
|
+
} | null;
|
|
1784
|
+
/**
|
|
1785
|
+
* The name of the metric to which this policy applies. An example name would be: `compute.googleapis.com/cpus`
|
|
1786
|
+
*/
|
|
1787
|
+
metric?: string | null;
|
|
1788
|
+
/**
|
|
1789
|
+
* The resource name of the policy. This name is generated by the server when the policy is created. Example names would be: `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d`
|
|
1790
|
+
*/
|
|
1791
|
+
name?: string | null;
|
|
1792
|
+
/**
|
|
1793
|
+
* The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota).
|
|
1794
|
+
*/
|
|
1795
|
+
policyValue?: string | null;
|
|
1796
|
+
/**
|
|
1797
|
+
* 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; the literal characters `{` and `\}` occur in the string.
|
|
1798
|
+
*/
|
|
1799
|
+
unit?: string | null;
|
|
1800
|
+
}
|
|
1801
|
+
/**
|
|
1802
|
+
* This message configures the settings for publishing [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from the service config.
|
|
1803
|
+
*/
|
|
1804
|
+
export interface Schema$Publishing {
|
|
1805
|
+
/**
|
|
1806
|
+
* Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
|
|
1807
|
+
*/
|
|
1808
|
+
apiShortName?: string | null;
|
|
1809
|
+
/**
|
|
1810
|
+
* GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
|
|
1811
|
+
*/
|
|
1812
|
+
codeownerGithubTeams?: string[] | null;
|
|
1813
|
+
/**
|
|
1814
|
+
* A prefix used in sample code when demarking regions to be included in documentation.
|
|
1815
|
+
*/
|
|
1816
|
+
docTagPrefix?: string | null;
|
|
1817
|
+
/**
|
|
1818
|
+
* Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
|
|
1819
|
+
*/
|
|
1820
|
+
documentationUri?: string | null;
|
|
1821
|
+
/**
|
|
1822
|
+
* GitHub label to apply to issues and pull requests opened for this API.
|
|
1823
|
+
*/
|
|
1824
|
+
githubLabel?: string | null;
|
|
1825
|
+
/**
|
|
1826
|
+
* 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 discarded.
|
|
1827
|
+
*/
|
|
1828
|
+
librarySettings?: Schema$ClientLibrarySettings[];
|
|
1829
|
+
/**
|
|
1830
|
+
* A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
|
|
1831
|
+
*/
|
|
1832
|
+
methodSettings?: Schema$MethodSettings[];
|
|
1833
|
+
/**
|
|
1834
|
+
* Link to a *public* URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
|
|
1835
|
+
*/
|
|
1836
|
+
newIssueUri?: string | null;
|
|
1837
|
+
/**
|
|
1838
|
+
* For whom the client library is being published.
|
|
1839
|
+
*/
|
|
1840
|
+
organization?: string | null;
|
|
1841
|
+
/**
|
|
1842
|
+
* Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
|
|
1843
|
+
*/
|
|
1844
|
+
protoReferenceDocumentationUri?: string | null;
|
|
1845
|
+
}
|
|
1846
|
+
/**
|
|
1847
|
+
* Settings for Python client libraries.
|
|
1848
|
+
*/
|
|
1849
|
+
export interface Schema$PythonSettings {
|
|
1850
|
+
/**
|
|
1851
|
+
* Some settings.
|
|
1852
|
+
*/
|
|
1853
|
+
common?: Schema$CommonLanguageSettings;
|
|
1854
|
+
}
|
|
1855
|
+
/**
|
|
1856
|
+
* Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project\}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64
|
|
1458
1857
|
*/
|
|
1459
1858
|
export interface Schema$Quota {
|
|
1460
1859
|
/**
|
|
1461
|
-
* List of
|
|
1860
|
+
* List of QuotaLimit definitions for the service.
|
|
1462
1861
|
*/
|
|
1463
1862
|
limits?: Schema$QuotaLimit[];
|
|
1464
1863
|
/**
|
|
1465
|
-
* List of
|
|
1864
|
+
* List of MetricRule definitions, each one mapping a selected method to one or more metrics.
|
|
1466
1865
|
*/
|
|
1467
1866
|
metricRules?: Schema$MetricRule[];
|
|
1468
1867
|
}
|
|
@@ -1496,6 +1895,10 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
1496
1895
|
* Producer override on this quota bucket.
|
|
1497
1896
|
*/
|
|
1498
1897
|
producerOverride?: Schema$QuotaOverride;
|
|
1898
|
+
/**
|
|
1899
|
+
* Producer policy inherited from the closet ancestor of the current consumer.
|
|
1900
|
+
*/
|
|
1901
|
+
producerQuotaPolicy?: Schema$ProducerQuotaPolicy;
|
|
1499
1902
|
}
|
|
1500
1903
|
/**
|
|
1501
1904
|
* `QuotaLimit` defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a `QuotaGroup`.
|
|
@@ -1575,6 +1978,33 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
1575
1978
|
*/
|
|
1576
1979
|
unit?: string | null;
|
|
1577
1980
|
}
|
|
1981
|
+
/**
|
|
1982
|
+
* Metadata for the `RemoveEnableRules` method.
|
|
1983
|
+
*/
|
|
1984
|
+
export interface Schema$RemoveEnableRulesMetadata {
|
|
1985
|
+
}
|
|
1986
|
+
/**
|
|
1987
|
+
* The response message of "RemoveEnableRules" method.
|
|
1988
|
+
*/
|
|
1989
|
+
export interface Schema$RemoveEnableRulesResponse {
|
|
1990
|
+
/**
|
|
1991
|
+
* The parent consumer policy. It can be `projects/12345/consumerPolicies/default`, or `folders/12345/consumerPolicies/default`, or `organizations/12345/consumerPolicies/default`.
|
|
1992
|
+
*/
|
|
1993
|
+
parent?: string | null;
|
|
1994
|
+
/**
|
|
1995
|
+
* The values removed from the parent consumer policy.
|
|
1996
|
+
*/
|
|
1997
|
+
removedValues?: string[] | null;
|
|
1998
|
+
}
|
|
1999
|
+
/**
|
|
2000
|
+
* Settings for Ruby client libraries.
|
|
2001
|
+
*/
|
|
2002
|
+
export interface Schema$RubySettings {
|
|
2003
|
+
/**
|
|
2004
|
+
* Some settings.
|
|
2005
|
+
*/
|
|
2006
|
+
common?: Schema$CommonLanguageSettings;
|
|
2007
|
+
}
|
|
1578
2008
|
/**
|
|
1579
2009
|
* A service that is available for use by the consumer.
|
|
1580
2010
|
*/
|
|
@@ -1736,6 +2166,10 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
1736
2166
|
* A protocol buffer message type.
|
|
1737
2167
|
*/
|
|
1738
2168
|
export interface Schema$Type {
|
|
2169
|
+
/**
|
|
2170
|
+
* The source edition string, only valid when syntax is SYNTAX_EDITIONS.
|
|
2171
|
+
*/
|
|
2172
|
+
edition?: string | null;
|
|
1739
2173
|
/**
|
|
1740
2174
|
* The list of fields.
|
|
1741
2175
|
*/
|
|
@@ -1766,6 +2200,11 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
1766
2200
|
*/
|
|
1767
2201
|
export interface Schema$UpdateAdminQuotaPolicyMetadata {
|
|
1768
2202
|
}
|
|
2203
|
+
/**
|
|
2204
|
+
* Metadata for the `UpdateConsumerPolicy` method.
|
|
2205
|
+
*/
|
|
2206
|
+
export interface Schema$UpdateConsumerPolicyMetadata {
|
|
2207
|
+
}
|
|
1769
2208
|
/**
|
|
1770
2209
|
* Configuration controlling usage of a service.
|
|
1771
2210
|
*/
|
|
@@ -1805,55 +2244,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
1805
2244
|
constructor(context: APIRequestContext);
|
|
1806
2245
|
/**
|
|
1807
2246
|
* 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.
|
|
1808
|
-
* @example
|
|
1809
|
-
* ```js
|
|
1810
|
-
* // Before running the sample:
|
|
1811
|
-
* // - Enable the API at:
|
|
1812
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
1813
|
-
* // - Login into gcloud by running:
|
|
1814
|
-
* // `$ gcloud auth application-default login`
|
|
1815
|
-
* // - Install the npm module by running:
|
|
1816
|
-
* // `$ npm install googleapis`
|
|
1817
|
-
*
|
|
1818
|
-
* const {google} = require('googleapis');
|
|
1819
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
1820
|
-
*
|
|
1821
|
-
* async function main() {
|
|
1822
|
-
* const auth = new google.auth.GoogleAuth({
|
|
1823
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1824
|
-
* scopes: [
|
|
1825
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
1826
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
1827
|
-
* ],
|
|
1828
|
-
* });
|
|
1829
|
-
*
|
|
1830
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
1831
|
-
* const authClient = await auth.getClient();
|
|
1832
|
-
* google.options({auth: authClient});
|
|
1833
|
-
*
|
|
1834
|
-
* // Do the magic
|
|
1835
|
-
* const res = await serviceusage.operations.get({
|
|
1836
|
-
* // The name of the operation resource.
|
|
1837
|
-
* name: 'operations/my-operation',
|
|
1838
|
-
* });
|
|
1839
|
-
* console.log(res.data);
|
|
1840
|
-
*
|
|
1841
|
-
* // Example response
|
|
1842
|
-
* // {
|
|
1843
|
-
* // "done": false,
|
|
1844
|
-
* // "error": {},
|
|
1845
|
-
* // "metadata": {},
|
|
1846
|
-
* // "name": "my_name",
|
|
1847
|
-
* // "response": {}
|
|
1848
|
-
* // }
|
|
1849
|
-
* }
|
|
1850
|
-
*
|
|
1851
|
-
* main().catch(e => {
|
|
1852
|
-
* console.error(e);
|
|
1853
|
-
* throw e;
|
|
1854
|
-
* });
|
|
1855
|
-
*
|
|
1856
|
-
* ```
|
|
1857
2247
|
*
|
|
1858
2248
|
* @param params - Parameters for request
|
|
1859
2249
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1867,59 +2257,7 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
1867
2257
|
get(params: Params$Resource$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
1868
2258
|
get(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
1869
2259
|
/**
|
|
1870
|
-
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
1871
|
-
* @example
|
|
1872
|
-
* ```js
|
|
1873
|
-
* // Before running the sample:
|
|
1874
|
-
* // - Enable the API at:
|
|
1875
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
1876
|
-
* // - Login into gcloud by running:
|
|
1877
|
-
* // `$ gcloud auth application-default login`
|
|
1878
|
-
* // - Install the npm module by running:
|
|
1879
|
-
* // `$ npm install googleapis`
|
|
1880
|
-
*
|
|
1881
|
-
* const {google} = require('googleapis');
|
|
1882
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
1883
|
-
*
|
|
1884
|
-
* async function main() {
|
|
1885
|
-
* const auth = new google.auth.GoogleAuth({
|
|
1886
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1887
|
-
* scopes: [
|
|
1888
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
1889
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
1890
|
-
* ],
|
|
1891
|
-
* });
|
|
1892
|
-
*
|
|
1893
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
1894
|
-
* const authClient = await auth.getClient();
|
|
1895
|
-
* google.options({auth: authClient});
|
|
1896
|
-
*
|
|
1897
|
-
* // Do the magic
|
|
1898
|
-
* const res = await serviceusage.operations.list({
|
|
1899
|
-
* // The standard list filter.
|
|
1900
|
-
* filter: 'placeholder-value',
|
|
1901
|
-
* // The name of the operation's parent resource.
|
|
1902
|
-
* name: 'placeholder-value',
|
|
1903
|
-
* // The standard list page size.
|
|
1904
|
-
* pageSize: 'placeholder-value',
|
|
1905
|
-
* // The standard list page token.
|
|
1906
|
-
* pageToken: 'placeholder-value',
|
|
1907
|
-
* });
|
|
1908
|
-
* console.log(res.data);
|
|
1909
|
-
*
|
|
1910
|
-
* // Example response
|
|
1911
|
-
* // {
|
|
1912
|
-
* // "nextPageToken": "my_nextPageToken",
|
|
1913
|
-
* // "operations": []
|
|
1914
|
-
* // }
|
|
1915
|
-
* }
|
|
1916
|
-
*
|
|
1917
|
-
* main().catch(e => {
|
|
1918
|
-
* console.error(e);
|
|
1919
|
-
* throw e;
|
|
1920
|
-
* });
|
|
1921
|
-
*
|
|
1922
|
-
* ```
|
|
2260
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
1923
2261
|
*
|
|
1924
2262
|
* @param params - Parameters for request
|
|
1925
2263
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1963,63 +2301,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
1963
2301
|
constructor(context: APIRequestContext);
|
|
1964
2302
|
/**
|
|
1965
2303
|
* Enables multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur. Operation response type: `google.protobuf.Empty`
|
|
1966
|
-
* @example
|
|
1967
|
-
* ```js
|
|
1968
|
-
* // Before running the sample:
|
|
1969
|
-
* // - Enable the API at:
|
|
1970
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
1971
|
-
* // - Login into gcloud by running:
|
|
1972
|
-
* // `$ gcloud auth application-default login`
|
|
1973
|
-
* // - Install the npm module by running:
|
|
1974
|
-
* // `$ npm install googleapis`
|
|
1975
|
-
*
|
|
1976
|
-
* const {google} = require('googleapis');
|
|
1977
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
1978
|
-
*
|
|
1979
|
-
* async function main() {
|
|
1980
|
-
* const auth = new google.auth.GoogleAuth({
|
|
1981
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1982
|
-
* scopes: [
|
|
1983
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
1984
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
1985
|
-
* ],
|
|
1986
|
-
* });
|
|
1987
|
-
*
|
|
1988
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
1989
|
-
* const authClient = await auth.getClient();
|
|
1990
|
-
* google.options({auth: authClient});
|
|
1991
|
-
*
|
|
1992
|
-
* // Do the magic
|
|
1993
|
-
* const res = await serviceusage.services.batchEnable({
|
|
1994
|
-
* // Parent to enable services on. An example name would be: `projects/123` where `123` is the project number (not project ID). The `BatchEnableServices` method currently only supports projects.
|
|
1995
|
-
* parent: '[^/]+/[^/]+',
|
|
1996
|
-
*
|
|
1997
|
-
* // Request body metadata
|
|
1998
|
-
* requestBody: {
|
|
1999
|
-
* // request body parameters
|
|
2000
|
-
* // {
|
|
2001
|
-
* // "serviceIds": []
|
|
2002
|
-
* // }
|
|
2003
|
-
* },
|
|
2004
|
-
* });
|
|
2005
|
-
* console.log(res.data);
|
|
2006
|
-
*
|
|
2007
|
-
* // Example response
|
|
2008
|
-
* // {
|
|
2009
|
-
* // "done": false,
|
|
2010
|
-
* // "error": {},
|
|
2011
|
-
* // "metadata": {},
|
|
2012
|
-
* // "name": "my_name",
|
|
2013
|
-
* // "response": {}
|
|
2014
|
-
* // }
|
|
2015
|
-
* }
|
|
2016
|
-
*
|
|
2017
|
-
* main().catch(e => {
|
|
2018
|
-
* console.error(e);
|
|
2019
|
-
* throw e;
|
|
2020
|
-
* });
|
|
2021
|
-
*
|
|
2022
|
-
* ```
|
|
2023
2304
|
*
|
|
2024
2305
|
* @param params - Parameters for request
|
|
2025
2306
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2034,61 +2315,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
2034
2315
|
batchEnable(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2035
2316
|
/**
|
|
2036
2317
|
* Disables 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 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. Operation response type: `google.protobuf.Empty`
|
|
2037
|
-
* @example
|
|
2038
|
-
* ```js
|
|
2039
|
-
* // Before running the sample:
|
|
2040
|
-
* // - Enable the API at:
|
|
2041
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
2042
|
-
* // - Login into gcloud by running:
|
|
2043
|
-
* // `$ gcloud auth application-default login`
|
|
2044
|
-
* // - Install the npm module by running:
|
|
2045
|
-
* // `$ npm install googleapis`
|
|
2046
|
-
*
|
|
2047
|
-
* const {google} = require('googleapis');
|
|
2048
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
2049
|
-
*
|
|
2050
|
-
* async function main() {
|
|
2051
|
-
* const auth = new google.auth.GoogleAuth({
|
|
2052
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2053
|
-
* scopes: [
|
|
2054
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2055
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
2056
|
-
* ],
|
|
2057
|
-
* });
|
|
2058
|
-
*
|
|
2059
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
2060
|
-
* const authClient = await auth.getClient();
|
|
2061
|
-
* google.options({auth: authClient});
|
|
2062
|
-
*
|
|
2063
|
-
* // Do the magic
|
|
2064
|
-
* const res = await serviceusage.services.disable({
|
|
2065
|
-
* // 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: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number (not project ID).
|
|
2066
|
-
* name: '[^/]+/[^/]+/services/my-service',
|
|
2067
|
-
*
|
|
2068
|
-
* // Request body metadata
|
|
2069
|
-
* requestBody: {
|
|
2070
|
-
* // request body parameters
|
|
2071
|
-
* // {}
|
|
2072
|
-
* },
|
|
2073
|
-
* });
|
|
2074
|
-
* console.log(res.data);
|
|
2075
|
-
*
|
|
2076
|
-
* // Example response
|
|
2077
|
-
* // {
|
|
2078
|
-
* // "done": false,
|
|
2079
|
-
* // "error": {},
|
|
2080
|
-
* // "metadata": {},
|
|
2081
|
-
* // "name": "my_name",
|
|
2082
|
-
* // "response": {}
|
|
2083
|
-
* // }
|
|
2084
|
-
* }
|
|
2085
|
-
*
|
|
2086
|
-
* main().catch(e => {
|
|
2087
|
-
* console.error(e);
|
|
2088
|
-
* throw e;
|
|
2089
|
-
* });
|
|
2090
|
-
*
|
|
2091
|
-
* ```
|
|
2092
2318
|
*
|
|
2093
2319
|
* @param params - Parameters for request
|
|
2094
2320
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2103,61 +2329,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
2103
2329
|
disable(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2104
2330
|
/**
|
|
2105
2331
|
* Enables a service so that it can be used with a project. Operation response type: `google.protobuf.Empty`
|
|
2106
|
-
* @example
|
|
2107
|
-
* ```js
|
|
2108
|
-
* // Before running the sample:
|
|
2109
|
-
* // - Enable the API at:
|
|
2110
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
2111
|
-
* // - Login into gcloud by running:
|
|
2112
|
-
* // `$ gcloud auth application-default login`
|
|
2113
|
-
* // - Install the npm module by running:
|
|
2114
|
-
* // `$ npm install googleapis`
|
|
2115
|
-
*
|
|
2116
|
-
* const {google} = require('googleapis');
|
|
2117
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
2118
|
-
*
|
|
2119
|
-
* async function main() {
|
|
2120
|
-
* const auth = new google.auth.GoogleAuth({
|
|
2121
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2122
|
-
* scopes: [
|
|
2123
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2124
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
2125
|
-
* ],
|
|
2126
|
-
* });
|
|
2127
|
-
*
|
|
2128
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
2129
|
-
* const authClient = await auth.getClient();
|
|
2130
|
-
* google.options({auth: authClient});
|
|
2131
|
-
*
|
|
2132
|
-
* // Do the magic
|
|
2133
|
-
* const res = await serviceusage.services.enable({
|
|
2134
|
-
* // 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 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 number (not project ID).
|
|
2135
|
-
* name: '[^/]+/[^/]+/services/my-service',
|
|
2136
|
-
*
|
|
2137
|
-
* // Request body metadata
|
|
2138
|
-
* requestBody: {
|
|
2139
|
-
* // request body parameters
|
|
2140
|
-
* // {}
|
|
2141
|
-
* },
|
|
2142
|
-
* });
|
|
2143
|
-
* console.log(res.data);
|
|
2144
|
-
*
|
|
2145
|
-
* // Example response
|
|
2146
|
-
* // {
|
|
2147
|
-
* // "done": false,
|
|
2148
|
-
* // "error": {},
|
|
2149
|
-
* // "metadata": {},
|
|
2150
|
-
* // "name": "my_name",
|
|
2151
|
-
* // "response": {}
|
|
2152
|
-
* // }
|
|
2153
|
-
* }
|
|
2154
|
-
*
|
|
2155
|
-
* main().catch(e => {
|
|
2156
|
-
* console.error(e);
|
|
2157
|
-
* throw e;
|
|
2158
|
-
* });
|
|
2159
|
-
*
|
|
2160
|
-
* ```
|
|
2161
2332
|
*
|
|
2162
2333
|
* @param params - Parameters for request
|
|
2163
2334
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2172,55 +2343,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
2172
2343
|
enable(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2173
2344
|
/**
|
|
2174
2345
|
* Generates service identity for service.
|
|
2175
|
-
* @example
|
|
2176
|
-
* ```js
|
|
2177
|
-
* // Before running the sample:
|
|
2178
|
-
* // - Enable the API at:
|
|
2179
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
2180
|
-
* // - Login into gcloud by running:
|
|
2181
|
-
* // `$ gcloud auth application-default login`
|
|
2182
|
-
* // - Install the npm module by running:
|
|
2183
|
-
* // `$ npm install googleapis`
|
|
2184
|
-
*
|
|
2185
|
-
* const {google} = require('googleapis');
|
|
2186
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
2187
|
-
*
|
|
2188
|
-
* async function main() {
|
|
2189
|
-
* const auth = new google.auth.GoogleAuth({
|
|
2190
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2191
|
-
* scopes: [
|
|
2192
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2193
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
2194
|
-
* ],
|
|
2195
|
-
* });
|
|
2196
|
-
*
|
|
2197
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
2198
|
-
* const authClient = await auth.getClient();
|
|
2199
|
-
* google.options({auth: authClient});
|
|
2200
|
-
*
|
|
2201
|
-
* // Do the magic
|
|
2202
|
-
* const res = await serviceusage.services.generateServiceIdentity({
|
|
2203
|
-
* // Name of the consumer and service to generate an identity for. The `GenerateServiceIdentity` methods currently only support projects. An example name would be: `projects/123/services/example.googleapis.com` where `123` is the project number.
|
|
2204
|
-
* parent: '[^/]+/[^/]+/services/my-service',
|
|
2205
|
-
* });
|
|
2206
|
-
* console.log(res.data);
|
|
2207
|
-
*
|
|
2208
|
-
* // Example response
|
|
2209
|
-
* // {
|
|
2210
|
-
* // "done": false,
|
|
2211
|
-
* // "error": {},
|
|
2212
|
-
* // "metadata": {},
|
|
2213
|
-
* // "name": "my_name",
|
|
2214
|
-
* // "response": {}
|
|
2215
|
-
* // }
|
|
2216
|
-
* }
|
|
2217
|
-
*
|
|
2218
|
-
* main().catch(e => {
|
|
2219
|
-
* console.error(e);
|
|
2220
|
-
* throw e;
|
|
2221
|
-
* });
|
|
2222
|
-
*
|
|
2223
|
-
* ```
|
|
2224
2346
|
*
|
|
2225
2347
|
* @param params - Parameters for request
|
|
2226
2348
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2235,54 +2357,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
2235
2357
|
generateServiceIdentity(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2236
2358
|
/**
|
|
2237
2359
|
* Returns the service configuration and enabled state for a given service.
|
|
2238
|
-
* @example
|
|
2239
|
-
* ```js
|
|
2240
|
-
* // Before running the sample:
|
|
2241
|
-
* // - Enable the API at:
|
|
2242
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
2243
|
-
* // - Login into gcloud by running:
|
|
2244
|
-
* // `$ gcloud auth application-default login`
|
|
2245
|
-
* // - Install the npm module by running:
|
|
2246
|
-
* // `$ npm install googleapis`
|
|
2247
|
-
*
|
|
2248
|
-
* const {google} = require('googleapis');
|
|
2249
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
2250
|
-
*
|
|
2251
|
-
* async function main() {
|
|
2252
|
-
* const auth = new google.auth.GoogleAuth({
|
|
2253
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2254
|
-
* scopes: [
|
|
2255
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2256
|
-
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
|
|
2257
|
-
* ],
|
|
2258
|
-
* });
|
|
2259
|
-
*
|
|
2260
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
2261
|
-
* const authClient = await auth.getClient();
|
|
2262
|
-
* google.options({auth: authClient});
|
|
2263
|
-
*
|
|
2264
|
-
* // Do the magic
|
|
2265
|
-
* const res = await serviceusage.services.get({
|
|
2266
|
-
* // 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 (not project ID).
|
|
2267
|
-
* name: '[^/]+/[^/]+/services/my-service',
|
|
2268
|
-
* });
|
|
2269
|
-
* console.log(res.data);
|
|
2270
|
-
*
|
|
2271
|
-
* // Example response
|
|
2272
|
-
* // {
|
|
2273
|
-
* // "config": {},
|
|
2274
|
-
* // "name": "my_name",
|
|
2275
|
-
* // "parent": "my_parent",
|
|
2276
|
-
* // "state": "my_state"
|
|
2277
|
-
* // }
|
|
2278
|
-
* }
|
|
2279
|
-
*
|
|
2280
|
-
* main().catch(e => {
|
|
2281
|
-
* console.error(e);
|
|
2282
|
-
* throw e;
|
|
2283
|
-
* });
|
|
2284
|
-
*
|
|
2285
|
-
* ```
|
|
2286
2360
|
*
|
|
2287
2361
|
* @param params - Parameters for request
|
|
2288
2362
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2297,58 +2371,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
2297
2371
|
get(callback: BodyResponseCallback<Schema$Service>): void;
|
|
2298
2372
|
/**
|
|
2299
2373
|
* Lists 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 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 services in a specific state, for example to only include services enabled on the project.
|
|
2300
|
-
* @example
|
|
2301
|
-
* ```js
|
|
2302
|
-
* // Before running the sample:
|
|
2303
|
-
* // - Enable the API at:
|
|
2304
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
2305
|
-
* // - Login into gcloud by running:
|
|
2306
|
-
* // `$ gcloud auth application-default login`
|
|
2307
|
-
* // - Install the npm module by running:
|
|
2308
|
-
* // `$ npm install googleapis`
|
|
2309
|
-
*
|
|
2310
|
-
* const {google} = require('googleapis');
|
|
2311
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
2312
|
-
*
|
|
2313
|
-
* async function main() {
|
|
2314
|
-
* const auth = new google.auth.GoogleAuth({
|
|
2315
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2316
|
-
* scopes: [
|
|
2317
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2318
|
-
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
|
|
2319
|
-
* ],
|
|
2320
|
-
* });
|
|
2321
|
-
*
|
|
2322
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
2323
|
-
* const authClient = await auth.getClient();
|
|
2324
|
-
* google.options({auth: authClient});
|
|
2325
|
-
*
|
|
2326
|
-
* // Do the magic
|
|
2327
|
-
* const res = await serviceusage.services.list({
|
|
2328
|
-
* // Only list services that conform to the given filter. The allowed filter strings are `state:ENABLED` and `state:DISABLED`.
|
|
2329
|
-
* filter: 'placeholder-value',
|
|
2330
|
-
* // Requested size of the next page of data. Requested page size cannot exceed 200. If not set, the default page size is 50.
|
|
2331
|
-
* pageSize: 'placeholder-value',
|
|
2332
|
-
* // Token identifying which result to start with, which is returned by a previous list call.
|
|
2333
|
-
* pageToken: 'placeholder-value',
|
|
2334
|
-
* // Parent to search for services on. An example name would be: `projects/123` where `123` is the project number (not project ID).
|
|
2335
|
-
* parent: '[^/]+/[^/]+',
|
|
2336
|
-
* });
|
|
2337
|
-
* console.log(res.data);
|
|
2338
|
-
*
|
|
2339
|
-
* // Example response
|
|
2340
|
-
* // {
|
|
2341
|
-
* // "nextPageToken": "my_nextPageToken",
|
|
2342
|
-
* // "services": []
|
|
2343
|
-
* // }
|
|
2344
|
-
* }
|
|
2345
|
-
*
|
|
2346
|
-
* main().catch(e => {
|
|
2347
|
-
* console.error(e);
|
|
2348
|
-
* throw e;
|
|
2349
|
-
* });
|
|
2350
|
-
*
|
|
2351
|
-
* ```
|
|
2352
2374
|
*
|
|
2353
2375
|
* @param params - Parameters for request
|
|
2354
2376
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2394,7 +2416,7 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
2394
2416
|
}
|
|
2395
2417
|
export interface Params$Resource$Services$Generateserviceidentity extends StandardParameters {
|
|
2396
2418
|
/**
|
|
2397
|
-
* Name of the consumer and service to generate an identity for. The `GenerateServiceIdentity` methods currently
|
|
2419
|
+
* Name of the consumer and service to generate an identity for. The `GenerateServiceIdentity` methods currently support projects, folders, organizations. Example parents would be: `projects/123/services/example.googleapis.com` `folders/123/services/example.googleapis.com` `organizations/123/services/example.googleapis.com`
|
|
2398
2420
|
*/
|
|
2399
2421
|
parent?: string;
|
|
2400
2422
|
}
|
|
@@ -2428,58 +2450,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
2428
2450
|
constructor(context: APIRequestContext);
|
|
2429
2451
|
/**
|
|
2430
2452
|
* Retrieves a summary of quota information for a specific quota metric
|
|
2431
|
-
* @example
|
|
2432
|
-
* ```js
|
|
2433
|
-
* // Before running the sample:
|
|
2434
|
-
* // - Enable the API at:
|
|
2435
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
2436
|
-
* // - Login into gcloud by running:
|
|
2437
|
-
* // `$ gcloud auth application-default login`
|
|
2438
|
-
* // - Install the npm module by running:
|
|
2439
|
-
* // `$ npm install googleapis`
|
|
2440
|
-
*
|
|
2441
|
-
* const {google} = require('googleapis');
|
|
2442
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
2443
|
-
*
|
|
2444
|
-
* async function main() {
|
|
2445
|
-
* const auth = new google.auth.GoogleAuth({
|
|
2446
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2447
|
-
* scopes: [
|
|
2448
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2449
|
-
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
|
|
2450
|
-
* ],
|
|
2451
|
-
* });
|
|
2452
|
-
*
|
|
2453
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
2454
|
-
* const authClient = await auth.getClient();
|
|
2455
|
-
* google.options({auth: authClient});
|
|
2456
|
-
*
|
|
2457
|
-
* // Do the magic
|
|
2458
|
-
* const res = await serviceusage.services.consumerQuotaMetrics.get({
|
|
2459
|
-
* // The resource name of the quota limit. An example name would be: `projects/123/services/serviceusage.googleapis.com/quotas/metrics/serviceusage.googleapis.com%2Fmutate_requests`
|
|
2460
|
-
* name: '[^/]+/[^/]+/services/my-service/consumerQuotaMetrics/my-consumerQuotaMetric',
|
|
2461
|
-
* // Specifies the level of detail for quota information in the response.
|
|
2462
|
-
* view: 'placeholder-value',
|
|
2463
|
-
* });
|
|
2464
|
-
* console.log(res.data);
|
|
2465
|
-
*
|
|
2466
|
-
* // Example response
|
|
2467
|
-
* // {
|
|
2468
|
-
* // "consumerQuotaLimits": [],
|
|
2469
|
-
* // "descendantConsumerQuotaLimits": [],
|
|
2470
|
-
* // "displayName": "my_displayName",
|
|
2471
|
-
* // "metric": "my_metric",
|
|
2472
|
-
* // "name": "my_name",
|
|
2473
|
-
* // "unit": "my_unit"
|
|
2474
|
-
* // }
|
|
2475
|
-
* }
|
|
2476
|
-
*
|
|
2477
|
-
* main().catch(e => {
|
|
2478
|
-
* console.error(e);
|
|
2479
|
-
* throw e;
|
|
2480
|
-
* });
|
|
2481
|
-
*
|
|
2482
|
-
* ```
|
|
2483
2453
|
*
|
|
2484
2454
|
* @param params - Parameters for request
|
|
2485
2455
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2494,66 +2464,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
2494
2464
|
get(callback: BodyResponseCallback<Schema$ConsumerQuotaMetric>): void;
|
|
2495
2465
|
/**
|
|
2496
2466
|
* Creates or updates multiple admin overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.
|
|
2497
|
-
* @example
|
|
2498
|
-
* ```js
|
|
2499
|
-
* // Before running the sample:
|
|
2500
|
-
* // - Enable the API at:
|
|
2501
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
2502
|
-
* // - Login into gcloud by running:
|
|
2503
|
-
* // `$ gcloud auth application-default login`
|
|
2504
|
-
* // - Install the npm module by running:
|
|
2505
|
-
* // `$ npm install googleapis`
|
|
2506
|
-
*
|
|
2507
|
-
* const {google} = require('googleapis');
|
|
2508
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
2509
|
-
*
|
|
2510
|
-
* async function main() {
|
|
2511
|
-
* const auth = new google.auth.GoogleAuth({
|
|
2512
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2513
|
-
* scopes: [
|
|
2514
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2515
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
2516
|
-
* ],
|
|
2517
|
-
* });
|
|
2518
|
-
*
|
|
2519
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
2520
|
-
* const authClient = await auth.getClient();
|
|
2521
|
-
* google.options({auth: authClient});
|
|
2522
|
-
*
|
|
2523
|
-
* // Do the magic
|
|
2524
|
-
* const res =
|
|
2525
|
-
* await serviceusage.services.consumerQuotaMetrics.importAdminOverrides({
|
|
2526
|
-
* // The resource name of the consumer. An example name would be: `projects/123/services/compute.googleapis.com`
|
|
2527
|
-
* parent: '[^/]+/[^/]+/services/my-service',
|
|
2528
|
-
*
|
|
2529
|
-
* // Request body metadata
|
|
2530
|
-
* requestBody: {
|
|
2531
|
-
* // request body parameters
|
|
2532
|
-
* // {
|
|
2533
|
-
* // "force": false,
|
|
2534
|
-
* // "forceOnly": [],
|
|
2535
|
-
* // "inlineSource": {}
|
|
2536
|
-
* // }
|
|
2537
|
-
* },
|
|
2538
|
-
* });
|
|
2539
|
-
* console.log(res.data);
|
|
2540
|
-
*
|
|
2541
|
-
* // Example response
|
|
2542
|
-
* // {
|
|
2543
|
-
* // "done": false,
|
|
2544
|
-
* // "error": {},
|
|
2545
|
-
* // "metadata": {},
|
|
2546
|
-
* // "name": "my_name",
|
|
2547
|
-
* // "response": {}
|
|
2548
|
-
* // }
|
|
2549
|
-
* }
|
|
2550
|
-
*
|
|
2551
|
-
* main().catch(e => {
|
|
2552
|
-
* console.error(e);
|
|
2553
|
-
* throw e;
|
|
2554
|
-
* });
|
|
2555
|
-
*
|
|
2556
|
-
* ```
|
|
2557
2467
|
*
|
|
2558
2468
|
* @param params - Parameters for request
|
|
2559
2469
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2568,66 +2478,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
2568
2478
|
importAdminOverrides(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2569
2479
|
/**
|
|
2570
2480
|
* Creates or updates multiple consumer overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.
|
|
2571
|
-
* @example
|
|
2572
|
-
* ```js
|
|
2573
|
-
* // Before running the sample:
|
|
2574
|
-
* // - Enable the API at:
|
|
2575
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
2576
|
-
* // - Login into gcloud by running:
|
|
2577
|
-
* // `$ gcloud auth application-default login`
|
|
2578
|
-
* // - Install the npm module by running:
|
|
2579
|
-
* // `$ npm install googleapis`
|
|
2580
|
-
*
|
|
2581
|
-
* const {google} = require('googleapis');
|
|
2582
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
2583
|
-
*
|
|
2584
|
-
* async function main() {
|
|
2585
|
-
* const auth = new google.auth.GoogleAuth({
|
|
2586
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2587
|
-
* scopes: [
|
|
2588
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2589
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
2590
|
-
* ],
|
|
2591
|
-
* });
|
|
2592
|
-
*
|
|
2593
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
2594
|
-
* const authClient = await auth.getClient();
|
|
2595
|
-
* google.options({auth: authClient});
|
|
2596
|
-
*
|
|
2597
|
-
* // Do the magic
|
|
2598
|
-
* const res =
|
|
2599
|
-
* await serviceusage.services.consumerQuotaMetrics.importConsumerOverrides({
|
|
2600
|
-
* // The resource name of the consumer. An example name would be: `projects/123/services/compute.googleapis.com`
|
|
2601
|
-
* parent: '[^/]+/[^/]+/services/my-service',
|
|
2602
|
-
*
|
|
2603
|
-
* // Request body metadata
|
|
2604
|
-
* requestBody: {
|
|
2605
|
-
* // request body parameters
|
|
2606
|
-
* // {
|
|
2607
|
-
* // "force": false,
|
|
2608
|
-
* // "forceOnly": [],
|
|
2609
|
-
* // "inlineSource": {}
|
|
2610
|
-
* // }
|
|
2611
|
-
* },
|
|
2612
|
-
* });
|
|
2613
|
-
* console.log(res.data);
|
|
2614
|
-
*
|
|
2615
|
-
* // Example response
|
|
2616
|
-
* // {
|
|
2617
|
-
* // "done": false,
|
|
2618
|
-
* // "error": {},
|
|
2619
|
-
* // "metadata": {},
|
|
2620
|
-
* // "name": "my_name",
|
|
2621
|
-
* // "response": {}
|
|
2622
|
-
* // }
|
|
2623
|
-
* }
|
|
2624
|
-
*
|
|
2625
|
-
* main().catch(e => {
|
|
2626
|
-
* console.error(e);
|
|
2627
|
-
* throw e;
|
|
2628
|
-
* });
|
|
2629
|
-
*
|
|
2630
|
-
* ```
|
|
2631
2481
|
*
|
|
2632
2482
|
* @param params - Parameters for request
|
|
2633
2483
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2642,58 +2492,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
2642
2492
|
importConsumerOverrides(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2643
2493
|
/**
|
|
2644
2494
|
* Retrieves a summary of all quota information visible to the service consumer, organized by service metric. Each metric includes information about all of its defined limits. Each limit includes the limit configuration (quota unit, preciseness, default value), the current effective limit value, and all of the overrides applied to the limit.
|
|
2645
|
-
* @example
|
|
2646
|
-
* ```js
|
|
2647
|
-
* // Before running the sample:
|
|
2648
|
-
* // - Enable the API at:
|
|
2649
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
2650
|
-
* // - Login into gcloud by running:
|
|
2651
|
-
* // `$ gcloud auth application-default login`
|
|
2652
|
-
* // - Install the npm module by running:
|
|
2653
|
-
* // `$ npm install googleapis`
|
|
2654
|
-
*
|
|
2655
|
-
* const {google} = require('googleapis');
|
|
2656
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
2657
|
-
*
|
|
2658
|
-
* async function main() {
|
|
2659
|
-
* const auth = new google.auth.GoogleAuth({
|
|
2660
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2661
|
-
* scopes: [
|
|
2662
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2663
|
-
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
|
|
2664
|
-
* ],
|
|
2665
|
-
* });
|
|
2666
|
-
*
|
|
2667
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
2668
|
-
* const authClient = await auth.getClient();
|
|
2669
|
-
* google.options({auth: authClient});
|
|
2670
|
-
*
|
|
2671
|
-
* // Do the magic
|
|
2672
|
-
* const res = await serviceusage.services.consumerQuotaMetrics.list({
|
|
2673
|
-
* // Requested size of the next page of data.
|
|
2674
|
-
* pageSize: 'placeholder-value',
|
|
2675
|
-
* // Token identifying which result to start with; returned by a previous list call.
|
|
2676
|
-
* pageToken: 'placeholder-value',
|
|
2677
|
-
* // Parent of the quotas resource. Some example names would be: `projects/123/services/serviceconsumermanagement.googleapis.com` `folders/345/services/serviceconsumermanagement.googleapis.com` `organizations/456/services/serviceconsumermanagement.googleapis.com`
|
|
2678
|
-
* parent: '[^/]+/[^/]+/services/my-service',
|
|
2679
|
-
* // Specifies the level of detail for quota information in the response.
|
|
2680
|
-
* view: 'placeholder-value',
|
|
2681
|
-
* });
|
|
2682
|
-
* console.log(res.data);
|
|
2683
|
-
*
|
|
2684
|
-
* // Example response
|
|
2685
|
-
* // {
|
|
2686
|
-
* // "metrics": [],
|
|
2687
|
-
* // "nextPageToken": "my_nextPageToken"
|
|
2688
|
-
* // }
|
|
2689
|
-
* }
|
|
2690
|
-
*
|
|
2691
|
-
* main().catch(e => {
|
|
2692
|
-
* console.error(e);
|
|
2693
|
-
* throw e;
|
|
2694
|
-
* });
|
|
2695
|
-
*
|
|
2696
|
-
* ```
|
|
2697
2495
|
*
|
|
2698
2496
|
* @param params - Parameters for request
|
|
2699
2497
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2762,59 +2560,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
2762
2560
|
constructor(context: APIRequestContext);
|
|
2763
2561
|
/**
|
|
2764
2562
|
* Retrieves a summary of quota information for a specific quota limit.
|
|
2765
|
-
* @example
|
|
2766
|
-
* ```js
|
|
2767
|
-
* // Before running the sample:
|
|
2768
|
-
* // - Enable the API at:
|
|
2769
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
2770
|
-
* // - Login into gcloud by running:
|
|
2771
|
-
* // `$ gcloud auth application-default login`
|
|
2772
|
-
* // - Install the npm module by running:
|
|
2773
|
-
* // `$ npm install googleapis`
|
|
2774
|
-
*
|
|
2775
|
-
* const {google} = require('googleapis');
|
|
2776
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
2777
|
-
*
|
|
2778
|
-
* async function main() {
|
|
2779
|
-
* const auth = new google.auth.GoogleAuth({
|
|
2780
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2781
|
-
* scopes: [
|
|
2782
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2783
|
-
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
|
|
2784
|
-
* ],
|
|
2785
|
-
* });
|
|
2786
|
-
*
|
|
2787
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
2788
|
-
* const authClient = await auth.getClient();
|
|
2789
|
-
* google.options({auth: authClient});
|
|
2790
|
-
*
|
|
2791
|
-
* // Do the magic
|
|
2792
|
-
* const res = await serviceusage.services.consumerQuotaMetrics.limits.get({
|
|
2793
|
-
* // The resource name of the quota limit. Use the quota limit resource name returned by previous ListConsumerQuotaMetrics and GetConsumerQuotaMetric API calls.
|
|
2794
|
-
* name: '[^/]+/[^/]+/services/my-service/consumerQuotaMetrics/my-consumerQuotaMetric/limits/my-limit',
|
|
2795
|
-
* // Specifies the level of detail for quota information in the response.
|
|
2796
|
-
* view: 'placeholder-value',
|
|
2797
|
-
* });
|
|
2798
|
-
* console.log(res.data);
|
|
2799
|
-
*
|
|
2800
|
-
* // Example response
|
|
2801
|
-
* // {
|
|
2802
|
-
* // "allowsAdminOverrides": false,
|
|
2803
|
-
* // "isPrecise": false,
|
|
2804
|
-
* // "metric": "my_metric",
|
|
2805
|
-
* // "name": "my_name",
|
|
2806
|
-
* // "quotaBuckets": [],
|
|
2807
|
-
* // "supportedLocations": [],
|
|
2808
|
-
* // "unit": "my_unit"
|
|
2809
|
-
* // }
|
|
2810
|
-
* }
|
|
2811
|
-
*
|
|
2812
|
-
* main().catch(e => {
|
|
2813
|
-
* console.error(e);
|
|
2814
|
-
* throw e;
|
|
2815
|
-
* });
|
|
2816
|
-
*
|
|
2817
|
-
* ```
|
|
2818
2563
|
*
|
|
2819
2564
|
* @param params - Parameters for request
|
|
2820
2565
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2843,76 +2588,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
2843
2588
|
constructor(context: APIRequestContext);
|
|
2844
2589
|
/**
|
|
2845
2590
|
* Creates an admin override. An admin override is applied by an administrator of a parent folder or parent organization of the consumer receiving the override. An admin override is intended to limit the amount of quota the consumer can use out of the total quota pool allocated to all children of the folder or organization.
|
|
2846
|
-
* @example
|
|
2847
|
-
* ```js
|
|
2848
|
-
* // Before running the sample:
|
|
2849
|
-
* // - Enable the API at:
|
|
2850
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
2851
|
-
* // - Login into gcloud by running:
|
|
2852
|
-
* // `$ gcloud auth application-default login`
|
|
2853
|
-
* // - Install the npm module by running:
|
|
2854
|
-
* // `$ npm install googleapis`
|
|
2855
|
-
*
|
|
2856
|
-
* const {google} = require('googleapis');
|
|
2857
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
2858
|
-
*
|
|
2859
|
-
* async function main() {
|
|
2860
|
-
* const auth = new google.auth.GoogleAuth({
|
|
2861
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2862
|
-
* scopes: [
|
|
2863
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2864
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
2865
|
-
* ],
|
|
2866
|
-
* });
|
|
2867
|
-
*
|
|
2868
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
2869
|
-
* const authClient = await auth.getClient();
|
|
2870
|
-
* google.options({auth: authClient});
|
|
2871
|
-
*
|
|
2872
|
-
* // Do the magic
|
|
2873
|
-
* const res =
|
|
2874
|
-
* await serviceusage.services.consumerQuotaMetrics.limits.adminOverrides.create(
|
|
2875
|
-
* {
|
|
2876
|
-
* // Whether to force the creation of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.
|
|
2877
|
-
* force: 'placeholder-value',
|
|
2878
|
-
* // The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.
|
|
2879
|
-
* forceOnly: 'placeholder-value',
|
|
2880
|
-
* // The resource name of the parent quota limit, returned by a ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
|
|
2881
|
-
* parent:
|
|
2882
|
-
* '[^/]+/[^/]+/services/my-service/consumerQuotaMetrics/my-consumerQuotaMetric/limits/my-limit',
|
|
2883
|
-
*
|
|
2884
|
-
* // Request body metadata
|
|
2885
|
-
* requestBody: {
|
|
2886
|
-
* // request body parameters
|
|
2887
|
-
* // {
|
|
2888
|
-
* // "adminOverrideAncestor": "my_adminOverrideAncestor",
|
|
2889
|
-
* // "dimensions": {},
|
|
2890
|
-
* // "metric": "my_metric",
|
|
2891
|
-
* // "name": "my_name",
|
|
2892
|
-
* // "overrideValue": "my_overrideValue",
|
|
2893
|
-
* // "unit": "my_unit"
|
|
2894
|
-
* // }
|
|
2895
|
-
* },
|
|
2896
|
-
* }
|
|
2897
|
-
* );
|
|
2898
|
-
* console.log(res.data);
|
|
2899
|
-
*
|
|
2900
|
-
* // Example response
|
|
2901
|
-
* // {
|
|
2902
|
-
* // "done": false,
|
|
2903
|
-
* // "error": {},
|
|
2904
|
-
* // "metadata": {},
|
|
2905
|
-
* // "name": "my_name",
|
|
2906
|
-
* // "response": {}
|
|
2907
|
-
* // }
|
|
2908
|
-
* }
|
|
2909
|
-
*
|
|
2910
|
-
* main().catch(e => {
|
|
2911
|
-
* console.error(e);
|
|
2912
|
-
* throw e;
|
|
2913
|
-
* });
|
|
2914
|
-
*
|
|
2915
|
-
* ```
|
|
2916
2591
|
*
|
|
2917
2592
|
* @param params - Parameters for request
|
|
2918
2593
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2927,62 +2602,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
2927
2602
|
create(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2928
2603
|
/**
|
|
2929
2604
|
* Deletes an admin override.
|
|
2930
|
-
* @example
|
|
2931
|
-
* ```js
|
|
2932
|
-
* // Before running the sample:
|
|
2933
|
-
* // - Enable the API at:
|
|
2934
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
2935
|
-
* // - Login into gcloud by running:
|
|
2936
|
-
* // `$ gcloud auth application-default login`
|
|
2937
|
-
* // - Install the npm module by running:
|
|
2938
|
-
* // `$ npm install googleapis`
|
|
2939
|
-
*
|
|
2940
|
-
* const {google} = require('googleapis');
|
|
2941
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
2942
|
-
*
|
|
2943
|
-
* async function main() {
|
|
2944
|
-
* const auth = new google.auth.GoogleAuth({
|
|
2945
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2946
|
-
* scopes: [
|
|
2947
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2948
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
2949
|
-
* ],
|
|
2950
|
-
* });
|
|
2951
|
-
*
|
|
2952
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
2953
|
-
* const authClient = await auth.getClient();
|
|
2954
|
-
* google.options({auth: authClient});
|
|
2955
|
-
*
|
|
2956
|
-
* // Do the magic
|
|
2957
|
-
* const res =
|
|
2958
|
-
* await serviceusage.services.consumerQuotaMetrics.limits.adminOverrides.delete(
|
|
2959
|
-
* {
|
|
2960
|
-
* // Whether to force the deletion of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.
|
|
2961
|
-
* force: 'placeholder-value',
|
|
2962
|
-
* // The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.
|
|
2963
|
-
* forceOnly: 'placeholder-value',
|
|
2964
|
-
* // The resource name of the override to delete. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
|
|
2965
|
-
* name: '[^/]+/[^/]+/services/my-service/consumerQuotaMetrics/my-consumerQuotaMetric/limits/my-limit/adminOverrides/my-adminOverride',
|
|
2966
|
-
* }
|
|
2967
|
-
* );
|
|
2968
|
-
* console.log(res.data);
|
|
2969
|
-
*
|
|
2970
|
-
* // Example response
|
|
2971
|
-
* // {
|
|
2972
|
-
* // "done": false,
|
|
2973
|
-
* // "error": {},
|
|
2974
|
-
* // "metadata": {},
|
|
2975
|
-
* // "name": "my_name",
|
|
2976
|
-
* // "response": {}
|
|
2977
|
-
* // }
|
|
2978
|
-
* }
|
|
2979
|
-
*
|
|
2980
|
-
* main().catch(e => {
|
|
2981
|
-
* console.error(e);
|
|
2982
|
-
* throw e;
|
|
2983
|
-
* });
|
|
2984
|
-
*
|
|
2985
|
-
* ```
|
|
2986
2605
|
*
|
|
2987
2606
|
* @param params - Parameters for request
|
|
2988
2607
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2997,60 +2616,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
2997
2616
|
delete(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2998
2617
|
/**
|
|
2999
2618
|
* Lists all admin overrides on this limit.
|
|
3000
|
-
* @example
|
|
3001
|
-
* ```js
|
|
3002
|
-
* // Before running the sample:
|
|
3003
|
-
* // - Enable the API at:
|
|
3004
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
3005
|
-
* // - Login into gcloud by running:
|
|
3006
|
-
* // `$ gcloud auth application-default login`
|
|
3007
|
-
* // - Install the npm module by running:
|
|
3008
|
-
* // `$ npm install googleapis`
|
|
3009
|
-
*
|
|
3010
|
-
* const {google} = require('googleapis');
|
|
3011
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
3012
|
-
*
|
|
3013
|
-
* async function main() {
|
|
3014
|
-
* const auth = new google.auth.GoogleAuth({
|
|
3015
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3016
|
-
* scopes: [
|
|
3017
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
3018
|
-
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
|
|
3019
|
-
* ],
|
|
3020
|
-
* });
|
|
3021
|
-
*
|
|
3022
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
3023
|
-
* const authClient = await auth.getClient();
|
|
3024
|
-
* google.options({auth: authClient});
|
|
3025
|
-
*
|
|
3026
|
-
* // Do the magic
|
|
3027
|
-
* const res =
|
|
3028
|
-
* await serviceusage.services.consumerQuotaMetrics.limits.adminOverrides.list(
|
|
3029
|
-
* {
|
|
3030
|
-
* // Requested size of the next page of data.
|
|
3031
|
-
* pageSize: 'placeholder-value',
|
|
3032
|
-
* // Token identifying which result to start with; returned by a previous list call.
|
|
3033
|
-
* pageToken: 'placeholder-value',
|
|
3034
|
-
* // The resource name of the parent quota limit, returned by a ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
|
|
3035
|
-
* parent:
|
|
3036
|
-
* '[^/]+/[^/]+/services/my-service/consumerQuotaMetrics/my-consumerQuotaMetric/limits/my-limit',
|
|
3037
|
-
* }
|
|
3038
|
-
* );
|
|
3039
|
-
* console.log(res.data);
|
|
3040
|
-
*
|
|
3041
|
-
* // Example response
|
|
3042
|
-
* // {
|
|
3043
|
-
* // "nextPageToken": "my_nextPageToken",
|
|
3044
|
-
* // "overrides": []
|
|
3045
|
-
* // }
|
|
3046
|
-
* }
|
|
3047
|
-
*
|
|
3048
|
-
* main().catch(e => {
|
|
3049
|
-
* console.error(e);
|
|
3050
|
-
* throw e;
|
|
3051
|
-
* });
|
|
3052
|
-
*
|
|
3053
|
-
* ```
|
|
3054
2619
|
*
|
|
3055
2620
|
* @param params - Parameters for request
|
|
3056
2621
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -3065,77 +2630,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
3065
2630
|
list(callback: BodyResponseCallback<Schema$ListAdminOverridesResponse>): void;
|
|
3066
2631
|
/**
|
|
3067
2632
|
* Updates an admin override.
|
|
3068
|
-
* @example
|
|
3069
|
-
* ```js
|
|
3070
|
-
* // Before running the sample:
|
|
3071
|
-
* // - Enable the API at:
|
|
3072
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
3073
|
-
* // - Login into gcloud by running:
|
|
3074
|
-
* // `$ gcloud auth application-default login`
|
|
3075
|
-
* // - Install the npm module by running:
|
|
3076
|
-
* // `$ npm install googleapis`
|
|
3077
|
-
*
|
|
3078
|
-
* const {google} = require('googleapis');
|
|
3079
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
3080
|
-
*
|
|
3081
|
-
* async function main() {
|
|
3082
|
-
* const auth = new google.auth.GoogleAuth({
|
|
3083
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3084
|
-
* scopes: [
|
|
3085
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
3086
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
3087
|
-
* ],
|
|
3088
|
-
* });
|
|
3089
|
-
*
|
|
3090
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
3091
|
-
* const authClient = await auth.getClient();
|
|
3092
|
-
* google.options({auth: authClient});
|
|
3093
|
-
*
|
|
3094
|
-
* // Do the magic
|
|
3095
|
-
* const res =
|
|
3096
|
-
* await serviceusage.services.consumerQuotaMetrics.limits.adminOverrides.patch(
|
|
3097
|
-
* {
|
|
3098
|
-
* // Whether to force the update of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.
|
|
3099
|
-
* force: 'placeholder-value',
|
|
3100
|
-
* // The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.
|
|
3101
|
-
* forceOnly: 'placeholder-value',
|
|
3102
|
-
* // The resource name of the override to update. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
|
|
3103
|
-
* name: '[^/]+/[^/]+/services/my-service/consumerQuotaMetrics/my-consumerQuotaMetric/limits/my-limit/adminOverrides/my-adminOverride',
|
|
3104
|
-
* // Update only the specified fields of the override. If unset, all fields will be updated.
|
|
3105
|
-
* updateMask: 'placeholder-value',
|
|
3106
|
-
*
|
|
3107
|
-
* // Request body metadata
|
|
3108
|
-
* requestBody: {
|
|
3109
|
-
* // request body parameters
|
|
3110
|
-
* // {
|
|
3111
|
-
* // "adminOverrideAncestor": "my_adminOverrideAncestor",
|
|
3112
|
-
* // "dimensions": {},
|
|
3113
|
-
* // "metric": "my_metric",
|
|
3114
|
-
* // "name": "my_name",
|
|
3115
|
-
* // "overrideValue": "my_overrideValue",
|
|
3116
|
-
* // "unit": "my_unit"
|
|
3117
|
-
* // }
|
|
3118
|
-
* },
|
|
3119
|
-
* }
|
|
3120
|
-
* );
|
|
3121
|
-
* console.log(res.data);
|
|
3122
|
-
*
|
|
3123
|
-
* // Example response
|
|
3124
|
-
* // {
|
|
3125
|
-
* // "done": false,
|
|
3126
|
-
* // "error": {},
|
|
3127
|
-
* // "metadata": {},
|
|
3128
|
-
* // "name": "my_name",
|
|
3129
|
-
* // "response": {}
|
|
3130
|
-
* // }
|
|
3131
|
-
* }
|
|
3132
|
-
*
|
|
3133
|
-
* main().catch(e => {
|
|
3134
|
-
* console.error(e);
|
|
3135
|
-
* throw e;
|
|
3136
|
-
* });
|
|
3137
|
-
*
|
|
3138
|
-
* ```
|
|
3139
2633
|
*
|
|
3140
2634
|
* @param params - Parameters for request
|
|
3141
2635
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -3222,76 +2716,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
3222
2716
|
constructor(context: APIRequestContext);
|
|
3223
2717
|
/**
|
|
3224
2718
|
* Creates a consumer override. A consumer override is applied to the consumer on its own authority to limit its own quota usage. Consumer overrides cannot be used to grant more quota than would be allowed by admin overrides, producer overrides, or the default limit of the service.
|
|
3225
|
-
* @example
|
|
3226
|
-
* ```js
|
|
3227
|
-
* // Before running the sample:
|
|
3228
|
-
* // - Enable the API at:
|
|
3229
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
3230
|
-
* // - Login into gcloud by running:
|
|
3231
|
-
* // `$ gcloud auth application-default login`
|
|
3232
|
-
* // - Install the npm module by running:
|
|
3233
|
-
* // `$ npm install googleapis`
|
|
3234
|
-
*
|
|
3235
|
-
* const {google} = require('googleapis');
|
|
3236
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
3237
|
-
*
|
|
3238
|
-
* async function main() {
|
|
3239
|
-
* const auth = new google.auth.GoogleAuth({
|
|
3240
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3241
|
-
* scopes: [
|
|
3242
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
3243
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
3244
|
-
* ],
|
|
3245
|
-
* });
|
|
3246
|
-
*
|
|
3247
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
3248
|
-
* const authClient = await auth.getClient();
|
|
3249
|
-
* google.options({auth: authClient});
|
|
3250
|
-
*
|
|
3251
|
-
* // Do the magic
|
|
3252
|
-
* const res =
|
|
3253
|
-
* await serviceusage.services.consumerQuotaMetrics.limits.consumerOverrides.create(
|
|
3254
|
-
* {
|
|
3255
|
-
* // Whether to force the creation of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.
|
|
3256
|
-
* force: 'placeholder-value',
|
|
3257
|
-
* // The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.
|
|
3258
|
-
* forceOnly: 'placeholder-value',
|
|
3259
|
-
* // The resource name of the parent quota limit, returned by a ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
|
|
3260
|
-
* parent:
|
|
3261
|
-
* '[^/]+/[^/]+/services/my-service/consumerQuotaMetrics/my-consumerQuotaMetric/limits/my-limit',
|
|
3262
|
-
*
|
|
3263
|
-
* // Request body metadata
|
|
3264
|
-
* requestBody: {
|
|
3265
|
-
* // request body parameters
|
|
3266
|
-
* // {
|
|
3267
|
-
* // "adminOverrideAncestor": "my_adminOverrideAncestor",
|
|
3268
|
-
* // "dimensions": {},
|
|
3269
|
-
* // "metric": "my_metric",
|
|
3270
|
-
* // "name": "my_name",
|
|
3271
|
-
* // "overrideValue": "my_overrideValue",
|
|
3272
|
-
* // "unit": "my_unit"
|
|
3273
|
-
* // }
|
|
3274
|
-
* },
|
|
3275
|
-
* }
|
|
3276
|
-
* );
|
|
3277
|
-
* console.log(res.data);
|
|
3278
|
-
*
|
|
3279
|
-
* // Example response
|
|
3280
|
-
* // {
|
|
3281
|
-
* // "done": false,
|
|
3282
|
-
* // "error": {},
|
|
3283
|
-
* // "metadata": {},
|
|
3284
|
-
* // "name": "my_name",
|
|
3285
|
-
* // "response": {}
|
|
3286
|
-
* // }
|
|
3287
|
-
* }
|
|
3288
|
-
*
|
|
3289
|
-
* main().catch(e => {
|
|
3290
|
-
* console.error(e);
|
|
3291
|
-
* throw e;
|
|
3292
|
-
* });
|
|
3293
|
-
*
|
|
3294
|
-
* ```
|
|
3295
2719
|
*
|
|
3296
2720
|
* @param params - Parameters for request
|
|
3297
2721
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -3306,62 +2730,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
3306
2730
|
create(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3307
2731
|
/**
|
|
3308
2732
|
* Deletes a consumer override.
|
|
3309
|
-
* @example
|
|
3310
|
-
* ```js
|
|
3311
|
-
* // Before running the sample:
|
|
3312
|
-
* // - Enable the API at:
|
|
3313
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
3314
|
-
* // - Login into gcloud by running:
|
|
3315
|
-
* // `$ gcloud auth application-default login`
|
|
3316
|
-
* // - Install the npm module by running:
|
|
3317
|
-
* // `$ npm install googleapis`
|
|
3318
|
-
*
|
|
3319
|
-
* const {google} = require('googleapis');
|
|
3320
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
3321
|
-
*
|
|
3322
|
-
* async function main() {
|
|
3323
|
-
* const auth = new google.auth.GoogleAuth({
|
|
3324
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3325
|
-
* scopes: [
|
|
3326
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
3327
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
3328
|
-
* ],
|
|
3329
|
-
* });
|
|
3330
|
-
*
|
|
3331
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
3332
|
-
* const authClient = await auth.getClient();
|
|
3333
|
-
* google.options({auth: authClient});
|
|
3334
|
-
*
|
|
3335
|
-
* // Do the magic
|
|
3336
|
-
* const res =
|
|
3337
|
-
* await serviceusage.services.consumerQuotaMetrics.limits.consumerOverrides.delete(
|
|
3338
|
-
* {
|
|
3339
|
-
* // Whether to force the deletion of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.
|
|
3340
|
-
* force: 'placeholder-value',
|
|
3341
|
-
* // The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.
|
|
3342
|
-
* forceOnly: 'placeholder-value',
|
|
3343
|
-
* // The resource name of the override to delete. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
|
|
3344
|
-
* name: '[^/]+/[^/]+/services/my-service/consumerQuotaMetrics/my-consumerQuotaMetric/limits/my-limit/consumerOverrides/my-consumerOverride',
|
|
3345
|
-
* }
|
|
3346
|
-
* );
|
|
3347
|
-
* console.log(res.data);
|
|
3348
|
-
*
|
|
3349
|
-
* // Example response
|
|
3350
|
-
* // {
|
|
3351
|
-
* // "done": false,
|
|
3352
|
-
* // "error": {},
|
|
3353
|
-
* // "metadata": {},
|
|
3354
|
-
* // "name": "my_name",
|
|
3355
|
-
* // "response": {}
|
|
3356
|
-
* // }
|
|
3357
|
-
* }
|
|
3358
|
-
*
|
|
3359
|
-
* main().catch(e => {
|
|
3360
|
-
* console.error(e);
|
|
3361
|
-
* throw e;
|
|
3362
|
-
* });
|
|
3363
|
-
*
|
|
3364
|
-
* ```
|
|
3365
2733
|
*
|
|
3366
2734
|
* @param params - Parameters for request
|
|
3367
2735
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -3376,60 +2744,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
3376
2744
|
delete(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3377
2745
|
/**
|
|
3378
2746
|
* Lists all consumer overrides on this limit.
|
|
3379
|
-
* @example
|
|
3380
|
-
* ```js
|
|
3381
|
-
* // Before running the sample:
|
|
3382
|
-
* // - Enable the API at:
|
|
3383
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
3384
|
-
* // - Login into gcloud by running:
|
|
3385
|
-
* // `$ gcloud auth application-default login`
|
|
3386
|
-
* // - Install the npm module by running:
|
|
3387
|
-
* // `$ npm install googleapis`
|
|
3388
|
-
*
|
|
3389
|
-
* const {google} = require('googleapis');
|
|
3390
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
3391
|
-
*
|
|
3392
|
-
* async function main() {
|
|
3393
|
-
* const auth = new google.auth.GoogleAuth({
|
|
3394
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3395
|
-
* scopes: [
|
|
3396
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
3397
|
-
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
|
|
3398
|
-
* ],
|
|
3399
|
-
* });
|
|
3400
|
-
*
|
|
3401
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
3402
|
-
* const authClient = await auth.getClient();
|
|
3403
|
-
* google.options({auth: authClient});
|
|
3404
|
-
*
|
|
3405
|
-
* // Do the magic
|
|
3406
|
-
* const res =
|
|
3407
|
-
* await serviceusage.services.consumerQuotaMetrics.limits.consumerOverrides.list(
|
|
3408
|
-
* {
|
|
3409
|
-
* // Requested size of the next page of data.
|
|
3410
|
-
* pageSize: 'placeholder-value',
|
|
3411
|
-
* // Token identifying which result to start with; returned by a previous list call.
|
|
3412
|
-
* pageToken: 'placeholder-value',
|
|
3413
|
-
* // The resource name of the parent quota limit, returned by a ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
|
|
3414
|
-
* parent:
|
|
3415
|
-
* '[^/]+/[^/]+/services/my-service/consumerQuotaMetrics/my-consumerQuotaMetric/limits/my-limit',
|
|
3416
|
-
* }
|
|
3417
|
-
* );
|
|
3418
|
-
* console.log(res.data);
|
|
3419
|
-
*
|
|
3420
|
-
* // Example response
|
|
3421
|
-
* // {
|
|
3422
|
-
* // "nextPageToken": "my_nextPageToken",
|
|
3423
|
-
* // "overrides": []
|
|
3424
|
-
* // }
|
|
3425
|
-
* }
|
|
3426
|
-
*
|
|
3427
|
-
* main().catch(e => {
|
|
3428
|
-
* console.error(e);
|
|
3429
|
-
* throw e;
|
|
3430
|
-
* });
|
|
3431
|
-
*
|
|
3432
|
-
* ```
|
|
3433
2747
|
*
|
|
3434
2748
|
* @param params - Parameters for request
|
|
3435
2749
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -3444,77 +2758,6 @@ export declare namespace serviceusage_v1beta1 {
|
|
|
3444
2758
|
list(callback: BodyResponseCallback<Schema$ListConsumerOverridesResponse>): void;
|
|
3445
2759
|
/**
|
|
3446
2760
|
* Updates a consumer override.
|
|
3447
|
-
* @example
|
|
3448
|
-
* ```js
|
|
3449
|
-
* // Before running the sample:
|
|
3450
|
-
* // - Enable the API at:
|
|
3451
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
3452
|
-
* // - Login into gcloud by running:
|
|
3453
|
-
* // `$ gcloud auth application-default login`
|
|
3454
|
-
* // - Install the npm module by running:
|
|
3455
|
-
* // `$ npm install googleapis`
|
|
3456
|
-
*
|
|
3457
|
-
* const {google} = require('googleapis');
|
|
3458
|
-
* const serviceusage = google.serviceusage('v1beta1');
|
|
3459
|
-
*
|
|
3460
|
-
* async function main() {
|
|
3461
|
-
* const auth = new google.auth.GoogleAuth({
|
|
3462
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3463
|
-
* scopes: [
|
|
3464
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
3465
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
3466
|
-
* ],
|
|
3467
|
-
* });
|
|
3468
|
-
*
|
|
3469
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
3470
|
-
* const authClient = await auth.getClient();
|
|
3471
|
-
* google.options({auth: authClient});
|
|
3472
|
-
*
|
|
3473
|
-
* // Do the magic
|
|
3474
|
-
* const res =
|
|
3475
|
-
* await serviceusage.services.consumerQuotaMetrics.limits.consumerOverrides.patch(
|
|
3476
|
-
* {
|
|
3477
|
-
* // Whether to force the update of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.
|
|
3478
|
-
* force: 'placeholder-value',
|
|
3479
|
-
* // The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.
|
|
3480
|
-
* forceOnly: 'placeholder-value',
|
|
3481
|
-
* // The resource name of the override to update. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
|
|
3482
|
-
* name: '[^/]+/[^/]+/services/my-service/consumerQuotaMetrics/my-consumerQuotaMetric/limits/my-limit/consumerOverrides/my-consumerOverride',
|
|
3483
|
-
* // Update only the specified fields of the override. If unset, all fields will be updated.
|
|
3484
|
-
* updateMask: 'placeholder-value',
|
|
3485
|
-
*
|
|
3486
|
-
* // Request body metadata
|
|
3487
|
-
* requestBody: {
|
|
3488
|
-
* // request body parameters
|
|
3489
|
-
* // {
|
|
3490
|
-
* // "adminOverrideAncestor": "my_adminOverrideAncestor",
|
|
3491
|
-
* // "dimensions": {},
|
|
3492
|
-
* // "metric": "my_metric",
|
|
3493
|
-
* // "name": "my_name",
|
|
3494
|
-
* // "overrideValue": "my_overrideValue",
|
|
3495
|
-
* // "unit": "my_unit"
|
|
3496
|
-
* // }
|
|
3497
|
-
* },
|
|
3498
|
-
* }
|
|
3499
|
-
* );
|
|
3500
|
-
* console.log(res.data);
|
|
3501
|
-
*
|
|
3502
|
-
* // Example response
|
|
3503
|
-
* // {
|
|
3504
|
-
* // "done": false,
|
|
3505
|
-
* // "error": {},
|
|
3506
|
-
* // "metadata": {},
|
|
3507
|
-
* // "name": "my_name",
|
|
3508
|
-
* // "response": {}
|
|
3509
|
-
* // }
|
|
3510
|
-
* }
|
|
3511
|
-
*
|
|
3512
|
-
* main().catch(e => {
|
|
3513
|
-
* console.error(e);
|
|
3514
|
-
* throw e;
|
|
3515
|
-
* });
|
|
3516
|
-
*
|
|
3517
|
-
* ```
|
|
3518
2761
|
*
|
|
3519
2762
|
* @param params - Parameters for request
|
|
3520
2763
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|