v1.d.ts
61.6 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
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace accesscontextmanager_v1 {
interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* 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;
}
/**
* Access Context Manager API
*
* An API for setting attribute based access control to requests to GCP
* services.
*
* @example
* const {google} = require('googleapis');
* const accesscontextmanager = google.accesscontextmanager('v1');
*
* @namespace accesscontextmanager
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Accesscontextmanager
*/
class Accesscontextmanager {
context: APIRequestContext;
accessPolicies: Resource$Accesspolicies;
operations: Resource$Operations;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* An `AccessLevel` is a label that can be applied to requests to GCP
* services, along with a list of requirements necessary for the label to be
* applied.
*/
interface Schema$AccessLevel {
/**
* A `BasicLevel` composed of `Conditions`.
*/
basic?: Schema$BasicLevel;
/**
* Output only. Time the `AccessLevel` was created in UTC.
*/
createTime?: string;
/**
* Description of the `AccessLevel` and its use. Does not affect behavior.
*/
description?: string;
/**
* Required. Resource name for the Access Level. The `short_name` component
* must begin with a letter and only include alphanumeric and '_'.
* Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`
*/
name?: string;
/**
* Human readable title. Must be unique within the Policy.
*/
title?: string;
/**
* Output only. Time the `AccessLevel` was updated in UTC.
*/
updateTime?: string;
}
/**
* `AccessPolicy` is a container for `AccessLevels` (which define the
* necessary attributes to use GCP services) and `ServicePerimeters` (which
* define regions of services able to freely pass data within a perimeter). An
* access policy is globally visible within an organization, and the
* restrictions it specifies apply to all projects within an organization.
*/
interface Schema$AccessPolicy {
/**
* Output only. Time the `AccessPolicy` was created in UTC.
*/
createTime?: string;
/**
* Output only. Resource name of the `AccessPolicy`. Format:
* `accessPolicies/{policy_id}`
*/
name?: string;
/**
* Required. The parent of this `AccessPolicy` in the Cloud Resource
* Hierarchy. Currently immutable once created. Format:
* `organizations/{organization_id}`
*/
parent?: string;
/**
* Required. Human readable title. Does not affect behavior.
*/
title?: string;
/**
* Output only. Time the `AccessPolicy` was updated in UTC.
*/
updateTime?: string;
}
/**
* `BasicLevel` is an `AccessLevel` using a set of recommended features.
*/
interface Schema$BasicLevel {
/**
* How the `conditions` list should be combined to determine if a request is
* granted this `AccessLevel`. If AND is used, each `Condition` in
* `conditions` must be satisfied for the `AccessLevel` to be applied. If OR
* is used, at least one `Condition` in `conditions` must be satisfied for
* the `AccessLevel` to be applied. Default behavior is AND.
*/
combiningFunction?: string;
/**
* Required. A list of requirements for the `AccessLevel` to be granted.
*/
conditions?: Schema$Condition[];
}
/**
* The request message for Operations.CancelOperation.
*/
interface Schema$CancelOperationRequest {
}
/**
* A condition necessary for an `AccessLevel` to be granted. The Condition is
* an AND over its fields. So a Condition is true if: 1) the request IP is
* from one of the listed subnetworks AND 2) the originating device complies
* with the listed device policy AND 3) all listed access levels are granted
* AND 4) the request was sent at a time allowed by the DateTimeRestriction.
*/
interface Schema$Condition {
/**
* Device specific restrictions, all restrictions must hold for the
* Condition to be true. If not specified, all devices are allowed.
*/
devicePolicy?: Schema$DevicePolicy;
/**
* CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that
* for a CIDR IP address block, the specified IP address portion must be
* properly truncated (i.e. all the host bits must be zero) or the input is
* considered malformed. For example, "192.0.2.0/24" is accepted
* but "192.0.2.1/24" is not. Similarly, for IPv6,
* "2001:db8::/32" is accepted whereas "2001:db8::1/32"
* is not. The originating IP of a request must be in one of the listed
* subnets in order for this Condition to be true. If empty, all IP
* addresses are allowed.
*/
ipSubnetworks?: string[];
/**
* The request must be made by one of the provided user or service accounts.
* Groups are not supported. Syntax: `user:{emailid}`
* `serviceAccount:{emailid}` If not specified, a request may come from any
* user.
*/
members?: string[];
/**
* Whether to negate the Condition. If true, the Condition becomes a NAND
* over its non-empty fields, each field must be false for the Condition
* overall to be satisfied. Defaults to false.
*/
negate?: boolean;
/**
* The request must originate from one of the provided countries/regions.
* Must be valid ISO 3166-1 alpha-2 codes.
*/
regions?: string[];
/**
* A list of other access levels defined in the same `Policy`, referenced by
* resource name. Referencing an `AccessLevel` which does not exist is an
* error. All access levels listed must be granted for the Condition to be
* true. Example:
* "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"`
*/
requiredAccessLevels?: string[];
}
/**
* `DevicePolicy` specifies device specific restrictions necessary to acquire
* a given access level. A `DevicePolicy` specifies requirements for requests
* from devices to be granted access levels, it does not do any enforcement on
* the device. `DevicePolicy` acts as an AND over all specified fields, and
* each repeated field is an OR over its elements. Any unset fields are
* ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type
* : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will
* be true for requests originating from encrypted Linux desktops and
* encrypted Windows desktops.
*/
interface Schema$DevicePolicy {
/**
* Allowed device management levels, an empty list allows all management
* levels.
*/
allowedDeviceManagementLevels?: string[];
/**
* Allowed encryptions statuses, an empty list allows all statuses.
*/
allowedEncryptionStatuses?: string[];
/**
* Allowed OS versions, an empty list allows all types and all versions.
*/
osConstraints?: Schema$OsConstraint[];
/**
* Whether the device needs to be approved by the customer admin.
*/
requireAdminApproval?: boolean;
/**
* Whether the device needs to be corp owned.
*/
requireCorpOwned?: boolean;
/**
* Whether or not screenlock is required for the DevicePolicy to be true.
* Defaults to `false`.
*/
requireScreenlock?: boolean;
}
/**
* 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); } The JSON
* representation for `Empty` is empty JSON object `{}`.
*/
interface Schema$Empty {
}
/**
* A response to `ListAccessLevelsRequest`.
*/
interface Schema$ListAccessLevelsResponse {
/**
* List of the Access Level instances.
*/
accessLevels?: Schema$AccessLevel[];
/**
* The pagination token to retrieve the next page of results. If the value
* is empty, no further results remain.
*/
nextPageToken?: string;
}
/**
* A response to `ListAccessPoliciesRequest`.
*/
interface Schema$ListAccessPoliciesResponse {
/**
* List of the AccessPolicy instances.
*/
accessPolicies?: Schema$AccessPolicy[];
/**
* The pagination token to retrieve the next page of results. If the value
* is empty, no further results remain.
*/
nextPageToken?: string;
}
/**
* The response message for Operations.ListOperations.
*/
interface Schema$ListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$Operation[];
}
/**
* A response to `ListServicePerimetersRequest`.
*/
interface Schema$ListServicePerimetersResponse {
/**
* The pagination token to retrieve the next page of results. If the value
* is empty, no further results remain.
*/
nextPageToken?: string;
/**
* List of the Service Perimeter instances.
*/
servicePerimeters?: Schema$ServicePerimeter[];
}
/**
* This resource represents a long-running operation that is the result of a
* network API call.
*/
interface Schema$Operation {
/**
* If the value is `false`, it means the operation is still in progress. If
* `true`, the operation is completed, and either `error` or `response` is
* available.
*/
done?: boolean;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time.
* Some services might not provide such metadata. Any method that returns a
* long-running operation should document the metadata type, if any.
*/
metadata?: {
[key: string]: any;
};
/**
* The server-assigned name, which is only unique within the same service
* that originally returns it. If you use the default HTTP mapping, the
* `name` should have the format of `operations/some/unique/name`.
*/
name?: string;
/**
* The normal response of the operation in case of success. If the original
* method returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the 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`.
*/
response?: {
[key: string]: any;
};
}
/**
* A restriction on the OS type and version of devices making requests.
*/
interface Schema$OsConstraint {
/**
* The minimum allowed OS version. If not set, any version of this OS
* satisfies the constraint. Format: `"major.minor.patch"`.
* Examples: `"10.5.301"`, `"9.2.1"`.
*/
minimumVersion?: string;
/**
* Required. The allowed OS type.
*/
osType?: string;
/**
* Only allows requests from devices with a verified Chrome OS.
* Verifications includes requirements that the device is
* enterprise-managed, conformant to Dasher domain policies, and the caller
* has permission to call the API targeted by the request.
*/
requireVerifiedChromeOs?: boolean;
}
/**
* `ServicePerimeter` describes a set of GCP resources which can freely import
* and export data amongst themselves, but not export outside of the
* `ServicePerimeter`. If a request with a source within this
* `ServicePerimeter` has a target outside of the `ServicePerimeter`, the
* request will be blocked. Otherwise the request is allowed. There are two
* types of Service Perimeter - Regular and Bridge. Regular Service Perimeters
* cannot overlap, a single GCP project can only belong to a single regular
* Service Perimeter. Service Perimeter Bridges can contain only GCP projects
* as members, a single GCP project may belong to multiple Service Perimeter
* Bridges.
*/
interface Schema$ServicePerimeter {
/**
* Output only. Time the `ServicePerimeter` was created in UTC.
*/
createTime?: string;
/**
* Description of the `ServicePerimeter` and its use. Does not affect
* behavior.
*/
description?: string;
/**
* Required. Resource name for the ServicePerimeter. The `short_name`
* component must begin with a letter and only include alphanumeric and
* '_'. Format:
* `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
*/
name?: string;
/**
* Perimeter type indicator. A single project is allowed to be a member of
* single regular perimeter, but multiple service perimeter bridges. A
* project cannot be a included in a perimeter bridge without being included
* in regular perimeter. For perimeter bridges, the restricted service list
* as well as access level lists must be empty.
*/
perimeterType?: string;
/**
* Current ServicePerimeter configuration. Specifies sets of resources,
* restricted services and access levels that determine perimeter content
* and boundaries.
*/
status?: Schema$ServicePerimeterConfig;
/**
* Human readable title. Must be unique within the Policy.
*/
title?: string;
/**
* Output only. Time the `ServicePerimeter` was updated in UTC.
*/
updateTime?: string;
}
/**
* `ServicePerimeterConfig` specifies a set of GCP resources that describe
* specific Service Perimeter configuration.
*/
interface Schema$ServicePerimeterConfig {
/**
* A list of `AccessLevel` resource names that allow resources within the
* `ServicePerimeter` to be accessed from the internet. `AccessLevels`
* listed must be in the same policy as this `ServicePerimeter`. Referencing
* a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names
* are listed, resources within the perimeter can only be accessed via GCP
* calls with request origins within the perimeter. Example:
* `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service
* Perimeter Bridge, must be empty.
*/
accessLevels?: string[];
/**
* A list of GCP resources that are inside of the service perimeter.
* Currently only projects are allowed. Format: `projects/{project_number}`
*/
resources?: string[];
/**
* GCP services that are subject to the Service Perimeter restrictions. For
* example, if `storage.googleapis.com` is specified, access to the storage
* buckets inside the perimeter must meet the perimeter's access
* restrictions.
*/
restrictedServices?: string[];
}
/**
* 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). The error model is designed to be:
* - Simple to use and understand for most users - Flexible enough to meet
* unexpected needs # Overview The `Status` message contains three pieces of
* data: error code, error message, and error details. The error code should
* be an enum value of google.rpc.Code, but it may accept additional error
* codes if needed. The error message should be a developer-facing English
* message that helps developers *understand* and *resolve* the error. If a
* localized user-facing error message is needed, put the localized message in
* the error details or localize it in the client. The optional error details
* may contain arbitrary information about the error. There is a predefined
* set of error detail types in the package `google.rpc` that can be used for
* common error conditions. # Language mapping The `Status` message is the
* logical representation of the error model, but it is not necessarily the
* actual wire format. When the `Status` message is exposed in different
* client libraries and different wire protocols, it can be mapped
* differently. For example, it will likely be mapped to some exceptions in
* Java, but more likely mapped to some error codes in C. # Other uses The
* error model and the `Status` message can be used in a variety of
* environments, either with or without APIs, to provide a consistent
* developer experience across different environments. Example uses of this
* error model include: - Partial errors. If a service needs to return
* partial errors to the client, it may embed the `Status` in the normal
* response to indicate the partial errors. - Workflow errors. A typical
* workflow has multiple steps. Each step may have a `Status` message for
* error reporting. - Batch operations. If a client uses batch request and
* batch response, the `Status` message should be used directly inside
* batch response, one for each error sub-response. - Asynchronous
* operations. If an API call embeds asynchronous operation results in its
* response, the status of those operations should be represented directly
* using the `Status` message. - Logging. If some API errors are stored in
* logs, the message `Status` could be used directly after any stripping
* needed for security/privacy reasons.
*/
interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number;
/**
* 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;
}>;
/**
* 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;
}
class Resource$Accesspolicies {
context: APIRequestContext;
accessLevels: Resource$Accesspolicies$Accesslevels;
servicePerimeters: Resource$Accesspolicies$Serviceperimeters;
constructor(context: APIRequestContext);
/**
* accesscontextmanager.accessPolicies.create
* @desc Create an `AccessPolicy`. Fails if this organization already has a
* `AccessPolicy`. The longrunning Operation will have a successful status
* once the `AccessPolicy` has propagated to long-lasting storage. Syntactic
* and basic semantic errors will be returned in `metadata` as a BadRequest
* proto.
* @alias accesscontextmanager.accessPolicies.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().AccessPolicy} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Accesspolicies$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Accesspolicies$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Accesspolicies$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* accesscontextmanager.accessPolicies.delete
* @desc Delete an AccessPolicy by resource name. The longrunning Operation
* will have a successful status once the AccessPolicy has been removed from
* long-lasting storage.
* @alias accesscontextmanager.accessPolicies.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. Resource name for the access policy to delete. Format `accessPolicies/{policy_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Accesspolicies$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Accesspolicies$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Accesspolicies$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* accesscontextmanager.accessPolicies.get
* @desc Get an AccessPolicy by name.
* @alias accesscontextmanager.accessPolicies.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. Resource name for the access policy to get. Format `accessPolicies/{policy_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Accesspolicies$Get, options?: MethodOptions): GaxiosPromise<Schema$AccessPolicy>;
get(params: Params$Resource$Accesspolicies$Get, options: MethodOptions | BodyResponseCallback<Schema$AccessPolicy>, callback: BodyResponseCallback<Schema$AccessPolicy>): void;
get(params: Params$Resource$Accesspolicies$Get, callback: BodyResponseCallback<Schema$AccessPolicy>): void;
get(callback: BodyResponseCallback<Schema$AccessPolicy>): void;
/**
* accesscontextmanager.accessPolicies.list
* @desc List all AccessPolicies under a container.
* @alias accesscontextmanager.accessPolicies.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Number of AccessPolicy instances to include in the list. Default 100.
* @param {string=} params.pageToken Next page token for the next batch of AccessPolicy instances. Defaults to the first page of results.
* @param {string=} params.parent Required. Resource name for the container to list AccessPolicy instances from. Format: `organizations/{org_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Accesspolicies$List, options?: MethodOptions): GaxiosPromise<Schema$ListAccessPoliciesResponse>;
list(params: Params$Resource$Accesspolicies$List, options: MethodOptions | BodyResponseCallback<Schema$ListAccessPoliciesResponse>, callback: BodyResponseCallback<Schema$ListAccessPoliciesResponse>): void;
list(params: Params$Resource$Accesspolicies$List, callback: BodyResponseCallback<Schema$ListAccessPoliciesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListAccessPoliciesResponse>): void;
/**
* accesscontextmanager.accessPolicies.patch
* @desc Update an AccessPolicy. The longrunning Operation from this RPC
* will have a successful status once the changes to the AccessPolicy have
* propagated to long-lasting storage. Syntactic and basic semantic errors
* will be returned in `metadata` as a BadRequest proto.
* @alias accesscontextmanager.accessPolicies.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}`
* @param {string=} params.updateMask Required. Mask to control which fields get updated. Must be non-empty.
* @param {().AccessPolicy} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Accesspolicies$Patch, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(params: Params$Resource$Accesspolicies$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
patch(params: Params$Resource$Accesspolicies$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
}
interface Params$Resource$Accesspolicies$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$AccessPolicy;
}
interface Params$Resource$Accesspolicies$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Resource name for the access policy to delete. Format
* `accessPolicies/{policy_id}`
*/
name?: string;
}
interface Params$Resource$Accesspolicies$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Resource name for the access policy to get. Format
* `accessPolicies/{policy_id}`
*/
name?: string;
}
interface Params$Resource$Accesspolicies$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Number of AccessPolicy instances to include in the list. Default 100.
*/
pageSize?: number;
/**
* Next page token for the next batch of AccessPolicy instances. Defaults to
* the first page of results.
*/
pageToken?: string;
/**
* Required. Resource name for the container to list AccessPolicy instances
* from. Format: `organizations/{org_id}`
*/
parent?: string;
}
interface Params$Resource$Accesspolicies$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Output only. Resource name of the `AccessPolicy`. Format:
* `accessPolicies/{policy_id}`
*/
name?: string;
/**
* Required. Mask to control which fields get updated. Must be non-empty.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AccessPolicy;
}
class Resource$Accesspolicies$Accesslevels {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* accesscontextmanager.accessPolicies.accessLevels.create
* @desc Create an Access Level. The longrunning operation from this RPC
* will have a successful status once the Access Level has propagated to
* long-lasting storage. Access Levels containing errors will result in an
* error response for the first error encountered.
* @alias accesscontextmanager.accessPolicies.accessLevels.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. Resource name for the access policy which owns this Access Level. Format: `accessPolicies/{policy_id}`
* @param {().AccessLevel} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Accesspolicies$Accesslevels$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Accesspolicies$Accesslevels$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Accesspolicies$Accesslevels$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* accesscontextmanager.accessPolicies.accessLevels.delete
* @desc Delete an Access Level by resource name. The longrunning operation
* from this RPC will have a successful status once the Access Level has
* been removed from long-lasting storage.
* @alias accesscontextmanager.accessPolicies.accessLevels.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. Resource name for the Access Level. Format: `accessPolicies/{policy_id}/accessLevels/{access_level_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Accesspolicies$Accesslevels$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Accesspolicies$Accesslevels$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Accesspolicies$Accesslevels$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* accesscontextmanager.accessPolicies.accessLevels.get
* @desc Get an Access Level by resource name.
* @alias accesscontextmanager.accessPolicies.accessLevels.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.accessLevelFormat Whether to return `BasicLevels` in the Cloud Common Expression Language rather than as `BasicLevels`. Defaults to AS_DEFINED, where Access Levels are returned as `BasicLevels` or `CustomLevels` based on how they were created. If set to CEL, all Access Levels are returned as `CustomLevels`. In the CEL case, `BasicLevels` are translated to equivalent `CustomLevels`.
* @param {string} params.name Required. Resource name for the Access Level. Format: `accessPolicies/{policy_id}/accessLevels/{access_level_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Accesspolicies$Accesslevels$Get, options?: MethodOptions): GaxiosPromise<Schema$AccessLevel>;
get(params: Params$Resource$Accesspolicies$Accesslevels$Get, options: MethodOptions | BodyResponseCallback<Schema$AccessLevel>, callback: BodyResponseCallback<Schema$AccessLevel>): void;
get(params: Params$Resource$Accesspolicies$Accesslevels$Get, callback: BodyResponseCallback<Schema$AccessLevel>): void;
get(callback: BodyResponseCallback<Schema$AccessLevel>): void;
/**
* accesscontextmanager.accessPolicies.accessLevels.list
* @desc List all Access Levels for an access policy.
* @alias accesscontextmanager.accessPolicies.accessLevels.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.accessLevelFormat Whether to return `BasicLevels` in the Cloud Common Expression language, as `CustomLevels`, rather than as `BasicLevels`. Defaults to returning `AccessLevels` in the format they were defined.
* @param {integer=} params.pageSize Number of Access Levels to include in the list. Default 100.
* @param {string=} params.pageToken Next page token for the next batch of Access Level instances. Defaults to the first page of results.
* @param {string} params.parent Required. Resource name for the access policy to list Access Levels from. Format: `accessPolicies/{policy_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Accesspolicies$Accesslevels$List, options?: MethodOptions): GaxiosPromise<Schema$ListAccessLevelsResponse>;
list(params: Params$Resource$Accesspolicies$Accesslevels$List, options: MethodOptions | BodyResponseCallback<Schema$ListAccessLevelsResponse>, callback: BodyResponseCallback<Schema$ListAccessLevelsResponse>): void;
list(params: Params$Resource$Accesspolicies$Accesslevels$List, callback: BodyResponseCallback<Schema$ListAccessLevelsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListAccessLevelsResponse>): void;
/**
* accesscontextmanager.accessPolicies.accessLevels.patch
* @desc Update an Access Level. The longrunning operation from this RPC
* will have a successful status once the changes to the Access Level have
* propagated to long-lasting storage. Access Levels containing errors will
* result in an error response for the first error encountered.
* @alias accesscontextmanager.accessPolicies.accessLevels.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`
* @param {string=} params.updateMask Required. Mask to control which fields get updated. Must be non-empty.
* @param {().AccessLevel} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Accesspolicies$Accesslevels$Patch, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(params: Params$Resource$Accesspolicies$Accesslevels$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
patch(params: Params$Resource$Accesspolicies$Accesslevels$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
}
interface Params$Resource$Accesspolicies$Accesslevels$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Resource name for the access policy which owns this Access
* Level. Format: `accessPolicies/{policy_id}`
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AccessLevel;
}
interface Params$Resource$Accesspolicies$Accesslevels$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Resource name for the Access Level. Format:
* `accessPolicies/{policy_id}/accessLevels/{access_level_id}`
*/
name?: string;
}
interface Params$Resource$Accesspolicies$Accesslevels$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Whether to return `BasicLevels` in the Cloud Common Expression Language
* rather than as `BasicLevels`. Defaults to AS_DEFINED, where Access Levels
* are returned as `BasicLevels` or `CustomLevels` based on how they were
* created. If set to CEL, all Access Levels are returned as `CustomLevels`.
* In the CEL case, `BasicLevels` are translated to equivalent
* `CustomLevels`.
*/
accessLevelFormat?: string;
/**
* Required. Resource name for the Access Level. Format:
* `accessPolicies/{policy_id}/accessLevels/{access_level_id}`
*/
name?: string;
}
interface Params$Resource$Accesspolicies$Accesslevels$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Whether to return `BasicLevels` in the Cloud Common Expression language,
* as `CustomLevels`, rather than as `BasicLevels`. Defaults to returning
* `AccessLevels` in the format they were defined.
*/
accessLevelFormat?: string;
/**
* Number of Access Levels to include in the list. Default 100.
*/
pageSize?: number;
/**
* Next page token for the next batch of Access Level instances. Defaults to
* the first page of results.
*/
pageToken?: string;
/**
* Required. Resource name for the access policy to list Access Levels from.
* Format: `accessPolicies/{policy_id}`
*/
parent?: string;
}
interface Params$Resource$Accesspolicies$Accesslevels$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Resource name for the Access Level. The `short_name` component
* must begin with a letter and only include alphanumeric and '_'. Format:
* `accessPolicies/{policy_id}/accessLevels/{short_name}`
*/
name?: string;
/**
* Required. Mask to control which fields get updated. Must be non-empty.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AccessLevel;
}
class Resource$Accesspolicies$Serviceperimeters {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* accesscontextmanager.accessPolicies.servicePerimeters.create
* @desc Create an Service Perimeter. The longrunning operation from this
* RPC will have a successful status once the Service Perimeter has
* propagated to long-lasting storage. Service Perimeters containing errors
* will result in an error response for the first error encountered.
* @alias accesscontextmanager.accessPolicies.servicePerimeters.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. Resource name for the access policy which owns this Service Perimeter. Format: `accessPolicies/{policy_id}`
* @param {().ServicePerimeter} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Accesspolicies$Serviceperimeters$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Accesspolicies$Serviceperimeters$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Accesspolicies$Serviceperimeters$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* accesscontextmanager.accessPolicies.servicePerimeters.delete
* @desc Delete an Service Perimeter by resource name. The longrunning
* operation from this RPC will have a successful status once the Service
* Perimeter has been removed from long-lasting storage.
* @alias accesscontextmanager.accessPolicies.servicePerimeters.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. Resource name for the Service Perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Accesspolicies$Serviceperimeters$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Accesspolicies$Serviceperimeters$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Accesspolicies$Serviceperimeters$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* accesscontextmanager.accessPolicies.servicePerimeters.get
* @desc Get an Service Perimeter by resource name.
* @alias accesscontextmanager.accessPolicies.servicePerimeters.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. Resource name for the Service Perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Accesspolicies$Serviceperimeters$Get, options?: MethodOptions): GaxiosPromise<Schema$ServicePerimeter>;
get(params: Params$Resource$Accesspolicies$Serviceperimeters$Get, options: MethodOptions | BodyResponseCallback<Schema$ServicePerimeter>, callback: BodyResponseCallback<Schema$ServicePerimeter>): void;
get(params: Params$Resource$Accesspolicies$Serviceperimeters$Get, callback: BodyResponseCallback<Schema$ServicePerimeter>): void;
get(callback: BodyResponseCallback<Schema$ServicePerimeter>): void;
/**
* accesscontextmanager.accessPolicies.servicePerimeters.list
* @desc List all Service Perimeters for an access policy.
* @alias accesscontextmanager.accessPolicies.servicePerimeters.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize Number of Service Perimeters to include in the list. Default 100.
* @param {string=} params.pageToken Next page token for the next batch of Service Perimeter instances. Defaults to the first page of results.
* @param {string} params.parent Required. Resource name for the access policy to list Service Perimeters from. Format: `accessPolicies/{policy_id}`
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Accesspolicies$Serviceperimeters$List, options?: MethodOptions): GaxiosPromise<Schema$ListServicePerimetersResponse>;
list(params: Params$Resource$Accesspolicies$Serviceperimeters$List, options: MethodOptions | BodyResponseCallback<Schema$ListServicePerimetersResponse>, callback: BodyResponseCallback<Schema$ListServicePerimetersResponse>): void;
list(params: Params$Resource$Accesspolicies$Serviceperimeters$List, callback: BodyResponseCallback<Schema$ListServicePerimetersResponse>): void;
list(callback: BodyResponseCallback<Schema$ListServicePerimetersResponse>): void;
/**
* accesscontextmanager.accessPolicies.servicePerimeters.patch
* @desc Update an Service Perimeter. The longrunning operation from this
* RPC will have a successful status once the changes to the Service
* Perimeter have propagated to long-lasting storage. Service Perimeter
* containing errors will result in an error response for the first error
* encountered.
* @alias accesscontextmanager.accessPolicies.servicePerimeters.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
* @param {string=} params.updateMask Required. Mask to control which fields get updated. Must be non-empty.
* @param {().ServicePerimeter} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Accesspolicies$Serviceperimeters$Patch, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(params: Params$Resource$Accesspolicies$Serviceperimeters$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
patch(params: Params$Resource$Accesspolicies$Serviceperimeters$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
}
interface Params$Resource$Accesspolicies$Serviceperimeters$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Resource name for the access policy which owns this Service
* Perimeter. Format: `accessPolicies/{policy_id}`
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ServicePerimeter;
}
interface Params$Resource$Accesspolicies$Serviceperimeters$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Resource name for the Service Perimeter. Format:
* `accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}`
*/
name?: string;
}
interface Params$Resource$Accesspolicies$Serviceperimeters$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Resource name for the Service Perimeter. Format:
* `accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}`
*/
name?: string;
}
interface Params$Resource$Accesspolicies$Serviceperimeters$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Number of Service Perimeters to include in the list. Default 100.
*/
pageSize?: number;
/**
* Next page token for the next batch of Service Perimeter instances.
* Defaults to the first page of results.
*/
pageToken?: string;
/**
* Required. Resource name for the access policy to list Service Perimeters
* from. Format: `accessPolicies/{policy_id}`
*/
parent?: string;
}
interface Params$Resource$Accesspolicies$Serviceperimeters$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Resource name for the ServicePerimeter. The `short_name`
* component must begin with a letter and only include alphanumeric and '_'.
* Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
*/
name?: string;
/**
* Required. Mask to control which fields get updated. Must be non-empty.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ServicePerimeter;
}
class Resource$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* accesscontextmanager.operations.cancel
* @desc 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`.
* @alias accesscontextmanager.operations.cancel
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource to be cancelled.
* @param {().CancelOperationRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
cancel(params?: Params$Resource$Operations$Cancel, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
cancel(params: Params$Resource$Operations$Cancel, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
cancel(params: Params$Resource$Operations$Cancel, callback: BodyResponseCallback<Schema$Empty>): void;
cancel(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* accesscontextmanager.operations.delete
* @desc 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`.
* @alias accesscontextmanager.operations.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource to be deleted.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Operations$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Operations$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Operations$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* accesscontextmanager.operations.get
* @desc 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.
* @alias accesscontextmanager.operations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
get(params: Params$Resource$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
get(params: Params$Resource$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* accesscontextmanager.operations.list
* @desc Lists operations that match the specified filter in the request. If
* the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE:
* the `name` binding allows API services to override the binding to use
* different resource name schemes, such as `users/x/operations`. To
* override the binding, API services can add a binding such as
* `"/v1/{name=users/x}/operations"` to their service configuration. For
* backwards compatibility, the default name includes the operations
* collection id, however overriding users must ensure the name binding is
* the parent resource, without the operations collection id.
* @alias accesscontextmanager.operations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter The standard list filter.
* @param {string} params.name The name of the operation's parent resource.
* @param {integer=} params.pageSize The standard list page size.
* @param {string=} params.pageToken The standard list page token.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Operations$List, options?: MethodOptions): GaxiosPromise<Schema$ListOperationsResponse>;
list(params: Params$Resource$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$ListOperationsResponse>, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
list(params: Params$Resource$Operations$List, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
}
interface Params$Resource$Operations$Cancel extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource to be cancelled.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CancelOperationRequest;
}
interface Params$Resource$Operations$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource to be deleted.
*/
name?: string;
}
interface Params$Resource$Operations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource.
*/
name?: string;
}
interface Params$Resource$Operations$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The standard list filter.
*/
filter?: string;
/**
* The name of the operation's parent resource.
*/
name?: string;
/**
* The standard list page size.
*/
pageSize?: number;
/**
* The standard list page token.
*/
pageToken?: string;
}
}