v2.d.ts
50.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
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
/**
* 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 cloudresourcemanager_v2 {
interface Options extends GlobalOptions {
version: 'v2';
}
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;
}
/**
* Cloud Resource Manager API
*
* Creates, reads, and updates metadata for Google Cloud Platform resource
* containers.
*
* @example
* const {google} = require('googleapis');
* const cloudresourcemanager = google.cloudresourcemanager('v2');
*
* @namespace cloudresourcemanager
* @type {Function}
* @version v2
* @variation v2
* @param {object=} options Options for Cloudresourcemanager
*/
class Cloudresourcemanager {
context: APIRequestContext;
folders: Resource$Folders;
operations: Resource$Operations;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Specifies the audit configuration for a service. The configuration
* determines which permission types are logged, and what identities, if any,
* are exempted from logging. An AuditConfig must have one or more
* AuditLogConfigs. If there are AuditConfigs for both `allServices` and a
* specific service, the union of the two AuditConfigs is used for that
* service: the log_types specified in each AuditConfig are enabled, and the
* exempted_members in each AuditLogConfig are exempted. Example Policy with
* multiple AuditConfigs: { "audit_configs": [ {
* "service": "allServices" "audit_log_configs":
* [ { "log_type": "DATA_READ",
* "exempted_members": [ "user:foo@gmail.com" ] }, {
* "log_type": "DATA_WRITE", }, {
* "log_type": "ADMIN_READ", } ] },
* { "service": "fooservice.googleapis.com"
* "audit_log_configs": [ { "log_type":
* "DATA_READ", }, { "log_type":
* "DATA_WRITE", "exempted_members": [
* "user:bar@gmail.com" ] } ] }
* ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and
* ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging,
* and bar@gmail.com from DATA_WRITE logging.
*/
interface Schema$AuditConfig {
/**
* The configuration for logging of each type of permission.
*/
auditLogConfigs?: Schema$AuditLogConfig[];
/**
* Specifies a service that will be enabled for audit logging. For example,
* `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a
* special value that covers all services.
*/
service?: string;
}
/**
* Provides the configuration for logging a type of permissions. Example: {
* "audit_log_configs": [ { "log_type":
* "DATA_READ", "exempted_members": [
* "user:foo@gmail.com" ] }, {
* "log_type": "DATA_WRITE", } ] } This
* enables 'DATA_READ' and 'DATA_WRITE' logging, while
* exempting foo@gmail.com from DATA_READ logging.
*/
interface Schema$AuditLogConfig {
/**
* Specifies the identities that do not cause logging for this type of
* permission. Follows the same format of Binding.members.
*/
exemptedMembers?: string[];
/**
* The log type that this config enables.
*/
logType?: string;
}
/**
* Associates `members` with a `role`.
*/
interface Schema$Binding {
/**
* The condition that is associated with this binding. NOTE: an unsatisfied
* condition will not allow user access via current binding. Different
* bindings, including their conditions, are examined independently.
*/
condition?: Schema$Expr;
/**
* Specifies the identities requesting access for a Cloud Platform resource.
* `members` can have the following values: * `allUsers`: A special
* identifier that represents anyone who is on the internet; with or
* without a Google account. * `allAuthenticatedUsers`: A special
* identifier that represents anyone who is authenticated with a Google
* account or a service account. * `user:{emailid}`: An email address that
* represents a specific Google account. For example, `alice@gmail.com` .
* * `serviceAccount:{emailid}`: An email address that represents a service
* account. For example, `my-other-app@appspot.gserviceaccount.com`. *
* `group:{emailid}`: An email address that represents a Google group. For
* example, `admins@example.com`. * `domain:{domain}`: The G Suite domain
* (primary) that represents all the users of that domain. For example,
* `google.com` or `example.com`.
*/
members?: string[];
/**
* Role that is assigned to `members`. For example, `roles/viewer`,
* `roles/editor`, or `roles/owner`.
*/
role?: string;
}
/**
* Represents an expression text. Example: title: "User account
* presence" description: "Determines whether the request has a
* user account" expression: "size(request.user) > 0"
*/
interface Schema$Expr {
/**
* An optional description of the expression. This is a longer text which
* describes the expression, e.g. when hovered over it in a UI.
*/
description?: string;
/**
* Textual representation of an expression in Common Expression Language
* syntax. The application context of the containing message determines
* which well-known feature set of CEL is supported.
*/
expression?: string;
/**
* An optional string indicating the location of the expression for error
* reporting, e.g. a file name and a position in the file.
*/
location?: string;
/**
* An optional title for the expression, i.e. a short string describing its
* purpose. This can be used e.g. in UIs which allow to enter the
* expression.
*/
title?: string;
}
/**
* A Folder in an Organization's resource hierarchy, used to organize that
* Organization's resources.
*/
interface Schema$Folder {
/**
* Output only. Timestamp when the Folder was created. Assigned by the
* server.
*/
createTime?: string;
/**
* The folder’s display name. A folder’s display name must be unique amongst
* its siblings, e.g. no two folders with the same parent can share the same
* display name. The display name must start and end with a letter or digit,
* may contain letters, digits, spaces, hyphens and underscores and can be
* no longer than 30 characters. This is captured by the regular expression:
* [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
*/
displayName?: string;
/**
* Output only. The lifecycle state of the folder. Updates to the
* lifecycle_state must be performed via DeleteFolder and UndeleteFolder.
*/
lifecycleState?: string;
/**
* Output only. The resource name of the Folder. Its format is
* `folders/{folder_id}`, for example: "folders/1234".
*/
name?: string;
/**
* The Folder’s parent's resource name. Updates to the folder's
* parent must be performed via MoveFolder.
*/
parent?: string;
}
/**
* Metadata describing a long running folder operation
*/
interface Schema$FolderOperation {
/**
* The resource name of the folder or organization we are either creating
* the folder under or moving the folder to.
*/
destinationParent?: string;
/**
* The display name of the folder.
*/
displayName?: string;
/**
* The type of this operation.
*/
operationType?: string;
/**
* The resource name of the folder's parent. Only applicable when the
* operation_type is MOVE.
*/
sourceParent?: string;
}
/**
* A classification of the Folder Operation error.
*/
interface Schema$FolderOperationError {
/**
* The type of operation error experienced.
*/
errorMessageId?: string;
}
/**
* Request message for `GetIamPolicy` method.
*/
interface Schema$GetIamPolicyRequest {
}
/**
* The ListFolders response message.
*/
interface Schema$ListFoldersResponse {
/**
* A possibly paginated list of Folders that are direct descendants of the
* specified parent resource.
*/
folders?: Schema$Folder[];
/**
* A pagination token returned from a previous call to `ListFolders` that
* indicates from where listing should continue. This field is optional.
*/
nextPageToken?: string;
}
/**
* The MoveFolder request message.
*/
interface Schema$MoveFolderRequest {
/**
* The resource name of the Folder or Organization to reparent the folder
* under. Must be of the form `folders/{folder_id}` or
* `organizations/{org_id}`.
*/
destinationParent?: string;
}
/**
* 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;
};
}
/**
* Defines an Identity and Access Management (IAM) policy. It is used to
* specify access control policies for Cloud Platform resources. A `Policy`
* consists of a list of `bindings`. A `binding` binds a list of `members` to
* a `role`, where the members can be user accounts, Google groups, Google
* domains, and service accounts. A `role` is a named list of permissions
* defined by IAM. **JSON Example** { "bindings": [ {
* "role": "roles/owner", "members": [
* "user:mike@example.com", "group:admins@example.com",
* "domain:google.com",
* "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, {
* "role": "roles/viewer", "members":
* ["user:sean@example.com"] } ] } **YAML
* Example** bindings: - members: - user:mike@example.com -
* group:admins@example.com - domain:google.com -
* serviceAccount:my-other-app@appspot.gserviceaccount.com role:
* roles/owner - members: - user:sean@example.com role:
* roles/viewer For a description of IAM and its features, see the [IAM
* developer's guide](https://cloud.google.com/iam/docs).
*/
interface Schema$Policy {
/**
* Specifies cloud audit logging configuration for this policy.
*/
auditConfigs?: Schema$AuditConfig[];
/**
* Associates a list of `members` to a `role`. `bindings` with no members
* will result in an error.
*/
bindings?: Schema$Binding[];
/**
* `etag` is used for optimistic concurrency control as a way to help
* prevent simultaneous updates of a policy from overwriting each other. It
* is strongly suggested that systems make use of the `etag` in the
* read-modify-write cycle to perform policy updates in order to avoid race
* conditions: An `etag` is returned in the response to `getIamPolicy`, and
* systems are expected to put that etag in the request to `setIamPolicy` to
* ensure that their change will be applied to the same version of the
* policy. If no `etag` is provided in the call to `setIamPolicy`, then the
* existing policy is overwritten blindly.
*/
etag?: string;
/**
* Deprecated.
*/
version?: number;
}
/**
* A status object which is used as the `metadata` field for the Operation
* returned by CreateProject. It provides insight for when significant phases
* of Project creation have completed.
*/
interface Schema$ProjectCreationStatus {
/**
* Creation time of the project creation workflow.
*/
createTime?: string;
/**
* True if the project can be retrieved using GetProject. No other
* operations on the project are guaranteed to work until the project
* creation is complete.
*/
gettable?: boolean;
/**
* True if the project creation process is complete.
*/
ready?: boolean;
}
/**
* The request message for searching folders.
*/
interface Schema$SearchFoldersRequest {
/**
* The maximum number of folders to return in the response. This field is
* optional.
*/
pageSize?: number;
/**
* A pagination token returned from a previous call to `SearchFolders` that
* indicates from where search should continue. This field is optional.
*/
pageToken?: string;
/**
* Search criteria used to select the Folders to return. If no search
* criteria is specified then all accessible folders will be returned. Query
* expressions can be used to restrict results based upon displayName,
* lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`
* can be used along with the suffix wildcard symbol `*`. The displayName
* field in a query expression should use escaped quotes for values that
* include whitespace to prevent unexpected behavior. Some example queries
* are: |Query | Description| |----- | -----------| |displayName=Test* |
* Folders whose display name starts with "Test".|
* |lifecycleState=ACTIVE | Folders whose lifecycleState is ACTIVE.|
* |parent=folders/123 | Folders whose parent is "folders/123".|
* |parent=folders/123 AND lifecycleState=ACTIVE | Active folders whose
* parent is "folders/123".| |displayName=\\"Test
* String\\"|Folders whose display name includes both "Test"
* and "String".|
*/
query?: string;
}
/**
* The response message for searching folders.
*/
interface Schema$SearchFoldersResponse {
/**
* A possibly paginated folder search results. the specified parent
* resource.
*/
folders?: Schema$Folder[];
/**
* A pagination token returned from a previous call to `SearchFolders` that
* indicates from where searching should continue. This field is optional.
*/
nextPageToken?: string;
}
/**
* Request message for `SetIamPolicy` method.
*/
interface Schema$SetIamPolicyRequest {
/**
* REQUIRED: The complete policy to be applied to the `resource`. The size
* of the policy is limited to a few 10s of KB. An empty policy is a valid
* policy but certain Cloud Platform services (such as Projects) might
* reject them.
*/
policy?: Schema$Policy;
/**
* OPTIONAL: A FieldMask specifying which fields of the policy to modify.
* Only the fields in the mask will be modified. If no mask is provided, the
* following default mask is used: paths: "bindings, etag" This
* field is only used by Cloud IAM.
*/
updateMask?: 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;
}
/**
* Request message for `TestIamPermissions` method.
*/
interface Schema$TestIamPermissionsRequest {
/**
* The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed.
* For more information see [IAM
* Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
permissions?: string[];
}
/**
* Response message for `TestIamPermissions` method.
*/
interface Schema$TestIamPermissionsResponse {
/**
* A subset of `TestPermissionsRequest.permissions` that the caller is
* allowed.
*/
permissions?: string[];
}
/**
* The UndeleteFolder request message.
*/
interface Schema$UndeleteFolderRequest {
}
class Resource$Folders {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudresourcemanager.folders.create
* @desc Creates a Folder in the resource hierarchy. Returns an Operation
* which can be used to track the progress of the folder creation workflow.
* Upon success the Operation.response field will be populated with the
* created Folder. In order to succeed, the addition of this new Folder
* must not violate the Folder naming, height or fanout constraints. + The
* Folder's display_name must be distinct from all other Folder's that share
* its parent. + The addition of the Folder must not cause the active Folder
* hierarchy to exceed a height of 4. Note, the full active + deleted Folder
* hierarchy is allowed to reach a height of 8; this provides additional
* headroom when moving folders that contain deleted folders. + The addition
* of the Folder must not cause the total number of Folders under its parent
* to exceed 100. If the operation fails due to a folder constraint
* violation, some errors may be returned by the CreateFolder request, with
* status code FAILED_PRECONDITION and an error description. Other folder
* constraint violations will be communicated in the Operation, with the
* specific PreconditionFailure returned via the details list in the
* Operation.error field. The caller must have
* `resourcemanager.folders.create` permission on the identified parent.
* @alias cloudresourcemanager.folders.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.parent The resource name of the new Folder's parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
* @param {().Folder} 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$Folders$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Folders$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Folders$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* cloudresourcemanager.folders.delete
* @desc Requests deletion of a Folder. The Folder is moved into the
* DELETE_REQUESTED state immediately, and is deleted approximately 30 days
* later. This method may only be called on an empty Folder in the ACTIVE
* state, where a Folder is empty if it doesn't contain any Folders or
* Projects in the ACTIVE state. The caller must have
* `resourcemanager.folders.delete` permission on the identified folder.
* @alias cloudresourcemanager.folders.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name the resource name of the Folder to be deleted. Must be of the form `folders/{folder_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$Folders$Delete, options?: MethodOptions): GaxiosPromise<Schema$Folder>;
delete(params: Params$Resource$Folders$Delete, options: MethodOptions | BodyResponseCallback<Schema$Folder>, callback: BodyResponseCallback<Schema$Folder>): void;
delete(params: Params$Resource$Folders$Delete, callback: BodyResponseCallback<Schema$Folder>): void;
delete(callback: BodyResponseCallback<Schema$Folder>): void;
/**
* cloudresourcemanager.folders.get
* @desc Retrieves a Folder identified by the supplied resource name. Valid
* Folder resource names have the format `folders/{folder_id}` (for example,
* `folders/1234`). The caller must have `resourcemanager.folders.get`
* permission on the identified folder.
* @alias cloudresourcemanager.folders.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The resource name of the Folder to retrieve. Must be of the form `folders/{folder_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$Folders$Get, options?: MethodOptions): GaxiosPromise<Schema$Folder>;
get(params: Params$Resource$Folders$Get, options: MethodOptions | BodyResponseCallback<Schema$Folder>, callback: BodyResponseCallback<Schema$Folder>): void;
get(params: Params$Resource$Folders$Get, callback: BodyResponseCallback<Schema$Folder>): void;
get(callback: BodyResponseCallback<Schema$Folder>): void;
/**
* cloudresourcemanager.folders.getIamPolicy
* @desc Gets the access control policy for a Folder. The returned policy
* may be empty if no such policy or resource exists. The `resource` field
* should be the Folder's resource name, e.g. "folders/1234". The caller
* must have `resourcemanager.folders.getIamPolicy` permission on the
* identified folder.
* @alias cloudresourcemanager.folders.getIamPolicy
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
* @param {().GetIamPolicyRequest} 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
*/
getIamPolicy(params?: Params$Resource$Folders$Getiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
getIamPolicy(params: Params$Resource$Folders$Getiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(params: Params$Resource$Folders$Getiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* cloudresourcemanager.folders.list
* @desc Lists the Folders that are direct descendants of supplied parent
* resource. List provides a strongly consistent view of the Folders
* underneath the specified parent resource. List returns Folders sorted
* based upon the (ascending) lexical ordering of their display_name. The
* caller must have `resourcemanager.folders.list` permission on the
* identified parent.
* @alias cloudresourcemanager.folders.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of Folders to return in the response. This field is optional.
* @param {string=} params.pageToken A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from. This field is optional.
* @param {string=} params.parent The resource name of the Organization or Folder whose Folders are being listed. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`.
* @param {boolean=} params.showDeleted Controls whether Folders in the DELETE_REQUESTED state should be returned. Defaults to false. This field is optional.
* @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$Folders$List, options?: MethodOptions): GaxiosPromise<Schema$ListFoldersResponse>;
list(params: Params$Resource$Folders$List, options: MethodOptions | BodyResponseCallback<Schema$ListFoldersResponse>, callback: BodyResponseCallback<Schema$ListFoldersResponse>): void;
list(params: Params$Resource$Folders$List, callback: BodyResponseCallback<Schema$ListFoldersResponse>): void;
list(callback: BodyResponseCallback<Schema$ListFoldersResponse>): void;
/**
* cloudresourcemanager.folders.move
* @desc Moves a Folder under a new resource parent. Returns an Operation
* which can be used to track the progress of the folder move workflow. Upon
* success the Operation.response field will be populated with the moved
* Folder. Upon failure, a FolderOperationError categorizing the failure
* cause will be returned - if the failure occurs synchronously then the
* FolderOperationError will be returned via the Status.details field and if
* it occurs asynchronously then the FolderOperation will be returned via
* the Operation.error field. In addition, the Operation.metadata field will
* be populated with a FolderOperation message as an aid to stateless
* clients. Folder moves will be rejected if they violate either the naming,
* height or fanout constraints described in the CreateFolder documentation.
* The caller must have `resourcemanager.folders.move` permission on the
* folder's current and proposed new parent.
* @alias cloudresourcemanager.folders.move
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The resource name of the Folder to move. Must be of the form folders/{folder_id}
* @param {().MoveFolderRequest} 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
*/
move(params?: Params$Resource$Folders$Move, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
move(params: Params$Resource$Folders$Move, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
move(params: Params$Resource$Folders$Move, callback: BodyResponseCallback<Schema$Operation>): void;
move(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* cloudresourcemanager.folders.patch
* @desc Updates a Folder, changing its display_name. Changes to the folder
* display_name will be rejected if they violate either the display_name
* formatting rules or naming constraints described in the CreateFolder
* documentation. The Folder's display name must start and end with a
* letter or digit, may contain letters, digits, spaces, hyphens and
* underscores and can be no longer than 30 characters. This is captured by
* the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
* The caller must have `resourcemanager.folders.update` permission on the
* identified folder. If the update fails due to the unique name constraint
* then a PreconditionFailure explaining this violation will be returned in
* the Status.details field.
* @alias cloudresourcemanager.folders.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: "folders/1234".
* @param {string=} params.updateMask Fields to be updated. Only the `display_name` can be updated.
* @param {().Folder} 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$Folders$Patch, options?: MethodOptions): GaxiosPromise<Schema$Folder>;
patch(params: Params$Resource$Folders$Patch, options: MethodOptions | BodyResponseCallback<Schema$Folder>, callback: BodyResponseCallback<Schema$Folder>): void;
patch(params: Params$Resource$Folders$Patch, callback: BodyResponseCallback<Schema$Folder>): void;
patch(callback: BodyResponseCallback<Schema$Folder>): void;
/**
* cloudresourcemanager.folders.search
* @desc Search for folders that match specific filter criteria. Search
* provides an eventually consistent view of the folders a user has access
* to which meet the specified filter criteria. This will only return
* folders on which the caller has the permission
* `resourcemanager.folders.get`.
* @alias cloudresourcemanager.folders.search
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().SearchFoldersRequest} 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
*/
search(params?: Params$Resource$Folders$Search, options?: MethodOptions): GaxiosPromise<Schema$SearchFoldersResponse>;
search(params: Params$Resource$Folders$Search, options: MethodOptions | BodyResponseCallback<Schema$SearchFoldersResponse>, callback: BodyResponseCallback<Schema$SearchFoldersResponse>): void;
search(params: Params$Resource$Folders$Search, callback: BodyResponseCallback<Schema$SearchFoldersResponse>): void;
search(callback: BodyResponseCallback<Schema$SearchFoldersResponse>): void;
/**
* cloudresourcemanager.folders.setIamPolicy
* @desc Sets the access control policy on a Folder, replacing any existing
* policy. The `resource` field should be the Folder's resource name, e.g.
* "folders/1234". The caller must have
* `resourcemanager.folders.setIamPolicy` permission on the identified
* folder.
* @alias cloudresourcemanager.folders.setIamPolicy
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
* @param {().SetIamPolicyRequest} 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
*/
setIamPolicy(params?: Params$Resource$Folders$Setiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
setIamPolicy(params: Params$Resource$Folders$Setiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(params: Params$Resource$Folders$Setiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* cloudresourcemanager.folders.testIamPermissions
* @desc Returns permissions that a caller has on the specified Folder. The
* `resource` field should be the Folder's resource name, e.g.
* "folders/1234". There are no permissions required for making this API
* call.
* @alias cloudresourcemanager.folders.testIamPermissions
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
* @param {().TestIamPermissionsRequest} 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
*/
testIamPermissions(params?: Params$Resource$Folders$Testiampermissions, options?: MethodOptions): GaxiosPromise<Schema$TestIamPermissionsResponse>;
testIamPermissions(params: Params$Resource$Folders$Testiampermissions, options: MethodOptions | BodyResponseCallback<Schema$TestIamPermissionsResponse>, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(params: Params$Resource$Folders$Testiampermissions, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
/**
* cloudresourcemanager.folders.undelete
* @desc Cancels the deletion request for a Folder. This method may only be
* called on a Folder in the DELETE_REQUESTED state. In order to succeed,
* the Folder's parent must be in the ACTIVE state. In addition,
* reintroducing the folder into the tree must not violate folder naming,
* height and fanout constraints described in the CreateFolder
* documentation. The caller must have `resourcemanager.folders.undelete`
* permission on the identified folder.
* @alias cloudresourcemanager.folders.undelete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The resource name of the Folder to undelete. Must be of the form `folders/{folder_id}`.
* @param {().UndeleteFolderRequest} 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
*/
undelete(params?: Params$Resource$Folders$Undelete, options?: MethodOptions): GaxiosPromise<Schema$Folder>;
undelete(params: Params$Resource$Folders$Undelete, options: MethodOptions | BodyResponseCallback<Schema$Folder>, callback: BodyResponseCallback<Schema$Folder>): void;
undelete(params: Params$Resource$Folders$Undelete, callback: BodyResponseCallback<Schema$Folder>): void;
undelete(callback: BodyResponseCallback<Schema$Folder>): void;
}
interface Params$Resource$Folders$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name of the new Folder's parent. Must be of the form
* `folders/{folder_id}` or `organizations/{org_id}`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Folder;
}
interface Params$Resource$Folders$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* the resource name of the Folder to be deleted. Must be of the form
* `folders/{folder_id}`.
*/
name?: string;
}
interface Params$Resource$Folders$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name of the Folder to retrieve. Must be of the form
* `folders/{folder_id}`.
*/
name?: string;
}
interface Params$Resource$Folders$Getiampolicy extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* REQUIRED: The resource for which the policy is being requested. See the
* operation documentation for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GetIamPolicyRequest;
}
interface Params$Resource$Folders$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of Folders to return in the response. This field is
* optional.
*/
pageSize?: number;
/**
* A pagination token returned from a previous call to `ListFolders` that
* indicates where this listing should continue from. This field is
* optional.
*/
pageToken?: string;
/**
* The resource name of the Organization or Folder whose Folders are being
* listed. Must be of the form `folders/{folder_id}` or
* `organizations/{org_id}`. Access to this method is controlled by checking
* the `resourcemanager.folders.list` permission on the `parent`.
*/
parent?: string;
/**
* Controls whether Folders in the DELETE_REQUESTED state should be
* returned. Defaults to false. This field is optional.
*/
showDeleted?: boolean;
}
interface Params$Resource$Folders$Move extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name of the Folder to move. Must be of the form
* folders/{folder_id}
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$MoveFolderRequest;
}
interface Params$Resource$Folders$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Output only. The resource name of the Folder. Its format is
* `folders/{folder_id}`, for example: "folders/1234".
*/
name?: string;
/**
* Fields to be updated. Only the `display_name` can be updated.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Folder;
}
interface Params$Resource$Folders$Search extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$SearchFoldersRequest;
}
interface Params$Resource$Folders$Setiampolicy extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SetIamPolicyRequest;
}
interface Params$Resource$Folders$Testiampermissions extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TestIamPermissionsRequest;
}
interface Params$Resource$Folders$Undelete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The resource name of the Folder to undelete. Must be of the form
* `folders/{folder_id}`.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UndeleteFolderRequest;
}
class Resource$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudresourcemanager.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 cloudresourcemanager.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;
}
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;
}
}