v2.d.ts
41.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace servicecontrol_v2 {
export interface Options extends GlobalOptions {
version: 'v2';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Service Control API
*
* Provides admission control and telemetry reporting for services integrated with Service Infrastructure.
*
* @example
* ```js
* const {google} = require('googleapis');
* const servicecontrol = google.servicecontrol('v2');
* ```
*/
export class Servicecontrol {
context: APIRequestContext;
services: Resource$Services;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* This message defines attributes associated with API operations, such as a network API request. The terminology is based on the conventions used by Google APIs, Istio, and OpenAPI.
*/
export interface Schema$Api {
/**
* The API operation name. For gRPC requests, it is the fully qualified API method name, such as "google.pubsub.v1.Publisher.Publish". For OpenAPI requests, it is the `operationId`, such as "getPet".
*/
operation?: string | null;
/**
* The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".
*/
protocol?: string | null;
/**
* The API service name. It is a logical identifier for a networked API, such as "pubsub.googleapis.com". The naming syntax depends on the API management system being used for handling the request.
*/
service?: string | null;
/**
* The API version associated with the API operation above, such as "v1" or "v1alpha1".
*/
version?: string | null;
}
/**
* This message defines the standard attribute vocabulary for Google APIs. An attribute is a piece of metadata that describes an activity on a network service. For example, the size of an HTTP request, or the status code of an HTTP response. Each attribute has a type and a name, which is logically defined as a proto message field in `AttributeContext`. The field type becomes the attribute type, and the field path becomes the attribute name. For example, the attribute `source.ip` maps to field `AttributeContext.source.ip`. This message definition is guaranteed not to have any wire breaking change. So you can use it directly for passing attributes across different systems. NOTE: Different system may generate different subset of attributes. Please verify the system specification before relying on an attribute generated a system.
*/
export interface Schema$AttributeContext {
/**
* Represents an API operation that is involved to a network activity.
*/
api?: Schema$Api;
/**
* The destination of a network activity, such as accepting a TCP connection. In a multi hop network activity, the destination represents the receiver of the last hop.
*/
destination?: Schema$Peer;
/**
* Supports extensions for advanced use cases, such as logs and metrics.
*/
extensions?: Array<{
[key: string]: any;
}> | null;
/**
* The origin of a network activity. In a multi hop network activity, the origin represents the sender of the first hop. For the first hop, the `source` and the `origin` must have the same content.
*/
origin?: Schema$Peer;
/**
* Represents a network request, such as an HTTP request.
*/
request?: Schema$Request;
/**
* Represents a target resource that is involved with a network activity. If multiple resources are involved with an activity, this must be the primary one.
*/
resource?: Schema$Resource;
/**
* Represents a network response, such as an HTTP response.
*/
response?: Schema$Response;
/**
* The source of a network activity, such as starting a TCP connection. In a multi hop network activity, the source represents the sender of the last hop.
*/
source?: Schema$Peer;
}
/**
* Common audit log format for Google Cloud Platform API operations.
*/
export interface Schema$AuditLog {
/**
* Authentication information.
*/
authenticationInfo?: Schema$AuthenticationInfo;
/**
* Authorization information. If there are multiple resources or permissions involved, then there is one AuthorizationInfo element for each {resource, permission\} tuple.
*/
authorizationInfo?: Schema$AuthorizationInfo[];
/**
* Other service-specific data about the request, response, and other information associated with the current audited event.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* The name of the service method or operation. For API calls, this should be the name of the API method. For example, "google.cloud.bigquery.v2.TableService.InsertTable" "google.logging.v2.ConfigServiceV2.CreateSink"
*/
methodName?: string | null;
/**
* The number of items returned from a List or Query API method, if applicable.
*/
numResponseItems?: string | null;
/**
* The operation request. This may not include all request parameters, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property.
*/
request?: {
[key: string]: any;
} | null;
/**
* Metadata about the operation.
*/
requestMetadata?: Schema$RequestMetadata;
/**
* The resource location information.
*/
resourceLocation?: Schema$ResourceLocation;
/**
* The resource or collection that is the target of the operation. The name is a scheme-less URI, not including the API service name. For example: "projects/PROJECT_ID/zones/us-central1-a/instances" "projects/PROJECT_ID/datasets/DATASET_ID"
*/
resourceName?: string | null;
/**
* The resource's original state before mutation. Present only for operations which have successfully modified the targeted resource(s). In general, this field should contain all changed fields, except those that are already been included in `request`, `response`, `metadata` or `service_data` fields. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property.
*/
resourceOriginalState?: {
[key: string]: any;
} | null;
/**
* The operation response. This may not include all response elements, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property.
*/
response?: {
[key: string]: any;
} | null;
/**
* Deprecated. Use the `metadata` field instead. Other service-specific data about the request, response, and other activities.
*/
serviceData?: {
[key: string]: any;
} | null;
/**
* The name of the API service performing the operation. For example, `"compute.googleapis.com"`.
*/
serviceName?: string | null;
/**
* The status of the overall operation.
*/
status?: Schema$Status;
}
/**
* This message defines request authentication attributes. Terminology is based on the JSON Web Token (JWT) standard, but the terms also correlate to concepts in other standards.
*/
export interface Schema$Auth {
/**
* A list of access level resource names that allow resources to be accessed by authenticated requester. It is part of Secure GCP processing for the incoming request. An access level string has the format: "//{api_service_name\}/accessPolicies/{policy_id\}/accessLevels/{short_name\}" Example: "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL"
*/
accessLevels?: string[] | null;
/**
* The intended audience(s) for this authentication information. Reflects the audience (`aud`) claim within a JWT. The audience value(s) depends on the `issuer`, but typically include one or more of the following pieces of information: * The services intended to receive the credential. For example, ["https://pubsub.googleapis.com/", "https://storage.googleapis.com/"]. * A set of service-based scopes. For example, ["https://www.googleapis.com/auth/cloud-platform"]. * The client id of an app, such as the Firebase project id for JWTs from Firebase Auth. Consult the documentation for the credential issuer to determine the information provided.
*/
audiences?: string[] | null;
/**
* Structured claims presented with the credential. JWTs include `{key: value\}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926\} SAML assertions are similarly specified, but with an identity provider dependent structure.
*/
claims?: {
[key: string]: any;
} | null;
/**
* The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: "123456789012.apps.googleusercontent.com".
*/
presenter?: string | null;
/**
* The authenticated principal. Reflects the issuer (`iss`) and subject (`sub`) claims within a JWT. The issuer and subject should be `/` delimited, with `/` percent-encoded within the subject fragment. For Google accounts, the principal format is: "https://accounts.google.com/{id\}"
*/
principal?: string | null;
}
/**
* Authentication information for the operation.
*/
export interface Schema$AuthenticationInfo {
/**
* The authority selector specified by the requestor, if any. It is not guaranteed that the principal was allowed to use this authority.
*/
authoritySelector?: string | null;
/**
* The email address of the authenticated user (or service account on behalf of third party principal) making the request. For third party identity callers, the `principal_subject` field is populated instead of this field. For privacy reasons, the principal email address is sometimes redacted. For more information, see [Caller identities in audit logs](https://cloud.google.com/logging/docs/audit#user-id).
*/
principalEmail?: string | null;
/**
* String representation of identity of requesting party. Populated for both first and third party identities.
*/
principalSubject?: string | null;
/**
* Identity delegation history of an authenticated service account that makes the request. It contains information on the real authorities that try to access GCP resources by delegating on a service account. When multiple authorities present, they are guaranteed to be sorted based on the original ordering of the identity delegation events.
*/
serviceAccountDelegationInfo?: Schema$ServiceAccountDelegationInfo[];
/**
* The name of the service account key used to create or exchange credentials for authenticating the service account making the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID\}/serviceAccounts/{ACCOUNT\}/keys/{key\}"
*/
serviceAccountKeyName?: string | null;
/**
* The third party identification (if any) of the authenticated user making the request. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property.
*/
thirdPartyPrincipal?: {
[key: string]: any;
} | null;
}
/**
* Authorization information for the operation.
*/
export interface Schema$AuthorizationInfo {
/**
* Whether or not authorization for `resource` and `permission` was granted.
*/
granted?: boolean | null;
/**
* The required IAM permission.
*/
permission?: string | null;
/**
* The resource being accessed, as a REST-style or cloud resource string. For example: bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID or projects/PROJECTID/datasets/DATASETID
*/
resource?: string | null;
/**
* Resource attributes used in IAM condition evaluation. This field contains resource attributes like resource type and resource name. To get the whole view of the attributes used in IAM condition evaluation, the user must also look into `AuditLog.request_metadata.request_attributes`.
*/
resourceAttributes?: Schema$Resource;
}
/**
* Request message for the Check method.
*/
export interface Schema$CheckRequest {
/**
* Describes attributes about the operation being executed by the service.
*/
attributes?: Schema$AttributeContext;
/**
* Optional. Contains a comma-separated list of flags.
*/
flags?: string | null;
/**
* Describes the resources and the policies applied to each resource.
*/
resources?: Schema$ResourceInfo[];
/**
* Specifies the version of the service configuration that should be used to process the request. Must not be empty. Set this field to 'latest' to specify using the latest configuration.
*/
serviceConfigId?: string | null;
}
/**
* Response message for the Check method.
*/
export interface Schema$CheckResponse {
/**
* Returns a set of request contexts generated from the `CheckRequest`.
*/
headers?: {
[key: string]: string;
} | null;
/**
* Operation is allowed when this field is not set. Any non-'OK' status indicates a denial; [google.rpc.Status.details]() would contain additional details about the denial.
*/
status?: Schema$Status;
}
/**
* First party identity principal.
*/
export interface Schema$FirstPartyPrincipal {
/**
* The email address of a Google account. .
*/
principalEmail?: string | null;
/**
* Metadata about the service that uses the service account. .
*/
serviceMetadata?: {
[key: string]: any;
} | null;
}
/**
* This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in `principal` and `labels` as appropriate.
*/
export interface Schema$Peer {
/**
* The IP address of the peer.
*/
ip?: string | null;
/**
* The labels associated with the peer.
*/
labels?: {
[key: string]: string;
} | null;
/**
* The network port of the peer.
*/
port?: string | null;
/**
* The identity of this peer. Similar to `Request.auth.principal`, but relative to the peer instead of the request. For example, the idenity associated with a load balancer that forwared the request.
*/
principal?: string | null;
/**
* The CLDR country/region code associated with the above IP address. If the IP address is private, the `region_code` should reflect the physical location where this peer is running.
*/
regionCode?: string | null;
}
/**
* Request message for the Report method.
*/
export interface Schema$ReportRequest {
/**
* Describes the list of operations to be reported. Each operation is represented as an AttributeContext, and contains all attributes around an API access.
*/
operations?: Schema$AttributeContext[];
/**
* Specifies the version of the service configuration that should be used to process the request. Must not be empty. Set this field to 'latest' to specify using the latest configuration.
*/
serviceConfigId?: string | null;
}
/**
* Response message for the Report method. If the request contains any invalid data, the server returns an RPC error.
*/
export interface Schema$ReportResponse {
}
/**
* This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request.
*/
export interface Schema$Request {
/**
* The request authentication. May be absent for unauthenticated requests. Derived from the HTTP request `Authorization` header or equivalent.
*/
auth?: Schema$Auth;
/**
* The HTTP request headers. If multiple headers share the same key, they must be merged according to the HTTP spec. All header keys must be lowercased, because HTTP header keys are case-insensitive.
*/
headers?: {
[key: string]: string;
} | null;
/**
* The HTTP request `Host` header value.
*/
host?: string | null;
/**
* The unique ID for a request, which can be propagated to downstream systems. The ID should have low probability of collision within a single day for a specific service.
*/
id?: string | null;
/**
* The HTTP request method, such as `GET`, `POST`.
*/
method?: string | null;
/**
* The HTTP URL path, excluding the query parameters.
*/
path?: string | null;
/**
* The network protocol used with the request, such as "http/1.1", "spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic". See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for details.
*/
protocol?: string | null;
/**
* The HTTP URL query in the format of `name1=value1&name2=value2`, as it appears in the first line of the HTTP request. No decoding is performed.
*/
query?: string | null;
/**
* A special parameter for request reason. It is used by security systems to associate auditing information with a request.
*/
reason?: string | null;
/**
* The HTTP URL scheme, such as `http` and `https`.
*/
scheme?: string | null;
/**
* The HTTP request size in bytes. If unknown, it must be -1.
*/
size?: string | null;
/**
* The timestamp when the `destination` service receives the last byte of the request.
*/
time?: string | null;
}
/**
* Metadata about the request.
*/
export interface Schema$RequestMetadata {
/**
* The IP address of the caller. For caller from internet, this will be public IPv4 or IPv6 address. For caller from a Compute Engine VM with external IP address, this will be the VM's external IP address. For caller from a Compute Engine VM without external IP address, if the VM is in the same organization (or project) as the accessed resource, `caller_ip` will be the VM's internal IPv4 address, otherwise the `caller_ip` will be redacted to "gce-internal-ip". See https://cloud.google.com/compute/docs/vpc/ for more information.
*/
callerIp?: string | null;
/**
* The network of the caller. Set only if the network host project is part of the same GCP organization (or project) as the accessed resource. See https://cloud.google.com/compute/docs/vpc/ for more information. This is a scheme-less URI full resource name. For example: "//compute.googleapis.com/projects/PROJECT_ID/global/networks/NETWORK_ID"
*/
callerNetwork?: string | null;
/**
* The user agent of the caller. This information is not authenticated and should be treated accordingly. For example: + `google-api-python-client/1.4.0`: The request was made by the Google API client for Python. + `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`: The request was made by the Google Cloud SDK CLI (gcloud). + `AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`: The request was made from the `my-project` App Engine app. NOLINT
*/
callerSuppliedUserAgent?: string | null;
/**
* The destination of a network activity, such as accepting a TCP connection. In a multi hop network activity, the destination represents the receiver of the last hop. Only two fields are used in this message, Peer.port and Peer.ip. These fields are optionally populated by those services utilizing the IAM condition feature.
*/
destinationAttributes?: Schema$Peer;
/**
* Request attributes used in IAM condition evaluation. This field contains request attributes like request time and access levels associated with the request. To get the whole view of the attributes used in IAM condition evaluation, the user must also look into `AuditLog.authentication_info.resource_attributes`.
*/
requestAttributes?: Schema$Request;
}
/**
* This message defines core attributes for a resource. A resource is an addressable (named) entity provided by the destination service. For example, a file stored on a network storage service.
*/
export interface Schema$Resource {
/**
* Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
*/
annotations?: {
[key: string]: string;
} | null;
/**
* Output only. The timestamp when the resource was created. This may be either the time creation was initiated or when it was completed.
*/
createTime?: string | null;
/**
* Output only. The timestamp when the resource was deleted. If the resource is not deleted, this must be empty.
*/
deleteTime?: string | null;
/**
* Mutable. The display name set by clients. Must be <= 63 characters.
*/
displayName?: string | null;
/**
* Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
*/
etag?: string | null;
/**
* The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Immutable. The location of the resource. The location encoding is specific to the service provider, and new encoding may be introduced as the service evolves. For Google Cloud products, the encoding is what is used by Google Cloud APIs, such as `us-east1`, `aws-us-east-1`, and `azure-eastus2`. The semantics of `location` is identical to the `cloud.googleapis.com/location` label used by some Google Cloud APIs.
*/
location?: string | null;
/**
* The stable identifier (name) of a resource on the `service`. A resource can be logically identified as "//{resource.service\}/{resource.name\}". The differences between a resource name and a URI are: * Resource name is a logical identifier, independent of network protocol and API version. For example, `//pubsub.googleapis.com/projects/123/topics/news-feed`. * URI often includes protocol and version information, so it can be used directly by applications. For example, `https://pubsub.googleapis.com/v1/projects/123/topics/news-feed`. See https://cloud.google.com/apis/design/resource_names for details.
*/
name?: string | null;
/**
* The name of the service that this resource belongs to, such as `pubsub.googleapis.com`. The service may be different from the DNS hostname that actually serves the request.
*/
service?: string | null;
/**
* The type of the resource. The syntax is platform-specific because different platforms define their resources differently. For Google APIs, the type format must be "{service\}/{kind\}".
*/
type?: string | null;
/**
* The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
*/
uid?: string | null;
/**
* Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
*/
updateTime?: string | null;
}
/**
* Describes a resource referenced in the request.
*/
export interface Schema$ResourceInfo {
/**
* The name of the resource referenced in the request.
*/
name?: string | null;
/**
* The resource permission needed for this request. The format must be "{service\}/{plural\}.{verb\}".
*/
permission?: string | null;
/**
* The resource type in the format of "{service\}/{kind\}".
*/
type?: string | null;
}
/**
* Location information about a resource.
*/
export interface Schema$ResourceLocation {
/**
* The locations of a resource after the execution of the operation. Requests to create or delete a location based resource must populate the 'current_locations' field and not the 'original_locations' field. For example: "europe-west1-a" "us-east1" "nam3"
*/
currentLocations?: string[] | null;
/**
* The locations of a resource prior to the execution of the operation. Requests that mutate the resource's location must populate both the 'original_locations' as well as the 'current_locations' fields. For example: "europe-west1-a" "us-east1" "nam3"
*/
originalLocations?: string[] | null;
}
/**
* This message defines attributes for a typical network response. It generally models semantics of an HTTP response.
*/
export interface Schema$Response {
/**
* The amount of time it takes the backend service to fully respond to a request. Measured from when the destination service starts to send the request to the backend until when the destination service receives the complete response from the backend.
*/
backendLatency?: string | null;
/**
* The HTTP response status code, such as `200` and `404`.
*/
code?: string | null;
/**
* The HTTP response headers. If multiple headers share the same key, they must be merged according to HTTP spec. All header keys must be lowercased, because HTTP header keys are case-insensitive.
*/
headers?: {
[key: string]: string;
} | null;
/**
* The HTTP response size in bytes. If unknown, it must be -1.
*/
size?: string | null;
/**
* The timestamp when the `destination` service sends the last byte of the response.
*/
time?: string | null;
}
/**
* Identity delegation history of an authenticated service account.
*/
export interface Schema$ServiceAccountDelegationInfo {
/**
* First party (Google) identity as the real authority.
*/
firstPartyPrincipal?: Schema$FirstPartyPrincipal;
/**
* A string representing the principal_subject associated with the identity. See go/3pical for more info on how principal_subject is formatted.
*/
principalSubject?: string | null;
/**
* Third party identity as the real authority.
*/
thirdPartyPrincipal?: Schema$ThirdPartyPrincipal;
}
/**
* The context of a span. This is attached to an Exemplar in Distribution values during aggregation. It contains the name of a span with format: projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID]
*/
export interface Schema$SpanContext {
/**
* The resource name of the span. The format is: projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID] `[TRACE_ID]` is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. `[SPAN_ID]` is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array.
*/
spanName?: string | null;
}
/**
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string | null;
}
/**
* Third party identity principal.
*/
export interface Schema$ThirdPartyPrincipal {
/**
* Metadata about third party identity.
*/
thirdPartyClaims?: {
[key: string]: any;
} | null;
}
export class Resource$Services {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Private Preview. This feature is only available for approved services. This method provides admission control for services that are integrated with [Service Infrastructure](/service-infrastructure). It checks whether an operation should be allowed based on the service configuration and relevant policies. It must be called before the operation is executed. For more information, see [Admission Control](/service-infrastructure/docs/admission-control). NOTE: The admission control has an expected policy propagation delay of 60s. The caller **must** not depend on the most recent policy changes. NOTE: The admission control has a hard limit of 1 referenced resources per call. If an operation refers to more than 1 resources, the caller must call the Check method multiple times. This method requires the `servicemanagement.services.check` permission on the specified service. For more information, see [Service Control API Access Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/servicecontrol.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const servicecontrol = google.servicecontrol('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/servicecontrol',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await servicecontrol.services.check({
* // The service name as specified in its service configuration. For example, `"pubsub.googleapis.com"`. See [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service) for the definition of a service name.
* serviceName: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "attributes": {},
* // "flags": "my_flags",
* // "resources": [],
* // "serviceConfigId": "my_serviceConfigId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "headers": {},
* // "status": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
check(params: Params$Resource$Services$Check, options: StreamMethodOptions): GaxiosPromise<Readable>;
check(params?: Params$Resource$Services$Check, options?: MethodOptions): GaxiosPromise<Schema$CheckResponse>;
check(params: Params$Resource$Services$Check, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
check(params: Params$Resource$Services$Check, options: MethodOptions | BodyResponseCallback<Schema$CheckResponse>, callback: BodyResponseCallback<Schema$CheckResponse>): void;
check(params: Params$Resource$Services$Check, callback: BodyResponseCallback<Schema$CheckResponse>): void;
check(callback: BodyResponseCallback<Schema$CheckResponse>): void;
/**
* Private Preview. This feature is only available for approved services. This method provides telemetry reporting for services that are integrated with [Service Infrastructure](/service-infrastructure). It reports a list of operations that have occurred on a service. It must be called after the operations have been executed. For more information, see [Telemetry Reporting](/service-infrastructure/docs/telemetry-reporting). NOTE: The telemetry reporting has a hard limit of 1000 operations and 1MB per Report call. It is recommended to have no more than 100 operations per call. This method requires the `servicemanagement.services.report` permission on the specified service. For more information, see [Service Control API Access Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/servicecontrol.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const servicecontrol = google.servicecontrol('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/servicecontrol',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await servicecontrol.services.report({
* // The service name as specified in its service configuration. For example, `"pubsub.googleapis.com"`. See [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service) for the definition of a service name.
* serviceName: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "operations": [],
* // "serviceConfigId": "my_serviceConfigId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
report(params: Params$Resource$Services$Report, options: StreamMethodOptions): GaxiosPromise<Readable>;
report(params?: Params$Resource$Services$Report, options?: MethodOptions): GaxiosPromise<Schema$ReportResponse>;
report(params: Params$Resource$Services$Report, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
report(params: Params$Resource$Services$Report, options: MethodOptions | BodyResponseCallback<Schema$ReportResponse>, callback: BodyResponseCallback<Schema$ReportResponse>): void;
report(params: Params$Resource$Services$Report, callback: BodyResponseCallback<Schema$ReportResponse>): void;
report(callback: BodyResponseCallback<Schema$ReportResponse>): void;
}
export interface Params$Resource$Services$Check extends StandardParameters {
/**
* The service name as specified in its service configuration. For example, `"pubsub.googleapis.com"`. See [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service) for the definition of a service name.
*/
serviceName?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CheckRequest;
}
export interface Params$Resource$Services$Report extends StandardParameters {
/**
* The service name as specified in its service configuration. For example, `"pubsub.googleapis.com"`. See [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service) for the definition of a service name.
*/
serviceName?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ReportRequest;
}
export {};
}