@googleapis/serviceusage 7.0.0 → 9.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 +30 -0
- package/build/v1.d.ts +410 -516
- package/build/v1.js.map +1 -1
- package/build/v1beta1.d.ts +446 -1203
- package/build/v1beta1.js.map +1 -1
- package/index.ts +1 -1
- package/package.json +2 -2
- package/v1.ts +397 -516
- package/v1beta1.ts +431 -1203
package/build/v1.d.ts
CHANGED
|
@@ -72,6 +72,24 @@ export declare namespace serviceusage_v1 {
|
|
|
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_v1 {
|
|
|
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_v1 {
|
|
|
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.
|
|
@@ -331,6 +359,95 @@ export declare namespace serviceusage_v1 {
|
|
|
331
359
|
*/
|
|
332
360
|
export interface Schema$CancelOperationRequest {
|
|
333
361
|
}
|
|
362
|
+
/**
|
|
363
|
+
* Details about how and where to publish client libraries.
|
|
364
|
+
*/
|
|
365
|
+
export interface Schema$ClientLibrarySettings {
|
|
366
|
+
/**
|
|
367
|
+
* Settings for C++ client libraries.
|
|
368
|
+
*/
|
|
369
|
+
cppSettings?: Schema$CppSettings;
|
|
370
|
+
/**
|
|
371
|
+
* Settings for .NET client libraries.
|
|
372
|
+
*/
|
|
373
|
+
dotnetSettings?: Schema$DotnetSettings;
|
|
374
|
+
/**
|
|
375
|
+
* Settings for Go client libraries.
|
|
376
|
+
*/
|
|
377
|
+
goSettings?: Schema$GoSettings;
|
|
378
|
+
/**
|
|
379
|
+
* Settings for legacy Java features, supported in the Service YAML.
|
|
380
|
+
*/
|
|
381
|
+
javaSettings?: Schema$JavaSettings;
|
|
382
|
+
/**
|
|
383
|
+
* Launch stage of this version of the API.
|
|
384
|
+
*/
|
|
385
|
+
launchStage?: string | null;
|
|
386
|
+
/**
|
|
387
|
+
* Settings for Node client libraries.
|
|
388
|
+
*/
|
|
389
|
+
nodeSettings?: Schema$NodeSettings;
|
|
390
|
+
/**
|
|
391
|
+
* Settings for PHP client libraries.
|
|
392
|
+
*/
|
|
393
|
+
phpSettings?: Schema$PhpSettings;
|
|
394
|
+
/**
|
|
395
|
+
* Settings for Python client libraries.
|
|
396
|
+
*/
|
|
397
|
+
pythonSettings?: Schema$PythonSettings;
|
|
398
|
+
/**
|
|
399
|
+
* When using transport=rest, the client request will encode enums as numbers rather than strings.
|
|
400
|
+
*/
|
|
401
|
+
restNumericEnums?: boolean | null;
|
|
402
|
+
/**
|
|
403
|
+
* Settings for Ruby client libraries.
|
|
404
|
+
*/
|
|
405
|
+
rubySettings?: Schema$RubySettings;
|
|
406
|
+
/**
|
|
407
|
+
* 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".
|
|
408
|
+
*/
|
|
409
|
+
version?: string | null;
|
|
410
|
+
}
|
|
411
|
+
/**
|
|
412
|
+
* Required information for every language.
|
|
413
|
+
*/
|
|
414
|
+
export interface Schema$CommonLanguageSettings {
|
|
415
|
+
/**
|
|
416
|
+
* The destination where API teams want this client library to be published.
|
|
417
|
+
*/
|
|
418
|
+
destinations?: string[] | null;
|
|
419
|
+
/**
|
|
420
|
+
* Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
|
|
421
|
+
*/
|
|
422
|
+
referenceDocsUri?: string | null;
|
|
423
|
+
}
|
|
424
|
+
/**
|
|
425
|
+
* Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy.
|
|
426
|
+
*/
|
|
427
|
+
export interface Schema$ConsumerPolicy {
|
|
428
|
+
/**
|
|
429
|
+
* 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)
|
|
430
|
+
*/
|
|
431
|
+
annotations?: {
|
|
432
|
+
[key: string]: string;
|
|
433
|
+
} | null;
|
|
434
|
+
/**
|
|
435
|
+
* Enable rules define usable services and service groups.
|
|
436
|
+
*/
|
|
437
|
+
enableRules?: Schema$EnableRule[];
|
|
438
|
+
/**
|
|
439
|
+
* An opaque tag indicating the current version of the policy, used for concurrency control.
|
|
440
|
+
*/
|
|
441
|
+
etag?: string | null;
|
|
442
|
+
/**
|
|
443
|
+
* 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`
|
|
444
|
+
*/
|
|
445
|
+
name?: string | null;
|
|
446
|
+
/**
|
|
447
|
+
* The last-modified time.
|
|
448
|
+
*/
|
|
449
|
+
updateTime?: string | null;
|
|
450
|
+
}
|
|
334
451
|
/**
|
|
335
452
|
* `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.
|
|
336
453
|
*/
|
|
@@ -366,13 +483,26 @@ export declare namespace serviceusage_v1 {
|
|
|
366
483
|
selector?: string | null;
|
|
367
484
|
}
|
|
368
485
|
/**
|
|
369
|
-
* Selects and configures the service controller used by the service.
|
|
486
|
+
* Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com
|
|
370
487
|
*/
|
|
371
488
|
export interface Schema$Control {
|
|
372
489
|
/**
|
|
373
490
|
* 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
|
|
374
491
|
*/
|
|
375
492
|
environment?: string | null;
|
|
493
|
+
/**
|
|
494
|
+
* Defines policies applying to the API methods of the service.
|
|
495
|
+
*/
|
|
496
|
+
methodPolicies?: Schema$MethodPolicy[];
|
|
497
|
+
}
|
|
498
|
+
/**
|
|
499
|
+
* Settings for C++ client libraries.
|
|
500
|
+
*/
|
|
501
|
+
export interface Schema$CppSettings {
|
|
502
|
+
/**
|
|
503
|
+
* Some settings.
|
|
504
|
+
*/
|
|
505
|
+
common?: Schema$CommonLanguageSettings;
|
|
376
506
|
}
|
|
377
507
|
/**
|
|
378
508
|
* Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by CreateAdminQuotaPolicy.
|
|
@@ -446,7 +576,7 @@ export declare namespace serviceusage_v1 {
|
|
|
446
576
|
service?: Schema$GoogleApiServiceusageV1Service;
|
|
447
577
|
}
|
|
448
578
|
/**
|
|
449
|
-
* `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
|
|
579
|
+
* `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.
|
|
450
580
|
*/
|
|
451
581
|
export interface Schema$Documentation {
|
|
452
582
|
/**
|
|
@@ -465,6 +595,10 @@ export declare namespace serviceusage_v1 {
|
|
|
465
595
|
* A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
|
|
466
596
|
*/
|
|
467
597
|
rules?: Schema$DocumentationRule[];
|
|
598
|
+
/**
|
|
599
|
+
* Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
|
|
600
|
+
*/
|
|
601
|
+
sectionOverrides?: Schema$Page[];
|
|
468
602
|
/**
|
|
469
603
|
* 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.
|
|
470
604
|
*/
|
|
@@ -486,11 +620,48 @@ export declare namespace serviceusage_v1 {
|
|
|
486
620
|
* 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.
|
|
487
621
|
*/
|
|
488
622
|
description?: string | null;
|
|
623
|
+
/**
|
|
624
|
+
* String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
|
|
625
|
+
*/
|
|
626
|
+
disableReplacementWords?: string | null;
|
|
489
627
|
/**
|
|
490
628
|
* 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.
|
|
491
629
|
*/
|
|
492
630
|
selector?: string | null;
|
|
493
631
|
}
|
|
632
|
+
/**
|
|
633
|
+
* Settings for Dotnet client libraries.
|
|
634
|
+
*/
|
|
635
|
+
export interface Schema$DotnetSettings {
|
|
636
|
+
/**
|
|
637
|
+
* Some settings.
|
|
638
|
+
*/
|
|
639
|
+
common?: Schema$CommonLanguageSettings;
|
|
640
|
+
/**
|
|
641
|
+
* Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
|
|
642
|
+
*/
|
|
643
|
+
forcedNamespaceAliases?: string[] | null;
|
|
644
|
+
/**
|
|
645
|
+
* 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.
|
|
646
|
+
*/
|
|
647
|
+
handwrittenSignatures?: string[] | null;
|
|
648
|
+
/**
|
|
649
|
+
* 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"
|
|
650
|
+
*/
|
|
651
|
+
ignoredResources?: string[] | null;
|
|
652
|
+
/**
|
|
653
|
+
* 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"
|
|
654
|
+
*/
|
|
655
|
+
renamedResources?: {
|
|
656
|
+
[key: string]: string;
|
|
657
|
+
} | null;
|
|
658
|
+
/**
|
|
659
|
+
* 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.
|
|
660
|
+
*/
|
|
661
|
+
renamedServices?: {
|
|
662
|
+
[key: string]: string;
|
|
663
|
+
} | null;
|
|
664
|
+
}
|
|
494
665
|
/**
|
|
495
666
|
* 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); \}
|
|
496
667
|
*/
|
|
@@ -509,6 +680,27 @@ export declare namespace serviceusage_v1 {
|
|
|
509
680
|
*/
|
|
510
681
|
serviceId?: string | null;
|
|
511
682
|
}
|
|
683
|
+
/**
|
|
684
|
+
* The consumer policy rule that defines usable services and service groups.
|
|
685
|
+
*/
|
|
686
|
+
export interface Schema$EnableRule {
|
|
687
|
+
/**
|
|
688
|
+
* Client and resource project enable type.
|
|
689
|
+
*/
|
|
690
|
+
enableType?: string | null;
|
|
691
|
+
/**
|
|
692
|
+
* 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`.
|
|
693
|
+
*/
|
|
694
|
+
groups?: string[] | null;
|
|
695
|
+
/**
|
|
696
|
+
* DEPRECATED: Please use field `values`. Service should have prefix `services/`. The names of the services that are enabled. Example: `storage.googleapis.com`.
|
|
697
|
+
*/
|
|
698
|
+
services?: string[] | null;
|
|
699
|
+
/**
|
|
700
|
+
* The names of the services or service groups that are enabled. Example: `services/storage.googleapis.com`, groups/googleServices`, groups/allServices`.
|
|
701
|
+
*/
|
|
702
|
+
values?: string[] | null;
|
|
703
|
+
}
|
|
512
704
|
/**
|
|
513
705
|
* Request message for the `EnableService` method.
|
|
514
706
|
*/
|
|
@@ -527,6 +719,10 @@ export declare namespace serviceusage_v1 {
|
|
|
527
719
|
* `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
|
|
528
720
|
*/
|
|
529
721
|
export interface Schema$Endpoint {
|
|
722
|
+
/**
|
|
723
|
+
* 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.
|
|
724
|
+
*/
|
|
725
|
+
aliases?: string[] | null;
|
|
530
726
|
/**
|
|
531
727
|
* 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.
|
|
532
728
|
*/
|
|
@@ -544,6 +740,10 @@ export declare namespace serviceusage_v1 {
|
|
|
544
740
|
* Enum type definition.
|
|
545
741
|
*/
|
|
546
742
|
export interface Schema$Enum {
|
|
743
|
+
/**
|
|
744
|
+
* The source edition string, only valid when syntax is SYNTAX_EDITIONS.
|
|
745
|
+
*/
|
|
746
|
+
edition?: string | null;
|
|
547
747
|
/**
|
|
548
748
|
* Enum value definitions.
|
|
549
749
|
*/
|
|
@@ -627,6 +827,23 @@ export declare namespace serviceusage_v1 {
|
|
|
627
827
|
*/
|
|
628
828
|
typeUrl?: string | null;
|
|
629
829
|
}
|
|
830
|
+
/**
|
|
831
|
+
* 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.
|
|
832
|
+
*/
|
|
833
|
+
export interface Schema$FieldPolicy {
|
|
834
|
+
/**
|
|
835
|
+
* 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".
|
|
836
|
+
*/
|
|
837
|
+
resourcePermission?: string | null;
|
|
838
|
+
/**
|
|
839
|
+
* Specifies the resource type for the resource referred to by the field.
|
|
840
|
+
*/
|
|
841
|
+
resourceType?: string | null;
|
|
842
|
+
/**
|
|
843
|
+
* 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".
|
|
844
|
+
*/
|
|
845
|
+
selector?: string | null;
|
|
846
|
+
}
|
|
630
847
|
/**
|
|
631
848
|
* Metadata for the `GetServiceIdentity` method.
|
|
632
849
|
*/
|
|
@@ -729,6 +946,10 @@ export declare namespace serviceusage_v1 {
|
|
|
729
946
|
* The Google project that owns this service.
|
|
730
947
|
*/
|
|
731
948
|
producerProjectId?: string | null;
|
|
949
|
+
/**
|
|
950
|
+
* Settings for [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from APIs defined as protocol buffers.
|
|
951
|
+
*/
|
|
952
|
+
publishing?: Schema$Publishing;
|
|
732
953
|
/**
|
|
733
954
|
* Quota configuration.
|
|
734
955
|
*/
|
|
@@ -859,6 +1080,15 @@ export declare namespace serviceusage_v1 {
|
|
|
859
1080
|
*/
|
|
860
1081
|
usage?: Schema$Usage;
|
|
861
1082
|
}
|
|
1083
|
+
/**
|
|
1084
|
+
* Settings for Go client libraries.
|
|
1085
|
+
*/
|
|
1086
|
+
export interface Schema$GoSettings {
|
|
1087
|
+
/**
|
|
1088
|
+
* Some settings.
|
|
1089
|
+
*/
|
|
1090
|
+
common?: Schema$CommonLanguageSettings;
|
|
1091
|
+
}
|
|
862
1092
|
/**
|
|
863
1093
|
* 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.
|
|
864
1094
|
*/
|
|
@@ -959,6 +1189,25 @@ export declare namespace serviceusage_v1 {
|
|
|
959
1189
|
*/
|
|
960
1190
|
overrides?: Schema$QuotaOverride[];
|
|
961
1191
|
}
|
|
1192
|
+
/**
|
|
1193
|
+
* Settings for Java client libraries.
|
|
1194
|
+
*/
|
|
1195
|
+
export interface Schema$JavaSettings {
|
|
1196
|
+
/**
|
|
1197
|
+
* Some settings.
|
|
1198
|
+
*/
|
|
1199
|
+
common?: Schema$CommonLanguageSettings;
|
|
1200
|
+
/**
|
|
1201
|
+
* 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
|
|
1202
|
+
*/
|
|
1203
|
+
libraryPackage?: string | null;
|
|
1204
|
+
/**
|
|
1205
|
+
* 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
|
|
1206
|
+
*/
|
|
1207
|
+
serviceClassNames?: {
|
|
1208
|
+
[key: string]: string;
|
|
1209
|
+
} | null;
|
|
1210
|
+
}
|
|
962
1211
|
/**
|
|
963
1212
|
* Specifies a location to extract JWT from an API request.
|
|
964
1213
|
*/
|
|
@@ -1070,6 +1319,27 @@ export declare namespace serviceusage_v1 {
|
|
|
1070
1319
|
*/
|
|
1071
1320
|
monitoredResource?: string | null;
|
|
1072
1321
|
}
|
|
1322
|
+
/**
|
|
1323
|
+
* 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)).
|
|
1324
|
+
*/
|
|
1325
|
+
export interface Schema$LongRunning {
|
|
1326
|
+
/**
|
|
1327
|
+
* Initial delay after which the first poll request will be made. Default value: 5 seconds.
|
|
1328
|
+
*/
|
|
1329
|
+
initialPollDelay?: string | null;
|
|
1330
|
+
/**
|
|
1331
|
+
* Maximum time between two subsequent poll requests. Default value: 45 seconds.
|
|
1332
|
+
*/
|
|
1333
|
+
maxPollDelay?: string | null;
|
|
1334
|
+
/**
|
|
1335
|
+
* Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
|
|
1336
|
+
*/
|
|
1337
|
+
pollDelayMultiplier?: number | null;
|
|
1338
|
+
/**
|
|
1339
|
+
* Total polling timeout. Default value: 5 minutes.
|
|
1340
|
+
*/
|
|
1341
|
+
totalPollTimeout?: string | null;
|
|
1342
|
+
}
|
|
1073
1343
|
/**
|
|
1074
1344
|
* Method represents a method of an API interface.
|
|
1075
1345
|
*/
|
|
@@ -1103,6 +1373,32 @@ export declare namespace serviceusage_v1 {
|
|
|
1103
1373
|
*/
|
|
1104
1374
|
syntax?: string | null;
|
|
1105
1375
|
}
|
|
1376
|
+
/**
|
|
1377
|
+
* Defines policies applying to an RPC method.
|
|
1378
|
+
*/
|
|
1379
|
+
export interface Schema$MethodPolicy {
|
|
1380
|
+
/**
|
|
1381
|
+
* Policies that are applicable to the request message.
|
|
1382
|
+
*/
|
|
1383
|
+
requestPolicies?: Schema$FieldPolicy[];
|
|
1384
|
+
/**
|
|
1385
|
+
* 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 .
|
|
1386
|
+
*/
|
|
1387
|
+
selector?: string | null;
|
|
1388
|
+
}
|
|
1389
|
+
/**
|
|
1390
|
+
* Describes the generator configuration for a method.
|
|
1391
|
+
*/
|
|
1392
|
+
export interface Schema$MethodSettings {
|
|
1393
|
+
/**
|
|
1394
|
+
* 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
|
|
1395
|
+
*/
|
|
1396
|
+
longRunning?: Schema$LongRunning;
|
|
1397
|
+
/**
|
|
1398
|
+
* The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
|
|
1399
|
+
*/
|
|
1400
|
+
selector?: string | null;
|
|
1401
|
+
}
|
|
1106
1402
|
/**
|
|
1107
1403
|
* 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.
|
|
1108
1404
|
*/
|
|
@@ -1185,7 +1481,7 @@ export declare namespace serviceusage_v1 {
|
|
|
1185
1481
|
selector?: string | null;
|
|
1186
1482
|
}
|
|
1187
1483
|
/**
|
|
1188
|
-
* 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
|
|
1484
|
+
* 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"; \} ... \}
|
|
1189
1485
|
*/
|
|
1190
1486
|
export interface Schema$Mixin {
|
|
1191
1487
|
/**
|
|
@@ -1252,6 +1548,15 @@ export declare namespace serviceusage_v1 {
|
|
|
1252
1548
|
*/
|
|
1253
1549
|
monitoredResource?: string | null;
|
|
1254
1550
|
}
|
|
1551
|
+
/**
|
|
1552
|
+
* Settings for Node client libraries.
|
|
1553
|
+
*/
|
|
1554
|
+
export interface Schema$NodeSettings {
|
|
1555
|
+
/**
|
|
1556
|
+
* Some settings.
|
|
1557
|
+
*/
|
|
1558
|
+
common?: Schema$CommonLanguageSettings;
|
|
1559
|
+
}
|
|
1255
1560
|
/**
|
|
1256
1561
|
* 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.
|
|
1257
1562
|
*/
|
|
@@ -1284,7 +1589,7 @@ export declare namespace serviceusage_v1 {
|
|
|
1284
1589
|
*/
|
|
1285
1590
|
name?: string | null;
|
|
1286
1591
|
/**
|
|
1287
|
-
* The normal response of the operation
|
|
1592
|
+
* 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`.
|
|
1288
1593
|
*/
|
|
1289
1594
|
response?: {
|
|
1290
1595
|
[key: string]: any;
|
|
@@ -1331,6 +1636,69 @@ export declare namespace serviceusage_v1 {
|
|
|
1331
1636
|
*/
|
|
1332
1637
|
subpages?: Schema$Page[];
|
|
1333
1638
|
}
|
|
1639
|
+
/**
|
|
1640
|
+
* Settings for Php client libraries.
|
|
1641
|
+
*/
|
|
1642
|
+
export interface Schema$PhpSettings {
|
|
1643
|
+
/**
|
|
1644
|
+
* Some settings.
|
|
1645
|
+
*/
|
|
1646
|
+
common?: Schema$CommonLanguageSettings;
|
|
1647
|
+
}
|
|
1648
|
+
/**
|
|
1649
|
+
* 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.
|
|
1650
|
+
*/
|
|
1651
|
+
export interface Schema$Publishing {
|
|
1652
|
+
/**
|
|
1653
|
+
* Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
|
|
1654
|
+
*/
|
|
1655
|
+
apiShortName?: string | null;
|
|
1656
|
+
/**
|
|
1657
|
+
* GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
|
|
1658
|
+
*/
|
|
1659
|
+
codeownerGithubTeams?: string[] | null;
|
|
1660
|
+
/**
|
|
1661
|
+
* A prefix used in sample code when demarking regions to be included in documentation.
|
|
1662
|
+
*/
|
|
1663
|
+
docTagPrefix?: string | null;
|
|
1664
|
+
/**
|
|
1665
|
+
* Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
|
|
1666
|
+
*/
|
|
1667
|
+
documentationUri?: string | null;
|
|
1668
|
+
/**
|
|
1669
|
+
* GitHub label to apply to issues and pull requests opened for this API.
|
|
1670
|
+
*/
|
|
1671
|
+
githubLabel?: string | null;
|
|
1672
|
+
/**
|
|
1673
|
+
* 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.
|
|
1674
|
+
*/
|
|
1675
|
+
librarySettings?: Schema$ClientLibrarySettings[];
|
|
1676
|
+
/**
|
|
1677
|
+
* A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
|
|
1678
|
+
*/
|
|
1679
|
+
methodSettings?: Schema$MethodSettings[];
|
|
1680
|
+
/**
|
|
1681
|
+
* Link to a *public* URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
|
|
1682
|
+
*/
|
|
1683
|
+
newIssueUri?: string | null;
|
|
1684
|
+
/**
|
|
1685
|
+
* For whom the client library is being published.
|
|
1686
|
+
*/
|
|
1687
|
+
organization?: string | null;
|
|
1688
|
+
/**
|
|
1689
|
+
* Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
|
|
1690
|
+
*/
|
|
1691
|
+
protoReferenceDocumentationUri?: string | null;
|
|
1692
|
+
}
|
|
1693
|
+
/**
|
|
1694
|
+
* Settings for Python client libraries.
|
|
1695
|
+
*/
|
|
1696
|
+
export interface Schema$PythonSettings {
|
|
1697
|
+
/**
|
|
1698
|
+
* Some settings.
|
|
1699
|
+
*/
|
|
1700
|
+
common?: Schema$CommonLanguageSettings;
|
|
1701
|
+
}
|
|
1334
1702
|
/**
|
|
1335
1703
|
* 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
|
|
1336
1704
|
*/
|
|
@@ -1422,6 +1790,33 @@ export declare namespace serviceusage_v1 {
|
|
|
1422
1790
|
*/
|
|
1423
1791
|
unit?: string | null;
|
|
1424
1792
|
}
|
|
1793
|
+
/**
|
|
1794
|
+
* Metadata for the `RemoveEnableRules` method.
|
|
1795
|
+
*/
|
|
1796
|
+
export interface Schema$RemoveEnableRulesMetadata {
|
|
1797
|
+
}
|
|
1798
|
+
/**
|
|
1799
|
+
* The response message of "RemoveEnableRules" method.
|
|
1800
|
+
*/
|
|
1801
|
+
export interface Schema$RemoveEnableRulesResponse {
|
|
1802
|
+
/**
|
|
1803
|
+
* The parent consumer policy. It can be `projects/12345/consumerPolicies/default`, or `folders/12345/consumerPolicies/default`, or `organizations/12345/consumerPolicies/default`.
|
|
1804
|
+
*/
|
|
1805
|
+
parent?: string | null;
|
|
1806
|
+
/**
|
|
1807
|
+
* The values removed from the parent consumer policy.
|
|
1808
|
+
*/
|
|
1809
|
+
removedValues?: string[] | null;
|
|
1810
|
+
}
|
|
1811
|
+
/**
|
|
1812
|
+
* Settings for Ruby client libraries.
|
|
1813
|
+
*/
|
|
1814
|
+
export interface Schema$RubySettings {
|
|
1815
|
+
/**
|
|
1816
|
+
* Some settings.
|
|
1817
|
+
*/
|
|
1818
|
+
common?: Schema$CommonLanguageSettings;
|
|
1819
|
+
}
|
|
1425
1820
|
/**
|
|
1426
1821
|
* Service identity for a service. This is the identity that service producer should use to access consumer resources.
|
|
1427
1822
|
*/
|
|
@@ -1517,6 +1912,10 @@ export declare namespace serviceusage_v1 {
|
|
|
1517
1912
|
* A protocol buffer message type.
|
|
1518
1913
|
*/
|
|
1519
1914
|
export interface Schema$Type {
|
|
1915
|
+
/**
|
|
1916
|
+
* The source edition string, only valid when syntax is SYNTAX_EDITIONS.
|
|
1917
|
+
*/
|
|
1918
|
+
edition?: string | null;
|
|
1520
1919
|
/**
|
|
1521
1920
|
* The list of fields.
|
|
1522
1921
|
*/
|
|
@@ -1547,6 +1946,11 @@ export declare namespace serviceusage_v1 {
|
|
|
1547
1946
|
*/
|
|
1548
1947
|
export interface Schema$UpdateAdminQuotaPolicyMetadata {
|
|
1549
1948
|
}
|
|
1949
|
+
/**
|
|
1950
|
+
* Metadata for the `UpdateConsumerPolicy` method.
|
|
1951
|
+
*/
|
|
1952
|
+
export interface Schema$UpdateConsumerPolicyMetadata {
|
|
1953
|
+
}
|
|
1550
1954
|
/**
|
|
1551
1955
|
* Configuration controlling usage of a service.
|
|
1552
1956
|
*/
|
|
@@ -1586,55 +1990,6 @@ export declare namespace serviceusage_v1 {
|
|
|
1586
1990
|
constructor(context: APIRequestContext);
|
|
1587
1991
|
/**
|
|
1588
1992
|
* Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
|
|
1589
|
-
* @example
|
|
1590
|
-
* ```js
|
|
1591
|
-
* // Before running the sample:
|
|
1592
|
-
* // - Enable the API at:
|
|
1593
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
1594
|
-
* // - Login into gcloud by running:
|
|
1595
|
-
* // `$ gcloud auth application-default login`
|
|
1596
|
-
* // - Install the npm module by running:
|
|
1597
|
-
* // `$ npm install googleapis`
|
|
1598
|
-
*
|
|
1599
|
-
* const {google} = require('googleapis');
|
|
1600
|
-
* const serviceusage = google.serviceusage('v1');
|
|
1601
|
-
*
|
|
1602
|
-
* async function main() {
|
|
1603
|
-
* const auth = new google.auth.GoogleAuth({
|
|
1604
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1605
|
-
* scopes: [
|
|
1606
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
1607
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
1608
|
-
* ],
|
|
1609
|
-
* });
|
|
1610
|
-
*
|
|
1611
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
1612
|
-
* const authClient = await auth.getClient();
|
|
1613
|
-
* google.options({auth: authClient});
|
|
1614
|
-
*
|
|
1615
|
-
* // Do the magic
|
|
1616
|
-
* const res = await serviceusage.operations.cancel({
|
|
1617
|
-
* // The name of the operation resource to be cancelled.
|
|
1618
|
-
* name: 'operations/.*',
|
|
1619
|
-
*
|
|
1620
|
-
* // Request body metadata
|
|
1621
|
-
* requestBody: {
|
|
1622
|
-
* // request body parameters
|
|
1623
|
-
* // {}
|
|
1624
|
-
* },
|
|
1625
|
-
* });
|
|
1626
|
-
* console.log(res.data);
|
|
1627
|
-
*
|
|
1628
|
-
* // Example response
|
|
1629
|
-
* // {}
|
|
1630
|
-
* }
|
|
1631
|
-
*
|
|
1632
|
-
* main().catch(e => {
|
|
1633
|
-
* console.error(e);
|
|
1634
|
-
* throw e;
|
|
1635
|
-
* });
|
|
1636
|
-
*
|
|
1637
|
-
* ```
|
|
1638
1993
|
*
|
|
1639
1994
|
* @param params - Parameters for request
|
|
1640
1995
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1649,49 +2004,6 @@ export declare namespace serviceusage_v1 {
|
|
|
1649
2004
|
cancel(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
1650
2005
|
/**
|
|
1651
2006
|
* Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
|
1652
|
-
* @example
|
|
1653
|
-
* ```js
|
|
1654
|
-
* // Before running the sample:
|
|
1655
|
-
* // - Enable the API at:
|
|
1656
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
1657
|
-
* // - Login into gcloud by running:
|
|
1658
|
-
* // `$ gcloud auth application-default login`
|
|
1659
|
-
* // - Install the npm module by running:
|
|
1660
|
-
* // `$ npm install googleapis`
|
|
1661
|
-
*
|
|
1662
|
-
* const {google} = require('googleapis');
|
|
1663
|
-
* const serviceusage = google.serviceusage('v1');
|
|
1664
|
-
*
|
|
1665
|
-
* async function main() {
|
|
1666
|
-
* const auth = new google.auth.GoogleAuth({
|
|
1667
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1668
|
-
* scopes: [
|
|
1669
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
1670
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
1671
|
-
* ],
|
|
1672
|
-
* });
|
|
1673
|
-
*
|
|
1674
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
1675
|
-
* const authClient = await auth.getClient();
|
|
1676
|
-
* google.options({auth: authClient});
|
|
1677
|
-
*
|
|
1678
|
-
* // Do the magic
|
|
1679
|
-
* const res = await serviceusage.operations.delete({
|
|
1680
|
-
* // The name of the operation resource to be deleted.
|
|
1681
|
-
* name: 'operations/.*',
|
|
1682
|
-
* });
|
|
1683
|
-
* console.log(res.data);
|
|
1684
|
-
*
|
|
1685
|
-
* // Example response
|
|
1686
|
-
* // {}
|
|
1687
|
-
* }
|
|
1688
|
-
*
|
|
1689
|
-
* main().catch(e => {
|
|
1690
|
-
* console.error(e);
|
|
1691
|
-
* throw e;
|
|
1692
|
-
* });
|
|
1693
|
-
*
|
|
1694
|
-
* ```
|
|
1695
2007
|
*
|
|
1696
2008
|
* @param params - Parameters for request
|
|
1697
2009
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1706,55 +2018,6 @@ export declare namespace serviceusage_v1 {
|
|
|
1706
2018
|
delete(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
1707
2019
|
/**
|
|
1708
2020
|
* 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.
|
|
1709
|
-
* @example
|
|
1710
|
-
* ```js
|
|
1711
|
-
* // Before running the sample:
|
|
1712
|
-
* // - Enable the API at:
|
|
1713
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
1714
|
-
* // - Login into gcloud by running:
|
|
1715
|
-
* // `$ gcloud auth application-default login`
|
|
1716
|
-
* // - Install the npm module by running:
|
|
1717
|
-
* // `$ npm install googleapis`
|
|
1718
|
-
*
|
|
1719
|
-
* const {google} = require('googleapis');
|
|
1720
|
-
* const serviceusage = google.serviceusage('v1');
|
|
1721
|
-
*
|
|
1722
|
-
* async function main() {
|
|
1723
|
-
* const auth = new google.auth.GoogleAuth({
|
|
1724
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1725
|
-
* scopes: [
|
|
1726
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
1727
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
1728
|
-
* ],
|
|
1729
|
-
* });
|
|
1730
|
-
*
|
|
1731
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
1732
|
-
* const authClient = await auth.getClient();
|
|
1733
|
-
* google.options({auth: authClient});
|
|
1734
|
-
*
|
|
1735
|
-
* // Do the magic
|
|
1736
|
-
* const res = await serviceusage.operations.get({
|
|
1737
|
-
* // The name of the operation resource.
|
|
1738
|
-
* name: 'operations/my-operation',
|
|
1739
|
-
* });
|
|
1740
|
-
* console.log(res.data);
|
|
1741
|
-
*
|
|
1742
|
-
* // Example response
|
|
1743
|
-
* // {
|
|
1744
|
-
* // "done": false,
|
|
1745
|
-
* // "error": {},
|
|
1746
|
-
* // "metadata": {},
|
|
1747
|
-
* // "name": "my_name",
|
|
1748
|
-
* // "response": {}
|
|
1749
|
-
* // }
|
|
1750
|
-
* }
|
|
1751
|
-
*
|
|
1752
|
-
* main().catch(e => {
|
|
1753
|
-
* console.error(e);
|
|
1754
|
-
* throw e;
|
|
1755
|
-
* });
|
|
1756
|
-
*
|
|
1757
|
-
* ```
|
|
1758
2021
|
*
|
|
1759
2022
|
* @param params - Parameters for request
|
|
1760
2023
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1768,59 +2031,7 @@ export declare namespace serviceusage_v1 {
|
|
|
1768
2031
|
get(params: Params$Resource$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
1769
2032
|
get(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
1770
2033
|
/**
|
|
1771
|
-
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
1772
|
-
* @example
|
|
1773
|
-
* ```js
|
|
1774
|
-
* // Before running the sample:
|
|
1775
|
-
* // - Enable the API at:
|
|
1776
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
1777
|
-
* // - Login into gcloud by running:
|
|
1778
|
-
* // `$ gcloud auth application-default login`
|
|
1779
|
-
* // - Install the npm module by running:
|
|
1780
|
-
* // `$ npm install googleapis`
|
|
1781
|
-
*
|
|
1782
|
-
* const {google} = require('googleapis');
|
|
1783
|
-
* const serviceusage = google.serviceusage('v1');
|
|
1784
|
-
*
|
|
1785
|
-
* async function main() {
|
|
1786
|
-
* const auth = new google.auth.GoogleAuth({
|
|
1787
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1788
|
-
* scopes: [
|
|
1789
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
1790
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
1791
|
-
* ],
|
|
1792
|
-
* });
|
|
1793
|
-
*
|
|
1794
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
1795
|
-
* const authClient = await auth.getClient();
|
|
1796
|
-
* google.options({auth: authClient});
|
|
1797
|
-
*
|
|
1798
|
-
* // Do the magic
|
|
1799
|
-
* const res = await serviceusage.operations.list({
|
|
1800
|
-
* // The standard list filter.
|
|
1801
|
-
* filter: 'placeholder-value',
|
|
1802
|
-
* // The name of the operation's parent resource.
|
|
1803
|
-
* name: 'placeholder-value',
|
|
1804
|
-
* // The standard list page size.
|
|
1805
|
-
* pageSize: 'placeholder-value',
|
|
1806
|
-
* // The standard list page token.
|
|
1807
|
-
* pageToken: 'placeholder-value',
|
|
1808
|
-
* });
|
|
1809
|
-
* console.log(res.data);
|
|
1810
|
-
*
|
|
1811
|
-
* // Example response
|
|
1812
|
-
* // {
|
|
1813
|
-
* // "nextPageToken": "my_nextPageToken",
|
|
1814
|
-
* // "operations": []
|
|
1815
|
-
* // }
|
|
1816
|
-
* }
|
|
1817
|
-
*
|
|
1818
|
-
* main().catch(e => {
|
|
1819
|
-
* console.error(e);
|
|
1820
|
-
* throw e;
|
|
1821
|
-
* });
|
|
1822
|
-
*
|
|
1823
|
-
* ```
|
|
2034
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
1824
2035
|
*
|
|
1825
2036
|
* @param params - Parameters for request
|
|
1826
2037
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1879,63 +2090,6 @@ export declare namespace serviceusage_v1 {
|
|
|
1879
2090
|
constructor(context: APIRequestContext);
|
|
1880
2091
|
/**
|
|
1881
2092
|
* Enable multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur. To enable a single service, use the `EnableService` method instead.
|
|
1882
|
-
* @example
|
|
1883
|
-
* ```js
|
|
1884
|
-
* // Before running the sample:
|
|
1885
|
-
* // - Enable the API at:
|
|
1886
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
1887
|
-
* // - Login into gcloud by running:
|
|
1888
|
-
* // `$ gcloud auth application-default login`
|
|
1889
|
-
* // - Install the npm module by running:
|
|
1890
|
-
* // `$ npm install googleapis`
|
|
1891
|
-
*
|
|
1892
|
-
* const {google} = require('googleapis');
|
|
1893
|
-
* const serviceusage = google.serviceusage('v1');
|
|
1894
|
-
*
|
|
1895
|
-
* async function main() {
|
|
1896
|
-
* const auth = new google.auth.GoogleAuth({
|
|
1897
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1898
|
-
* scopes: [
|
|
1899
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
1900
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
1901
|
-
* ],
|
|
1902
|
-
* });
|
|
1903
|
-
*
|
|
1904
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
1905
|
-
* const authClient = await auth.getClient();
|
|
1906
|
-
* google.options({auth: authClient});
|
|
1907
|
-
*
|
|
1908
|
-
* // Do the magic
|
|
1909
|
-
* const res = await serviceusage.services.batchEnable({
|
|
1910
|
-
* // Parent to enable services on. An example name would be: `projects/123` where `123` is the project number. The `BatchEnableServices` method currently only supports projects.
|
|
1911
|
-
* parent: '[^/]+/[^/]+',
|
|
1912
|
-
*
|
|
1913
|
-
* // Request body metadata
|
|
1914
|
-
* requestBody: {
|
|
1915
|
-
* // request body parameters
|
|
1916
|
-
* // {
|
|
1917
|
-
* // "serviceIds": []
|
|
1918
|
-
* // }
|
|
1919
|
-
* },
|
|
1920
|
-
* });
|
|
1921
|
-
* console.log(res.data);
|
|
1922
|
-
*
|
|
1923
|
-
* // Example response
|
|
1924
|
-
* // {
|
|
1925
|
-
* // "done": false,
|
|
1926
|
-
* // "error": {},
|
|
1927
|
-
* // "metadata": {},
|
|
1928
|
-
* // "name": "my_name",
|
|
1929
|
-
* // "response": {}
|
|
1930
|
-
* // }
|
|
1931
|
-
* }
|
|
1932
|
-
*
|
|
1933
|
-
* main().catch(e => {
|
|
1934
|
-
* console.error(e);
|
|
1935
|
-
* throw e;
|
|
1936
|
-
* });
|
|
1937
|
-
*
|
|
1938
|
-
* ```
|
|
1939
2093
|
*
|
|
1940
2094
|
* @param params - Parameters for request
|
|
1941
2095
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1950,53 +2104,6 @@ export declare namespace serviceusage_v1 {
|
|
|
1950
2104
|
batchEnable(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
1951
2105
|
/**
|
|
1952
2106
|
* Returns the service configurations and enabled states for a given list of services.
|
|
1953
|
-
* @example
|
|
1954
|
-
* ```js
|
|
1955
|
-
* // Before running the sample:
|
|
1956
|
-
* // - Enable the API at:
|
|
1957
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
1958
|
-
* // - Login into gcloud by running:
|
|
1959
|
-
* // `$ gcloud auth application-default login`
|
|
1960
|
-
* // - Install the npm module by running:
|
|
1961
|
-
* // `$ npm install googleapis`
|
|
1962
|
-
*
|
|
1963
|
-
* const {google} = require('googleapis');
|
|
1964
|
-
* const serviceusage = google.serviceusage('v1');
|
|
1965
|
-
*
|
|
1966
|
-
* async function main() {
|
|
1967
|
-
* const auth = new google.auth.GoogleAuth({
|
|
1968
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1969
|
-
* scopes: [
|
|
1970
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
1971
|
-
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
|
|
1972
|
-
* ],
|
|
1973
|
-
* });
|
|
1974
|
-
*
|
|
1975
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
1976
|
-
* const authClient = await auth.getClient();
|
|
1977
|
-
* google.options({auth: authClient});
|
|
1978
|
-
*
|
|
1979
|
-
* // Do the magic
|
|
1980
|
-
* const res = await serviceusage.services.batchGet({
|
|
1981
|
-
* // Names of the services to retrieve. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number. A single request can get a maximum of 30 services at a time.
|
|
1982
|
-
* names: 'placeholder-value',
|
|
1983
|
-
* // Parent to retrieve services from. If this is set, the parent of all of the services specified in `names` must match this field. An example name would be: `projects/123` where `123` is the project number. The `BatchGetServices` method currently only supports projects.
|
|
1984
|
-
* parent: '[^/]+/[^/]+',
|
|
1985
|
-
* });
|
|
1986
|
-
* console.log(res.data);
|
|
1987
|
-
*
|
|
1988
|
-
* // Example response
|
|
1989
|
-
* // {
|
|
1990
|
-
* // "services": []
|
|
1991
|
-
* // }
|
|
1992
|
-
* }
|
|
1993
|
-
*
|
|
1994
|
-
* main().catch(e => {
|
|
1995
|
-
* console.error(e);
|
|
1996
|
-
* throw e;
|
|
1997
|
-
* });
|
|
1998
|
-
*
|
|
1999
|
-
* ```
|
|
2000
2107
|
*
|
|
2001
2108
|
* @param params - Parameters for request
|
|
2002
2109
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2011,64 +2118,6 @@ export declare namespace serviceusage_v1 {
|
|
|
2011
2118
|
batchGet(callback: BodyResponseCallback<Schema$BatchGetServicesResponse>): void;
|
|
2012
2119
|
/**
|
|
2013
2120
|
* Disable a service so that it can no longer be used with a project. This prevents unintended usage that may cause unexpected billing charges or security leaks. It is not valid to 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.
|
|
2014
|
-
* @example
|
|
2015
|
-
* ```js
|
|
2016
|
-
* // Before running the sample:
|
|
2017
|
-
* // - Enable the API at:
|
|
2018
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
2019
|
-
* // - Login into gcloud by running:
|
|
2020
|
-
* // `$ gcloud auth application-default login`
|
|
2021
|
-
* // - Install the npm module by running:
|
|
2022
|
-
* // `$ npm install googleapis`
|
|
2023
|
-
*
|
|
2024
|
-
* const {google} = require('googleapis');
|
|
2025
|
-
* const serviceusage = google.serviceusage('v1');
|
|
2026
|
-
*
|
|
2027
|
-
* async function main() {
|
|
2028
|
-
* const auth = new google.auth.GoogleAuth({
|
|
2029
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2030
|
-
* scopes: [
|
|
2031
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2032
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
2033
|
-
* ],
|
|
2034
|
-
* });
|
|
2035
|
-
*
|
|
2036
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
2037
|
-
* const authClient = await auth.getClient();
|
|
2038
|
-
* google.options({auth: authClient});
|
|
2039
|
-
*
|
|
2040
|
-
* // Do the magic
|
|
2041
|
-
* const res = await serviceusage.services.disable({
|
|
2042
|
-
* // 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.
|
|
2043
|
-
* name: '[^/]+/[^/]+/services/my-service',
|
|
2044
|
-
*
|
|
2045
|
-
* // Request body metadata
|
|
2046
|
-
* requestBody: {
|
|
2047
|
-
* // request body parameters
|
|
2048
|
-
* // {
|
|
2049
|
-
* // "checkIfServiceHasUsage": "my_checkIfServiceHasUsage",
|
|
2050
|
-
* // "disableDependentServices": false
|
|
2051
|
-
* // }
|
|
2052
|
-
* },
|
|
2053
|
-
* });
|
|
2054
|
-
* console.log(res.data);
|
|
2055
|
-
*
|
|
2056
|
-
* // Example response
|
|
2057
|
-
* // {
|
|
2058
|
-
* // "done": false,
|
|
2059
|
-
* // "error": {},
|
|
2060
|
-
* // "metadata": {},
|
|
2061
|
-
* // "name": "my_name",
|
|
2062
|
-
* // "response": {}
|
|
2063
|
-
* // }
|
|
2064
|
-
* }
|
|
2065
|
-
*
|
|
2066
|
-
* main().catch(e => {
|
|
2067
|
-
* console.error(e);
|
|
2068
|
-
* throw e;
|
|
2069
|
-
* });
|
|
2070
|
-
*
|
|
2071
|
-
* ```
|
|
2072
2121
|
*
|
|
2073
2122
|
* @param params - Parameters for request
|
|
2074
2123
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2083,61 +2132,6 @@ export declare namespace serviceusage_v1 {
|
|
|
2083
2132
|
disable(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2084
2133
|
/**
|
|
2085
2134
|
* Enable a service so that it can be used with a project.
|
|
2086
|
-
* @example
|
|
2087
|
-
* ```js
|
|
2088
|
-
* // Before running the sample:
|
|
2089
|
-
* // - Enable the API at:
|
|
2090
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
2091
|
-
* // - Login into gcloud by running:
|
|
2092
|
-
* // `$ gcloud auth application-default login`
|
|
2093
|
-
* // - Install the npm module by running:
|
|
2094
|
-
* // `$ npm install googleapis`
|
|
2095
|
-
*
|
|
2096
|
-
* const {google} = require('googleapis');
|
|
2097
|
-
* const serviceusage = google.serviceusage('v1');
|
|
2098
|
-
*
|
|
2099
|
-
* async function main() {
|
|
2100
|
-
* const auth = new google.auth.GoogleAuth({
|
|
2101
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2102
|
-
* scopes: [
|
|
2103
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2104
|
-
* 'https://www.googleapis.com/auth/service.management',
|
|
2105
|
-
* ],
|
|
2106
|
-
* });
|
|
2107
|
-
*
|
|
2108
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
2109
|
-
* const authClient = await auth.getClient();
|
|
2110
|
-
* google.options({auth: authClient});
|
|
2111
|
-
*
|
|
2112
|
-
* // Do the magic
|
|
2113
|
-
* const res = await serviceusage.services.enable({
|
|
2114
|
-
* // 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.
|
|
2115
|
-
* name: '[^/]+/[^/]+/services/my-service',
|
|
2116
|
-
*
|
|
2117
|
-
* // Request body metadata
|
|
2118
|
-
* requestBody: {
|
|
2119
|
-
* // request body parameters
|
|
2120
|
-
* // {}
|
|
2121
|
-
* },
|
|
2122
|
-
* });
|
|
2123
|
-
* console.log(res.data);
|
|
2124
|
-
*
|
|
2125
|
-
* // Example response
|
|
2126
|
-
* // {
|
|
2127
|
-
* // "done": false,
|
|
2128
|
-
* // "error": {},
|
|
2129
|
-
* // "metadata": {},
|
|
2130
|
-
* // "name": "my_name",
|
|
2131
|
-
* // "response": {}
|
|
2132
|
-
* // }
|
|
2133
|
-
* }
|
|
2134
|
-
*
|
|
2135
|
-
* main().catch(e => {
|
|
2136
|
-
* console.error(e);
|
|
2137
|
-
* throw e;
|
|
2138
|
-
* });
|
|
2139
|
-
*
|
|
2140
|
-
* ```
|
|
2141
2135
|
*
|
|
2142
2136
|
* @param params - Parameters for request
|
|
2143
2137
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2152,54 +2146,6 @@ export declare namespace serviceusage_v1 {
|
|
|
2152
2146
|
enable(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2153
2147
|
/**
|
|
2154
2148
|
* Returns the service configuration and enabled state for a given service.
|
|
2155
|
-
* @example
|
|
2156
|
-
* ```js
|
|
2157
|
-
* // Before running the sample:
|
|
2158
|
-
* // - Enable the API at:
|
|
2159
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
2160
|
-
* // - Login into gcloud by running:
|
|
2161
|
-
* // `$ gcloud auth application-default login`
|
|
2162
|
-
* // - Install the npm module by running:
|
|
2163
|
-
* // `$ npm install googleapis`
|
|
2164
|
-
*
|
|
2165
|
-
* const {google} = require('googleapis');
|
|
2166
|
-
* const serviceusage = google.serviceusage('v1');
|
|
2167
|
-
*
|
|
2168
|
-
* async function main() {
|
|
2169
|
-
* const auth = new google.auth.GoogleAuth({
|
|
2170
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2171
|
-
* scopes: [
|
|
2172
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2173
|
-
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
|
|
2174
|
-
* ],
|
|
2175
|
-
* });
|
|
2176
|
-
*
|
|
2177
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
2178
|
-
* const authClient = await auth.getClient();
|
|
2179
|
-
* google.options({auth: authClient});
|
|
2180
|
-
*
|
|
2181
|
-
* // Do the magic
|
|
2182
|
-
* const res = await serviceusage.services.get({
|
|
2183
|
-
* // 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.
|
|
2184
|
-
* name: '[^/]+/[^/]+/services/my-service',
|
|
2185
|
-
* });
|
|
2186
|
-
* console.log(res.data);
|
|
2187
|
-
*
|
|
2188
|
-
* // Example response
|
|
2189
|
-
* // {
|
|
2190
|
-
* // "config": {},
|
|
2191
|
-
* // "name": "my_name",
|
|
2192
|
-
* // "parent": "my_parent",
|
|
2193
|
-
* // "state": "my_state"
|
|
2194
|
-
* // }
|
|
2195
|
-
* }
|
|
2196
|
-
*
|
|
2197
|
-
* main().catch(e => {
|
|
2198
|
-
* console.error(e);
|
|
2199
|
-
* throw e;
|
|
2200
|
-
* });
|
|
2201
|
-
*
|
|
2202
|
-
* ```
|
|
2203
2149
|
*
|
|
2204
2150
|
* @param params - Parameters for request
|
|
2205
2151
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2214,58 +2160,6 @@ export declare namespace serviceusage_v1 {
|
|
|
2214
2160
|
get(callback: BodyResponseCallback<Schema$GoogleApiServiceusageV1Service>): void;
|
|
2215
2161
|
/**
|
|
2216
2162
|
* List all services available to the specified project, and the current state of those services with respect to the project. The list includes all public services, all services for 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. WARNING: If you need to query enabled services frequently or across an organization, you should use [Cloud Asset Inventory API](https://cloud.google.com/asset-inventory/docs/apis), which provides higher throughput and richer filtering capability.
|
|
2217
|
-
* @example
|
|
2218
|
-
* ```js
|
|
2219
|
-
* // Before running the sample:
|
|
2220
|
-
* // - Enable the API at:
|
|
2221
|
-
* // https://console.developers.google.com/apis/api/serviceusage.googleapis.com
|
|
2222
|
-
* // - Login into gcloud by running:
|
|
2223
|
-
* // `$ gcloud auth application-default login`
|
|
2224
|
-
* // - Install the npm module by running:
|
|
2225
|
-
* // `$ npm install googleapis`
|
|
2226
|
-
*
|
|
2227
|
-
* const {google} = require('googleapis');
|
|
2228
|
-
* const serviceusage = google.serviceusage('v1');
|
|
2229
|
-
*
|
|
2230
|
-
* async function main() {
|
|
2231
|
-
* const auth = new google.auth.GoogleAuth({
|
|
2232
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2233
|
-
* scopes: [
|
|
2234
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
2235
|
-
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
|
|
2236
|
-
* ],
|
|
2237
|
-
* });
|
|
2238
|
-
*
|
|
2239
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
2240
|
-
* const authClient = await auth.getClient();
|
|
2241
|
-
* google.options({auth: authClient});
|
|
2242
|
-
*
|
|
2243
|
-
* // Do the magic
|
|
2244
|
-
* const res = await serviceusage.services.list({
|
|
2245
|
-
* // Only list services that conform to the given filter. The allowed filter strings are `state:ENABLED` and `state:DISABLED`.
|
|
2246
|
-
* filter: 'placeholder-value',
|
|
2247
|
-
* // Requested size of the next page of data. Requested page size cannot exceed 200. If not set, the default page size is 50.
|
|
2248
|
-
* pageSize: 'placeholder-value',
|
|
2249
|
-
* // Token identifying which result to start with, which is returned by a previous list call.
|
|
2250
|
-
* pageToken: 'placeholder-value',
|
|
2251
|
-
* // Parent to search for services on. An example name would be: `projects/123` where `123` is the project number.
|
|
2252
|
-
* parent: '[^/]+/[^/]+',
|
|
2253
|
-
* });
|
|
2254
|
-
* console.log(res.data);
|
|
2255
|
-
*
|
|
2256
|
-
* // Example response
|
|
2257
|
-
* // {
|
|
2258
|
-
* // "nextPageToken": "my_nextPageToken",
|
|
2259
|
-
* // "services": []
|
|
2260
|
-
* // }
|
|
2261
|
-
* }
|
|
2262
|
-
*
|
|
2263
|
-
* main().catch(e => {
|
|
2264
|
-
* console.error(e);
|
|
2265
|
-
* throw e;
|
|
2266
|
-
* });
|
|
2267
|
-
*
|
|
2268
|
-
* ```
|
|
2269
2163
|
*
|
|
2270
2164
|
* @param params - Parameters for request
|
|
2271
2165
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|