@maxim_mazurok/gapi.client.cloudresourcemanager-v2 0.0.20231102 → 0.0.20231203

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/index.d.ts +715 -1144
  2. package/package.json +6 -6
  3. package/readme.md +36 -27
  4. package/tests.ts +0 -191
  5. package/tsconfig.json +0 -18
  6. package/tslint.json +0 -6
package/index.d.ts CHANGED
@@ -9,1155 +9,726 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v2
12
- // Revision: 20231102
12
+ // Revision: 20231203
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
16
16
  declare namespace gapi.client {
17
- /** Load Cloud Resource Manager API v2 */
18
- function load(urlOrObject: "https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v2"): Promise<void>;
19
- /** @deprecated Please load APIs with discovery documents. */
20
- function load(name: "cloudresourcemanager", version: "v2"): Promise<void>;
21
- /** @deprecated Please load APIs with discovery documents. */
22
- function load(name: "cloudresourcemanager", version: "v2", callback: () => any): void;
17
+ /** Load Cloud Resource Manager API v2 */
18
+ function load(
19
+ urlOrObject: 'https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v2'
20
+ ): Promise<void>;
21
+ /** @deprecated Please load APIs with discovery documents. */
22
+ function load(name: 'cloudresourcemanager', version: 'v2'): Promise<void>;
23
+ /** @deprecated Please load APIs with discovery documents. */
24
+ function load(
25
+ name: 'cloudresourcemanager',
26
+ version: 'v2',
27
+ callback: () => any
28
+ ): void;
23
29
 
24
- namespace cloudresourcemanager {
25
- interface AuditConfig {
26
- /** The configuration for logging of each type of permission. */
27
- auditLogConfigs?:
28
- AuditLogConfig[];
29
- /**
30
- * 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
31
- * services.
32
- */
33
- service?:
34
- string;
35
- }
36
- interface AuditLogConfig {
37
- /** Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */
38
- exemptedMembers?:
39
- string[];
40
- /** The log type that this config enables. */
41
- logType?:
42
- string;
43
- }
44
- interface Binding {
45
- /**
46
- * The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`,
47
- * then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which
48
- * resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
49
- */
50
- condition?:
51
- Expr;
52
- /**
53
- * Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on
54
- * 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
55
- * account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific
56
- * Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example,
57
- * `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service
58
- * account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *
59
- * `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
60
- * users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has
61
- * been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains
62
- * the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently
63
- * deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and
64
- * the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that
65
- * has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group
66
- * retains the role in the binding.
67
- */
68
- members?:
69
- string[];
70
- /** Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */
71
- role?:
72
- string;
73
- }
74
- interface CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation {
75
- /** The resource name of the folder or organization we are either creating the folder under or moving the folder to. */
76
- destinationParent?:
77
- string;
78
- /** The display name of the folder. */
79
- displayName?:
80
- string;
81
- /** The type of this operation. */
82
- operationType?:
83
- string;
84
- /** The resource name of the folder's parent. Only applicable when the operation_type is MOVE. */
85
- sourceParent?:
86
- string;
87
- }
88
- interface CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation {
89
- /** The resource name of the folder or organization we are either creating the folder under or moving the folder to. */
90
- destinationParent?:
91
- string;
92
- /** The display name of the folder. */
93
- displayName?:
94
- string;
95
- /** The type of this operation. */
96
- operationType?:
97
- string;
98
- /** The resource name of the folder's parent. Only applicable when the operation_type is MOVE. */
99
- sourceParent?:
100
- string;
101
- }
102
- interface CreateFolderMetadata {
103
- /** The display name of the folder. */
104
- displayName?:
105
- string;
106
- /** The resource name of the folder or organization we are creating the folder under. */
107
- parent?:
108
- string;
109
- }
110
- interface CreateProjectMetadata {
111
- /** Creation time of the project creation workflow. */
112
- createTime?:
113
- string;
114
- /** 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. */
115
- gettable?:
116
- boolean;
117
- /** True if the project creation process is complete. */
118
- ready?:
119
- boolean;
120
- }
121
- // tslint:disable-next-line:no-empty-interface
122
- interface CreateTagBindingMetadata {
123
- }
124
- // tslint:disable-next-line:no-empty-interface
125
- interface CreateTagKeyMetadata {
126
- }
127
- // tslint:disable-next-line:no-empty-interface
128
- interface CreateTagValueMetadata {
129
- }
130
- // tslint:disable-next-line:no-empty-interface
131
- interface DeleteFolderMetadata {
132
- }
133
- // tslint:disable-next-line:no-empty-interface
134
- interface DeleteOrganizationMetadata {
135
- }
136
- // tslint:disable-next-line:no-empty-interface
137
- interface DeleteProjectMetadata {
138
- }
139
- // tslint:disable-next-line:no-empty-interface
140
- interface DeleteTagBindingMetadata {
141
- }
142
- // tslint:disable-next-line:no-empty-interface
143
- interface DeleteTagKeyMetadata {
144
- }
145
- // tslint:disable-next-line:no-empty-interface
146
- interface DeleteTagValueMetadata {
147
- }
148
- interface Expr {
149
- /** Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */
150
- description?:
151
- string;
152
- /** Textual representation of an expression in Common Expression Language syntax. */
153
- expression?:
154
- string;
155
- /** Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */
156
- location?:
157
- string;
158
- /** 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. */
159
- title?:
160
- string;
161
- }
162
- interface Folder {
163
- /** Output only. Timestamp when the Folder was created. Assigned by the server. */
164
- createTime?:
165
- string;
166
- /**
167
- * 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
168
- * 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
169
- * expression: `[\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?`.
170
- */
171
- displayName?:
172
- string;
173
- /** Output only. The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder. */
174
- lifecycleState?:
175
- string;
176
- /** Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: "folders/1234". */
177
- name?:
178
- string;
179
- /** Required. The Folder's parent's resource name. Updates to the folder's parent must be performed via MoveFolder. */
180
- parent?:
181
- string;
182
- }
183
- interface FolderOperation {
184
- /** The resource name of the folder or organization we are either creating the folder under or moving the folder to. */
185
- destinationParent?:
186
- string;
187
- /** The display name of the folder. */
188
- displayName?:
189
- string;
190
- /** The type of this operation. */
191
- operationType?:
192
- string;
193
- /** The resource name of the folder's parent. Only applicable when the operation_type is MOVE. */
194
- sourceParent?:
195
- string;
196
- }
197
- interface FolderOperationError {
198
- /** The type of operation error experienced. */
199
- errorMessageId?:
200
- string;
201
- }
202
- interface GetIamPolicyRequest {
203
- /** OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */
204
- options?:
205
- GetPolicyOptions;
206
- }
207
- interface GetPolicyOptions {
208
- /**
209
- * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for
210
- * policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in
211
- * the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role
212
- * bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM
213
- * documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
214
- */
215
- requestedPolicyVersion?:
216
- number;
217
- }
218
- interface ListFoldersResponse {
219
- /** A possibly paginated list of Folders that are direct descendants of the specified parent resource. */
220
- folders?:
221
- Folder[];
222
- /** A pagination token returned from a previous call to `ListFolders` that indicates from where listing should continue. */
223
- nextPageToken?:
224
- string;
225
- }
226
- interface MoveFolderMetadata {
227
- /** The resource name of the folder or organization to move the folder to. */
228
- destinationParent?:
229
- string;
230
- /** The display name of the folder. */
231
- displayName?:
232
- string;
233
- /** The resource name of the folder's parent. */
234
- sourceParent?:
235
- string;
236
- }
237
- interface MoveFolderRequest {
238
- /** Required. 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}`. */
239
- destinationParent?:
240
- string;
241
- }
242
- // tslint:disable-next-line:no-empty-interface
243
- interface MoveProjectMetadata {
244
- }
245
- interface Operation {
246
- /** 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. */
247
- done?:
248
- boolean;
249
- /** The error result of the operation in case of failure or cancellation. */
250
- error?:
251
- Status;
252
- /**
253
- * 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
254
- * metadata. Any method that returns a long-running operation should document the metadata type, if any.
255
- */
256
- metadata?:
257
- { [P in string]: any };
258
- /**
259
- * 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 be a resource name ending
260
- * with `operations/{unique_id}`.
261
- */
262
- name?:
263
- string;
264
- /**
265
- * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original
266
- * 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
267
- * method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
268
- */
269
- response?:
270
- { [P in string]: any };
271
- }
272
- interface Policy {
273
- /** Specifies cloud audit logging configuration for this policy. */
274
- auditConfigs?:
275
- AuditConfig[];
276
- /**
277
- * Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings`
278
- * must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a
279
- * principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another
280
- * 1,450 principals to the `bindings` in the `Policy`.
281
- */
282
- bindings?:
283
- Binding[];
284
- /**
285
- * `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
286
- * 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
287
- * 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. **Important:** If you use IAM
288
- * Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1`
289
- * policy, and all of the conditions in the version `3` policy are lost.
290
- */
291
- etag?:
292
- string;
293
- /**
294
- * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings
295
- * must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a
296
- * policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use
297
- * IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1`
298
- * policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave
299
- * the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
300
- */
301
- version?:
302
- number;
303
- }
304
- interface ProjectCreationStatus {
305
- /** Creation time of the project creation workflow. */
306
- createTime?:
307
- string;
308
- /** 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. */
309
- gettable?:
310
- boolean;
311
- /** True if the project creation process is complete. */
312
- ready?:
313
- boolean;
314
- }
315
- interface SearchFoldersRequest {
316
- /** Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default. */
317
- pageSize?:
318
- number;
319
- /** Optional. A pagination token returned from a previous call to `SearchFolders` that indicates from where search should continue. */
320
- pageToken?:
321
- string;
322
- /**
323
- * 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
324
- * 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
325
- * field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior. Some example queries are: * Query `displayName=Test*`
326
- * returns Folder resources whose display name starts with "Test". * Query `lifecycleState=ACTIVE` returns Folder resources with `lifecycleState` set to `ACTIVE`. * Query
327
- * `parent=folders/123` returns Folder resources that have `folders/123` as a parent resource. * Query `parent=folders/123 AND lifecycleState=ACTIVE` returns active Folder resources
328
- * that have `folders/123` as a parent resource. * Query `displayName=\\"Test String\\"` returns Folder resources with display names that include both "Test" and "String".
329
- */
330
- query?:
331
- string;
332
- }
333
- interface SearchFoldersResponse {
334
- /** A possibly paginated folder search results. the specified parent resource. */
335
- folders?:
336
- Folder[];
337
- /** A pagination token returned from a previous call to `SearchFolders` that indicates from where searching should continue. */
338
- nextPageToken?:
339
- string;
340
- }
341
- interface SetIamPolicyRequest {
342
- /**
343
- * 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 Google Cloud
344
- * services (such as Projects) might reject them.
345
- */
346
- policy?:
347
- Policy;
348
- /**
349
- * 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:
350
- * `paths: "bindings, etag"`
351
- */
352
- updateMask?:
353
- string;
354
- }
355
- interface Status {
356
- /** The status code, which should be an enum value of google.rpc.Code. */
357
- code?:
358
- number;
359
- /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
360
- details?:
361
- Array<{ [P in string]: any }>;
362
- /**
363
- * 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
364
- * client.
365
- */
366
- message?:
367
- string;
368
- }
369
- interface TestIamPermissionsRequest {
370
- /**
371
- * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM
372
- * Overview](https://cloud.google.com/iam/docs/overview#permissions).
373
- */
374
- permissions?:
375
- string[];
376
- }
377
- interface TestIamPermissionsResponse {
378
- /** A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */
379
- permissions?:
380
- string[];
381
- }
382
- // tslint:disable-next-line:no-empty-interface
383
- interface UndeleteFolderMetadata {
384
- }
385
- // tslint:disable-next-line:no-empty-interface
386
- interface UndeleteFolderRequest {
387
- }
388
- // tslint:disable-next-line:no-empty-interface
389
- interface UndeleteOrganizationMetadata {
390
- }
391
- // tslint:disable-next-line:no-empty-interface
392
- interface UndeleteProjectMetadata {
393
- }
394
- // tslint:disable-next-line:no-empty-interface
395
- interface UpdateFolderMetadata {
396
- }
397
- // tslint:disable-next-line:no-empty-interface
398
- interface UpdateProjectMetadata {
399
- }
400
- // tslint:disable-next-line:no-empty-interface
401
- interface UpdateTagKeyMetadata {
402
- }
403
- // tslint:disable-next-line:no-empty-interface
404
- interface UpdateTagValueMetadata {
405
- }
406
- interface FoldersResource {
407
- /**
408
- * 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
409
- * 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
410
- * display_name must be distinct from all other Folders that share its parent. + The addition of the Folder must not cause the active Folder hierarchy to exceed a height of 10. Note,
411
- * the full active + deleted Folder hierarchy is allowed to reach a height of 20; this provides additional headroom when moving folders that contain deleted folders. + The addition of
412
- * the Folder must not cause the total number of Folders under its parent to exceed 300. If the operation fails due to a folder constraint violation, some errors may be returned by the
413
- * CreateFolder request, with status code FAILED_PRECONDITION and an error description. Other folder constraint violations will be communicated in the Operation, with the specific
414
- * PreconditionFailure returned via the details list in the Operation.error field. The caller must have `resourcemanager.folders.create` permission on the identified parent.
415
- */
416
- create(request: {
417
- /** V1 error format. */
418
- "$.xgafv"?:
419
- string;
420
- /** OAuth access token. */
421
- access_token?:
422
- string;
423
- /** Data format for response. */
424
- alt?:
425
- string;
426
- /** JSONP */
427
- callback?:
428
- string;
429
- /** Selector specifying which fields to include in a partial response. */
430
- fields?:
431
- string;
432
- /** 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. */
433
- key?:
434
- string;
435
- /** OAuth 2.0 token for the current user. */
436
- oauth_token?:
437
- string;
438
- /** Required. The resource name of the new Folder's parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. */
439
- parent?:
440
- string;
441
- /** Returns response with indentations and line breaks. */
442
- prettyPrint?:
443
- boolean;
444
- /** 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. */
445
- quotaUser?:
446
- string;
447
- /** Upload protocol for media (e.g. "raw", "multipart"). */
448
- upload_protocol?:
449
- string;
450
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
451
- uploadType?:
452
- string;
453
- /** Request body */
454
- resource:
455
- Folder;
456
- }): Request<Operation>;
457
- create(request: {
458
- /** V1 error format. */
459
- "$.xgafv"?:
460
- string;
461
- /** OAuth access token. */
462
- access_token?:
463
- string;
464
- /** Data format for response. */
465
- alt?:
466
- string;
467
- /** JSONP */
468
- callback?:
469
- string;
470
- /** Selector specifying which fields to include in a partial response. */
471
- fields?:
472
- string;
473
- /** 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. */
474
- key?:
475
- string;
476
- /** OAuth 2.0 token for the current user. */
477
- oauth_token?:
478
- string;
479
- /** Required. The resource name of the new Folder's parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. */
480
- parent?:
481
- string;
482
- /** Returns response with indentations and line breaks. */
483
- prettyPrint?:
484
- boolean;
485
- /** 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. */
486
- quotaUser?:
487
- string;
488
- /** Upload protocol for media (e.g. "raw", "multipart"). */
489
- upload_protocol?:
490
- string;
491
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
492
- uploadType?:
493
- string;
494
- },
495
- body: Folder): Request<Operation>;
496
- /**
497
- * 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
498
- * 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`
499
- * permission on the identified folder.
500
- */
501
- delete(request?: {
502
- /** V1 error format. */
503
- "$.xgafv"?:
504
- string;
505
- /** OAuth access token. */
506
- access_token?:
507
- string;
508
- /** Data format for response. */
509
- alt?:
510
- string;
511
- /** JSONP */
512
- callback?:
513
- string;
514
- /** Selector specifying which fields to include in a partial response. */
515
- fields?:
516
- string;
517
- /** 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. */
518
- key?:
519
- string;
520
- /** Required. the resource name of the Folder to be deleted. Must be of the form `folders/{folder_id}`. */
521
- name:
522
- string;
523
- /** OAuth 2.0 token for the current user. */
524
- oauth_token?:
525
- string;
526
- /** Returns response with indentations and line breaks. */
527
- prettyPrint?:
528
- boolean;
529
- /** 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. */
530
- quotaUser?:
531
- string;
532
- /** Upload protocol for media (e.g. "raw", "multipart"). */
533
- upload_protocol?:
534
- string;
535
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
536
- uploadType?:
537
- string;
538
- }): Request<Folder>;
539
- /**
540
- * 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
541
- * `resourcemanager.folders.get` permission on the identified folder.
542
- */
543
- get(request?: {
544
- /** V1 error format. */
545
- "$.xgafv"?:
546
- string;
547
- /** OAuth access token. */
548
- access_token?:
549
- string;
550
- /** Data format for response. */
551
- alt?:
552
- string;
553
- /** JSONP */
554
- callback?:
555
- string;
556
- /** Selector specifying which fields to include in a partial response. */
557
- fields?:
558
- string;
559
- /** 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. */
560
- key?:
561
- string;
562
- /** Required. The resource name of the Folder to retrieve. Must be of the form `folders/{folder_id}`. */
563
- name:
564
- string;
565
- /** OAuth 2.0 token for the current user. */
566
- oauth_token?:
567
- string;
568
- /** Returns response with indentations and line breaks. */
569
- prettyPrint?:
570
- boolean;
571
- /** 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. */
572
- quotaUser?:
573
- string;
574
- /** Upload protocol for media (e.g. "raw", "multipart"). */
575
- upload_protocol?:
576
- string;
577
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
578
- uploadType?:
579
- string;
580
- }): Request<Folder>;
581
- /**
582
- * 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.
583
- * "folders/1234". The caller must have `resourcemanager.folders.getIamPolicy` permission on the identified folder.
584
- */
585
- getIamPolicy(request: {
586
- /** V1 error format. */
587
- "$.xgafv"?:
588
- string;
589
- /** OAuth access token. */
590
- access_token?:
591
- string;
592
- /** Data format for response. */
593
- alt?:
594
- string;
595
- /** JSONP */
596
- callback?:
597
- string;
598
- /** Selector specifying which fields to include in a partial response. */
599
- fields?:
600
- string;
601
- /** 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. */
602
- key?:
603
- string;
604
- /** OAuth 2.0 token for the current user. */
605
- oauth_token?:
606
- string;
607
- /** Returns response with indentations and line breaks. */
608
- prettyPrint?:
609
- boolean;
610
- /** 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. */
611
- quotaUser?:
612
- string;
613
- /**
614
- * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
615
- * field.
616
- */
617
- resource:
618
- string;
619
- /** Upload protocol for media (e.g. "raw", "multipart"). */
620
- upload_protocol?:
621
- string;
622
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
623
- uploadType?:
624
- string;
625
- },
626
- body: GetIamPolicyRequest): Request<Policy>;
627
- /**
628
- * 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
629
- * 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.
630
- */
631
- list(request?: {
632
- /** V1 error format. */
633
- "$.xgafv"?:
634
- string;
635
- /** OAuth access token. */
636
- access_token?:
637
- string;
638
- /** Data format for response. */
639
- alt?:
640
- string;
641
- /** JSONP */
642
- callback?:
643
- string;
644
- /** Selector specifying which fields to include in a partial response. */
645
- fields?:
646
- string;
647
- /** 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. */
648
- key?:
649
- string;
650
- /** OAuth 2.0 token for the current user. */
651
- oauth_token?:
652
- string;
653
- /** Optional. The maximum number of Folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default. */
654
- pageSize?:
655
- number;
656
- /** Optional. A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from. */
657
- pageToken?:
658
- string;
659
- /**
660
- * Required. 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
661
- * method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`.
662
- */
663
- parent?:
664
- string;
665
- /** Returns response with indentations and line breaks. */
666
- prettyPrint?:
667
- boolean;
668
- /** 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. */
669
- quotaUser?:
670
- string;
671
- /** Optional. Controls whether Folders in the DELETE_REQUESTED state should be returned. Defaults to false. */
672
- showDeleted?:
673
- boolean;
674
- /** Upload protocol for media (e.g. "raw", "multipart"). */
675
- upload_protocol?:
676
- string;
677
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
678
- uploadType?:
679
- string;
680
- }): Request<ListFoldersResponse>;
681
- /**
682
- * 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
683
- * be populated with the moved Folder. Upon failure, a FolderOperationError categorizing the failure cause will be returned - if the failure occurs synchronously then the
684
- * 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
685
- * 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
686
- * 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
687
- * new parent.
688
- */
689
- move(request: {
690
- /** V1 error format. */
691
- "$.xgafv"?:
692
- string;
693
- /** OAuth access token. */
694
- access_token?:
695
- string;
696
- /** Data format for response. */
697
- alt?:
698
- string;
699
- /** JSONP */
700
- callback?:
701
- string;
702
- /** Selector specifying which fields to include in a partial response. */
703
- fields?:
704
- string;
705
- /** 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. */
706
- key?:
707
- string;
708
- /** Required. The resource name of the Folder to move. Must be of the form folders/{folder_id} */
709
- name:
710
- string;
711
- /** OAuth 2.0 token for the current user. */
712
- oauth_token?:
713
- string;
714
- /** Returns response with indentations and line breaks. */
715
- prettyPrint?:
716
- boolean;
717
- /** 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. */
718
- quotaUser?:
719
- string;
720
- /** Upload protocol for media (e.g. "raw", "multipart"). */
721
- upload_protocol?:
722
- string;
723
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
724
- uploadType?:
725
- string;
726
- /** Request body */
727
- resource:
728
- MoveFolderRequest;
729
- }): Request<Operation>;
730
- move(request: {
731
- /** V1 error format. */
732
- "$.xgafv"?:
733
- string;
734
- /** OAuth access token. */
735
- access_token?:
736
- string;
737
- /** Data format for response. */
738
- alt?:
739
- string;
740
- /** JSONP */
741
- callback?:
742
- string;
743
- /** Selector specifying which fields to include in a partial response. */
744
- fields?:
745
- string;
746
- /** 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. */
747
- key?:
748
- string;
749
- /** Required. The resource name of the Folder to move. Must be of the form folders/{folder_id} */
750
- name:
751
- string;
752
- /** OAuth 2.0 token for the current user. */
753
- oauth_token?:
754
- string;
755
- /** Returns response with indentations and line breaks. */
756
- prettyPrint?:
757
- boolean;
758
- /** 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. */
759
- quotaUser?:
760
- string;
761
- /** Upload protocol for media (e.g. "raw", "multipart"). */
762
- upload_protocol?:
763
- string;
764
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
765
- uploadType?:
766
- string;
767
- },
768
- body: MoveFolderRequest): Request<Operation>;
769
- /**
770
- * 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
771
- * 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
772
- * can be between 3 and 30 characters. This is captured by the regular expression: `\p{L}\p{N}{1,28}[\p{L}\p{N}]`. The caller must have `resourcemanager.folders.update` permission on
773
- * 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.
774
- */
775
- patch(request: {
776
- /** V1 error format. */
777
- "$.xgafv"?:
778
- string;
779
- /** OAuth access token. */
780
- access_token?:
781
- string;
782
- /** Data format for response. */
783
- alt?:
784
- string;
785
- /** JSONP */
786
- callback?:
787
- string;
788
- /** Selector specifying which fields to include in a partial response. */
789
- fields?:
790
- string;
791
- /** 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. */
792
- key?:
793
- string;
794
- /** Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: "folders/1234". */
795
- name:
796
- string;
797
- /** OAuth 2.0 token for the current user. */
798
- oauth_token?:
799
- string;
800
- /** Returns response with indentations and line breaks. */
801
- prettyPrint?:
802
- boolean;
803
- /** 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. */
804
- quotaUser?:
805
- string;
806
- /** Required. Fields to be updated. Only the `display_name` can be updated. */
807
- updateMask?:
808
- string;
809
- /** Upload protocol for media (e.g. "raw", "multipart"). */
810
- upload_protocol?:
811
- string;
812
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
813
- uploadType?:
814
- string;
815
- /** Request body */
816
- resource:
817
- Folder;
818
- }): Request<Folder>;
819
- patch(request: {
820
- /** V1 error format. */
821
- "$.xgafv"?:
822
- string;
823
- /** OAuth access token. */
824
- access_token?:
825
- string;
826
- /** Data format for response. */
827
- alt?:
828
- string;
829
- /** JSONP */
830
- callback?:
831
- string;
832
- /** Selector specifying which fields to include in a partial response. */
833
- fields?:
834
- string;
835
- /** 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. */
836
- key?:
837
- string;
838
- /** Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: "folders/1234". */
839
- name:
840
- string;
841
- /** OAuth 2.0 token for the current user. */
842
- oauth_token?:
843
- string;
844
- /** Returns response with indentations and line breaks. */
845
- prettyPrint?:
846
- boolean;
847
- /** 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. */
848
- quotaUser?:
849
- string;
850
- /** Required. Fields to be updated. Only the `display_name` can be updated. */
851
- updateMask?:
852
- string;
853
- /** Upload protocol for media (e.g. "raw", "multipart"). */
854
- upload_protocol?:
855
- string;
856
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
857
- uploadType?:
858
- string;
859
- },
860
- body: Folder): Request<Folder>;
861
- /**
862
- * 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.
863
- * This will only return folders on which the caller has the permission `resourcemanager.folders.get`.
864
- */
865
- search(request: {
866
- /** V1 error format. */
867
- "$.xgafv"?:
868
- string;
869
- /** OAuth access token. */
870
- access_token?:
871
- string;
872
- /** Data format for response. */
873
- alt?:
874
- string;
875
- /** JSONP */
876
- callback?:
877
- string;
878
- /** Selector specifying which fields to include in a partial response. */
879
- fields?:
880
- string;
881
- /** 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. */
882
- key?:
883
- string;
884
- /** OAuth 2.0 token for the current user. */
885
- oauth_token?:
886
- string;
887
- /** Returns response with indentations and line breaks. */
888
- prettyPrint?:
889
- boolean;
890
- /** 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. */
891
- quotaUser?:
892
- string;
893
- /** Upload protocol for media (e.g. "raw", "multipart"). */
894
- upload_protocol?:
895
- string;
896
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
897
- uploadType?:
898
- string;
899
- /** Request body */
900
- resource:
901
- SearchFoldersRequest;
902
- }): Request<SearchFoldersResponse>;
903
- search(request: {
904
- /** V1 error format. */
905
- "$.xgafv"?:
906
- string;
907
- /** OAuth access token. */
908
- access_token?:
909
- string;
910
- /** Data format for response. */
911
- alt?:
912
- string;
913
- /** JSONP */
914
- callback?:
915
- string;
916
- /** Selector specifying which fields to include in a partial response. */
917
- fields?:
918
- string;
919
- /** 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. */
920
- key?:
921
- string;
922
- /** OAuth 2.0 token for the current user. */
923
- oauth_token?:
924
- string;
925
- /** Returns response with indentations and line breaks. */
926
- prettyPrint?:
927
- boolean;
928
- /** 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. */
929
- quotaUser?:
930
- string;
931
- /** Upload protocol for media (e.g. "raw", "multipart"). */
932
- upload_protocol?:
933
- string;
934
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
935
- uploadType?:
936
- string;
937
- },
938
- body: SearchFoldersRequest): Request<SearchFoldersResponse>;
939
- /**
940
- * 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
941
- * `resourcemanager.folders.setIamPolicy` permission on the identified folder.
942
- */
943
- setIamPolicy(request: {
944
- /** V1 error format. */
945
- "$.xgafv"?:
946
- string;
947
- /** OAuth access token. */
948
- access_token?:
949
- string;
950
- /** Data format for response. */
951
- alt?:
952
- string;
953
- /** JSONP */
954
- callback?:
955
- string;
956
- /** Selector specifying which fields to include in a partial response. */
957
- fields?:
958
- string;
959
- /** 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. */
960
- key?:
961
- string;
962
- /** OAuth 2.0 token for the current user. */
963
- oauth_token?:
964
- string;
965
- /** Returns response with indentations and line breaks. */
966
- prettyPrint?:
967
- boolean;
968
- /** 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. */
969
- quotaUser?:
970
- string;
971
- /**
972
- * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
973
- * field.
974
- */
975
- resource:
976
- string;
977
- /** Upload protocol for media (e.g. "raw", "multipart"). */
978
- upload_protocol?:
979
- string;
980
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
981
- uploadType?:
982
- string;
983
- },
984
- body: SetIamPolicyRequest): Request<Policy>;
985
- /**
986
- * 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
987
- * making this API call.
988
- */
989
- testIamPermissions(request: {
990
- /** V1 error format. */
991
- "$.xgafv"?:
992
- string;
993
- /** OAuth access token. */
994
- access_token?:
995
- string;
996
- /** Data format for response. */
997
- alt?:
998
- string;
999
- /** JSONP */
1000
- callback?:
1001
- string;
1002
- /** Selector specifying which fields to include in a partial response. */
1003
- fields?:
1004
- string;
1005
- /** 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. */
1006
- key?:
1007
- string;
1008
- /** OAuth 2.0 token for the current user. */
1009
- oauth_token?:
1010
- string;
1011
- /** Returns response with indentations and line breaks. */
1012
- prettyPrint?:
1013
- boolean;
1014
- /** 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. */
1015
- quotaUser?:
1016
- string;
1017
- /**
1018
- * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
1019
- * this field.
1020
- */
1021
- resource:
1022
- string;
1023
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1024
- upload_protocol?:
1025
- string;
1026
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1027
- uploadType?:
1028
- string;
1029
- },
1030
- body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
1031
- /**
1032
- * 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
1033
- * 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
1034
- * have `resourcemanager.folders.undelete` permission on the identified folder.
1035
- */
1036
- undelete(request: {
1037
- /** V1 error format. */
1038
- "$.xgafv"?:
1039
- string;
1040
- /** OAuth access token. */
1041
- access_token?:
1042
- string;
1043
- /** Data format for response. */
1044
- alt?:
1045
- string;
1046
- /** JSONP */
1047
- callback?:
1048
- string;
1049
- /** Selector specifying which fields to include in a partial response. */
1050
- fields?:
1051
- string;
1052
- /** 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. */
1053
- key?:
1054
- string;
1055
- /** Required. The resource name of the Folder to undelete. Must be of the form `folders/{folder_id}`. */
1056
- name:
1057
- string;
1058
- /** OAuth 2.0 token for the current user. */
1059
- oauth_token?:
1060
- string;
1061
- /** Returns response with indentations and line breaks. */
1062
- prettyPrint?:
1063
- boolean;
1064
- /** 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. */
1065
- quotaUser?:
1066
- string;
1067
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1068
- upload_protocol?:
1069
- string;
1070
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1071
- uploadType?:
1072
- string;
1073
- /** Request body */
1074
- resource:
1075
- UndeleteFolderRequest;
1076
- }): Request<Folder>;
1077
- undelete(request: {
1078
- /** V1 error format. */
1079
- "$.xgafv"?:
1080
- string;
1081
- /** OAuth access token. */
1082
- access_token?:
1083
- string;
1084
- /** Data format for response. */
1085
- alt?:
1086
- string;
1087
- /** JSONP */
1088
- callback?:
1089
- string;
1090
- /** Selector specifying which fields to include in a partial response. */
1091
- fields?:
1092
- string;
1093
- /** 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. */
1094
- key?:
1095
- string;
1096
- /** Required. The resource name of the Folder to undelete. Must be of the form `folders/{folder_id}`. */
1097
- name:
1098
- string;
1099
- /** OAuth 2.0 token for the current user. */
1100
- oauth_token?:
1101
- string;
1102
- /** Returns response with indentations and line breaks. */
1103
- prettyPrint?:
1104
- boolean;
1105
- /** 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. */
1106
- quotaUser?:
1107
- string;
1108
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1109
- upload_protocol?:
1110
- string;
1111
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1112
- uploadType?:
1113
- string;
1114
- },
1115
- body: UndeleteFolderRequest): Request<Folder>;
1116
- }
1117
- interface OperationsResource {
1118
- /** 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. */
1119
- get(request?: {
1120
- /** V1 error format. */
1121
- "$.xgafv"?:
1122
- string;
1123
- /** OAuth access token. */
1124
- access_token?:
1125
- string;
1126
- /** Data format for response. */
1127
- alt?:
1128
- string;
1129
- /** JSONP */
1130
- callback?:
1131
- string;
1132
- /** Selector specifying which fields to include in a partial response. */
1133
- fields?:
1134
- string;
1135
- /** 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. */
1136
- key?:
1137
- string;
1138
- /** The name of the operation resource. */
1139
- name:
1140
- string;
1141
- /** OAuth 2.0 token for the current user. */
1142
- oauth_token?:
1143
- string;
1144
- /** Returns response with indentations and line breaks. */
1145
- prettyPrint?:
1146
- boolean;
1147
- /** 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. */
1148
- quotaUser?:
1149
- string;
1150
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1151
- upload_protocol?:
1152
- string;
1153
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1154
- uploadType?:
1155
- string;
1156
- }): Request<Operation>;
1157
- }
30
+ namespace cloudresourcemanager {
31
+ interface AuditConfig {
32
+ /** The configuration for logging of each type of permission. */
33
+ auditLogConfigs?: AuditLogConfig[];
34
+ /** 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. */
35
+ service?: string;
36
+ }
37
+ interface AuditLogConfig {
38
+ /** Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */
39
+ exemptedMembers?: string[];
40
+ /** The log type that this config enables. */
41
+ logType?: string;
42
+ }
43
+ interface Binding {
44
+ /** The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */
45
+ condition?: Expr;
46
+ /** Specifies the principals requesting access for a Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `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`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. */
47
+ members?: string[];
48
+ /** Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */
49
+ role?: string;
50
+ }
51
+ interface CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation {
52
+ /** The resource name of the folder or organization we are either creating the folder under or moving the folder to. */
53
+ destinationParent?: string;
54
+ /** The display name of the folder. */
55
+ displayName?: string;
56
+ /** The type of this operation. */
57
+ operationType?: string;
58
+ /** The resource name of the folder's parent. Only applicable when the operation_type is MOVE. */
59
+ sourceParent?: string;
60
+ }
61
+ interface CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation {
62
+ /** The resource name of the folder or organization we are either creating the folder under or moving the folder to. */
63
+ destinationParent?: string;
64
+ /** The display name of the folder. */
65
+ displayName?: string;
66
+ /** The type of this operation. */
67
+ operationType?: string;
68
+ /** The resource name of the folder's parent. Only applicable when the operation_type is MOVE. */
69
+ sourceParent?: string;
70
+ }
71
+ interface CreateFolderMetadata {
72
+ /** The display name of the folder. */
73
+ displayName?: string;
74
+ /** The resource name of the folder or organization we are creating the folder under. */
75
+ parent?: string;
76
+ }
77
+ interface CreateProjectMetadata {
78
+ /** Creation time of the project creation workflow. */
79
+ createTime?: string;
80
+ /** 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. */
81
+ gettable?: boolean;
82
+ /** True if the project creation process is complete. */
83
+ ready?: boolean;
84
+ }
85
+ interface CreateTagBindingMetadata {}
86
+ interface CreateTagKeyMetadata {}
87
+ interface CreateTagValueMetadata {}
88
+ interface DeleteFolderMetadata {}
89
+ interface DeleteOrganizationMetadata {}
90
+ interface DeleteProjectMetadata {}
91
+ interface DeleteTagBindingMetadata {}
92
+ interface DeleteTagKeyMetadata {}
93
+ interface DeleteTagValueMetadata {}
94
+ interface Expr {
95
+ /** Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */
96
+ description?: string;
97
+ /** Textual representation of an expression in Common Expression Language syntax. */
98
+ expression?: string;
99
+ /** Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */
100
+ location?: string;
101
+ /** 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. */
102
+ title?: string;
103
+ }
104
+ interface Folder {
105
+ /** Output only. Timestamp when the Folder was created. Assigned by the server. */
106
+ createTime?: string;
107
+ /** 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}])?`. */
108
+ displayName?: string;
109
+ /** Output only. The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder. */
110
+ lifecycleState?: string;
111
+ /** Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: "folders/1234". */
112
+ name?: string;
113
+ /** Required. The Folder's parent's resource name. Updates to the folder's parent must be performed via MoveFolder. */
114
+ parent?: string;
115
+ }
116
+ interface FolderOperation {
117
+ /** The resource name of the folder or organization we are either creating the folder under or moving the folder to. */
118
+ destinationParent?: string;
119
+ /** The display name of the folder. */
120
+ displayName?: string;
121
+ /** The type of this operation. */
122
+ operationType?: string;
123
+ /** The resource name of the folder's parent. Only applicable when the operation_type is MOVE. */
124
+ sourceParent?: string;
125
+ }
126
+ interface FolderOperationError {
127
+ /** The type of operation error experienced. */
128
+ errorMessageId?: string;
129
+ }
130
+ interface GetIamPolicyRequest {
131
+ /** OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */
132
+ options?: GetPolicyOptions;
133
+ }
134
+ interface GetPolicyOptions {
135
+ /** Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */
136
+ requestedPolicyVersion?: number;
137
+ }
138
+ interface ListFoldersResponse {
139
+ /** A possibly paginated list of Folders that are direct descendants of the specified parent resource. */
140
+ folders?: Folder[];
141
+ /** A pagination token returned from a previous call to `ListFolders` that indicates from where listing should continue. */
142
+ nextPageToken?: string;
143
+ }
144
+ interface MoveFolderMetadata {
145
+ /** The resource name of the folder or organization to move the folder to. */
146
+ destinationParent?: string;
147
+ /** The display name of the folder. */
148
+ displayName?: string;
149
+ /** The resource name of the folder's parent. */
150
+ sourceParent?: string;
151
+ }
152
+ interface MoveFolderRequest {
153
+ /** Required. 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}`. */
154
+ destinationParent?: string;
155
+ }
156
+ interface MoveProjectMetadata {}
157
+ interface Operation {
158
+ /** 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. */
159
+ done?: boolean;
160
+ /** The error result of the operation in case of failure or cancellation. */
161
+ error?: Status;
162
+ /** 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. */
163
+ metadata?: {[P in string]: any};
164
+ /** 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 be a resource name ending with `operations/{unique_id}`. */
165
+ name?: string;
166
+ /** The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */
167
+ response?: {[P in string]: any};
168
+ }
169
+ interface Policy {
170
+ /** Specifies cloud audit logging configuration for this policy. */
171
+ auditConfigs?: AuditConfig[];
172
+ /** Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. */
173
+ bindings?: Binding[];
174
+ /** `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. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */
175
+ etag?: string;
176
+ /** Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */
177
+ version?: number;
178
+ }
179
+ interface ProjectCreationStatus {
180
+ /** Creation time of the project creation workflow. */
181
+ createTime?: string;
182
+ /** 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. */
183
+ gettable?: boolean;
184
+ /** True if the project creation process is complete. */
185
+ ready?: boolean;
186
+ }
187
+ interface SearchFoldersRequest {
188
+ /** Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default. */
189
+ pageSize?: number;
190
+ /** Optional. A pagination token returned from a previous call to `SearchFolders` that indicates from where search should continue. */
191
+ pageToken?: string;
192
+ /** 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 `displayName=Test*` returns Folder resources whose display name starts with "Test". * Query `lifecycleState=ACTIVE` returns Folder resources with `lifecycleState` set to `ACTIVE`. * Query `parent=folders/123` returns Folder resources that have `folders/123` as a parent resource. * Query `parent=folders/123 AND lifecycleState=ACTIVE` returns active Folder resources that have `folders/123` as a parent resource. * Query `displayName=\\"Test String\\"` returns Folder resources with display names that include both "Test" and "String". */
193
+ query?: string;
194
+ }
195
+ interface SearchFoldersResponse {
196
+ /** A possibly paginated folder search results. the specified parent resource. */
197
+ folders?: Folder[];
198
+ /** A pagination token returned from a previous call to `SearchFolders` that indicates from where searching should continue. */
199
+ nextPageToken?: string;
200
+ }
201
+ interface SetIamPolicyRequest {
202
+ /** 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 Google Cloud services (such as Projects) might reject them. */
203
+ policy?: Policy;
204
+ /** 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"` */
205
+ updateMask?: string;
206
+ }
207
+ interface Status {
208
+ /** The status code, which should be an enum value of google.rpc.Code. */
209
+ code?: number;
210
+ /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
211
+ details?: Array<{[P in string]: any}>;
212
+ /** 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. */
213
+ message?: string;
214
+ }
215
+ interface TestIamPermissionsRequest {
216
+ /** 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). */
217
+ permissions?: string[];
218
+ }
219
+ interface TestIamPermissionsResponse {
220
+ /** A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */
221
+ permissions?: string[];
222
+ }
223
+ interface UndeleteFolderMetadata {}
224
+ interface UndeleteFolderRequest {}
225
+ interface UndeleteOrganizationMetadata {}
226
+ interface UndeleteProjectMetadata {}
227
+ interface UpdateFolderMetadata {}
228
+ interface UpdateProjectMetadata {}
229
+ interface UpdateTagKeyMetadata {}
230
+ interface UpdateTagValueMetadata {}
231
+ interface FoldersResource {
232
+ /** 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 Folders that share its parent. + The addition of the Folder must not cause the active Folder hierarchy to exceed a height of 10. Note, the full active + deleted Folder hierarchy is allowed to reach a height of 20; 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 300. 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. */
233
+ create(request: {
234
+ /** V1 error format. */
235
+ '$.xgafv'?: string;
236
+ /** OAuth access token. */
237
+ access_token?: string;
238
+ /** Data format for response. */
239
+ alt?: string;
240
+ /** JSONP */
241
+ callback?: string;
242
+ /** Selector specifying which fields to include in a partial response. */
243
+ fields?: string;
244
+ /** 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. */
245
+ key?: string;
246
+ /** OAuth 2.0 token for the current user. */
247
+ oauth_token?: string;
248
+ /** Required. The resource name of the new Folder's parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. */
249
+ parent?: string;
250
+ /** Returns response with indentations and line breaks. */
251
+ prettyPrint?: boolean;
252
+ /** 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. */
253
+ quotaUser?: string;
254
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
255
+ upload_protocol?: string;
256
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
257
+ uploadType?: string;
258
+ /** Request body */
259
+ resource: Folder;
260
+ }): Request<Operation>;
261
+ create(
262
+ request: {
263
+ /** V1 error format. */
264
+ '$.xgafv'?: string;
265
+ /** OAuth access token. */
266
+ access_token?: string;
267
+ /** Data format for response. */
268
+ alt?: string;
269
+ /** JSONP */
270
+ callback?: string;
271
+ /** Selector specifying which fields to include in a partial response. */
272
+ fields?: string;
273
+ /** 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. */
274
+ key?: string;
275
+ /** OAuth 2.0 token for the current user. */
276
+ oauth_token?: string;
277
+ /** Required. The resource name of the new Folder's parent. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. */
278
+ parent?: string;
279
+ /** Returns response with indentations and line breaks. */
280
+ prettyPrint?: boolean;
281
+ /** 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. */
282
+ quotaUser?: string;
283
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
284
+ upload_protocol?: string;
285
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
286
+ uploadType?: string;
287
+ },
288
+ body: Folder
289
+ ): Request<Operation>;
290
+ /** 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. */
291
+ delete(request?: {
292
+ /** V1 error format. */
293
+ '$.xgafv'?: string;
294
+ /** OAuth access token. */
295
+ access_token?: string;
296
+ /** Data format for response. */
297
+ alt?: string;
298
+ /** JSONP */
299
+ callback?: string;
300
+ /** Selector specifying which fields to include in a partial response. */
301
+ fields?: string;
302
+ /** 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. */
303
+ key?: string;
304
+ /** Required. the resource name of the Folder to be deleted. Must be of the form `folders/{folder_id}`. */
305
+ name: string;
306
+ /** OAuth 2.0 token for the current user. */
307
+ oauth_token?: string;
308
+ /** Returns response with indentations and line breaks. */
309
+ prettyPrint?: boolean;
310
+ /** 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. */
311
+ quotaUser?: string;
312
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
313
+ upload_protocol?: string;
314
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
315
+ uploadType?: string;
316
+ }): Request<Folder>;
317
+ /** 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. */
318
+ get(request?: {
319
+ /** V1 error format. */
320
+ '$.xgafv'?: string;
321
+ /** OAuth access token. */
322
+ access_token?: string;
323
+ /** Data format for response. */
324
+ alt?: string;
325
+ /** JSONP */
326
+ callback?: string;
327
+ /** Selector specifying which fields to include in a partial response. */
328
+ fields?: string;
329
+ /** 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. */
330
+ key?: string;
331
+ /** Required. The resource name of the Folder to retrieve. Must be of the form `folders/{folder_id}`. */
332
+ name: string;
333
+ /** OAuth 2.0 token for the current user. */
334
+ oauth_token?: string;
335
+ /** Returns response with indentations and line breaks. */
336
+ prettyPrint?: boolean;
337
+ /** 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. */
338
+ quotaUser?: string;
339
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
340
+ upload_protocol?: string;
341
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
342
+ uploadType?: string;
343
+ }): Request<Folder>;
344
+ /** 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. */
345
+ getIamPolicy(
346
+ request: {
347
+ /** V1 error format. */
348
+ '$.xgafv'?: string;
349
+ /** OAuth access token. */
350
+ access_token?: string;
351
+ /** Data format for response. */
352
+ alt?: string;
353
+ /** JSONP */
354
+ callback?: string;
355
+ /** Selector specifying which fields to include in a partial response. */
356
+ fields?: string;
357
+ /** 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. */
358
+ key?: string;
359
+ /** OAuth 2.0 token for the current user. */
360
+ oauth_token?: string;
361
+ /** Returns response with indentations and line breaks. */
362
+ prettyPrint?: boolean;
363
+ /** 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. */
364
+ quotaUser?: string;
365
+ /** REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */
366
+ resource: string;
367
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
368
+ upload_protocol?: string;
369
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
370
+ uploadType?: string;
371
+ },
372
+ body: GetIamPolicyRequest
373
+ ): Request<Policy>;
374
+ /** 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. */
375
+ list(request?: {
376
+ /** V1 error format. */
377
+ '$.xgafv'?: string;
378
+ /** OAuth access token. */
379
+ access_token?: string;
380
+ /** Data format for response. */
381
+ alt?: string;
382
+ /** JSONP */
383
+ callback?: string;
384
+ /** Selector specifying which fields to include in a partial response. */
385
+ fields?: string;
386
+ /** 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. */
387
+ key?: string;
388
+ /** OAuth 2.0 token for the current user. */
389
+ oauth_token?: string;
390
+ /** Optional. The maximum number of Folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default. */
391
+ pageSize?: number;
392
+ /** Optional. A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from. */
393
+ pageToken?: string;
394
+ /** Required. 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`. */
395
+ parent?: string;
396
+ /** Returns response with indentations and line breaks. */
397
+ prettyPrint?: boolean;
398
+ /** 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. */
399
+ quotaUser?: string;
400
+ /** Optional. Controls whether Folders in the DELETE_REQUESTED state should be returned. Defaults to false. */
401
+ showDeleted?: boolean;
402
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
403
+ upload_protocol?: string;
404
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
405
+ uploadType?: string;
406
+ }): Request<ListFoldersResponse>;
407
+ /** 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. */
408
+ move(request: {
409
+ /** V1 error format. */
410
+ '$.xgafv'?: string;
411
+ /** OAuth access token. */
412
+ access_token?: string;
413
+ /** Data format for response. */
414
+ alt?: string;
415
+ /** JSONP */
416
+ callback?: string;
417
+ /** Selector specifying which fields to include in a partial response. */
418
+ fields?: string;
419
+ /** 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. */
420
+ key?: string;
421
+ /** Required. The resource name of the Folder to move. Must be of the form folders/{folder_id} */
422
+ name: string;
423
+ /** OAuth 2.0 token for the current user. */
424
+ oauth_token?: string;
425
+ /** Returns response with indentations and line breaks. */
426
+ prettyPrint?: boolean;
427
+ /** 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. */
428
+ quotaUser?: string;
429
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
430
+ upload_protocol?: string;
431
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
432
+ uploadType?: string;
433
+ /** Request body */
434
+ resource: MoveFolderRequest;
435
+ }): Request<Operation>;
436
+ move(
437
+ request: {
438
+ /** V1 error format. */
439
+ '$.xgafv'?: string;
440
+ /** OAuth access token. */
441
+ access_token?: string;
442
+ /** Data format for response. */
443
+ alt?: string;
444
+ /** JSONP */
445
+ callback?: string;
446
+ /** Selector specifying which fields to include in a partial response. */
447
+ fields?: string;
448
+ /** 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. */
449
+ key?: string;
450
+ /** Required. The resource name of the Folder to move. Must be of the form folders/{folder_id} */
451
+ name: string;
452
+ /** OAuth 2.0 token for the current user. */
453
+ oauth_token?: string;
454
+ /** Returns response with indentations and line breaks. */
455
+ prettyPrint?: boolean;
456
+ /** 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. */
457
+ quotaUser?: string;
458
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
459
+ upload_protocol?: string;
460
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
461
+ uploadType?: string;
462
+ },
463
+ body: MoveFolderRequest
464
+ ): Request<Operation>;
465
+ /** 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 between 3 and 30 characters. This is captured by the regular expression: `\p{L}\p{N}{1,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. */
466
+ patch(request: {
467
+ /** V1 error format. */
468
+ '$.xgafv'?: string;
469
+ /** OAuth access token. */
470
+ access_token?: string;
471
+ /** Data format for response. */
472
+ alt?: string;
473
+ /** JSONP */
474
+ callback?: string;
475
+ /** Selector specifying which fields to include in a partial response. */
476
+ fields?: string;
477
+ /** 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. */
478
+ key?: string;
479
+ /** Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: "folders/1234". */
480
+ name: string;
481
+ /** OAuth 2.0 token for the current user. */
482
+ oauth_token?: string;
483
+ /** Returns response with indentations and line breaks. */
484
+ prettyPrint?: boolean;
485
+ /** 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. */
486
+ quotaUser?: string;
487
+ /** Required. Fields to be updated. Only the `display_name` can be updated. */
488
+ updateMask?: string;
489
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
490
+ upload_protocol?: string;
491
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
492
+ uploadType?: string;
493
+ /** Request body */
494
+ resource: Folder;
495
+ }): Request<Folder>;
496
+ patch(
497
+ request: {
498
+ /** V1 error format. */
499
+ '$.xgafv'?: string;
500
+ /** OAuth access token. */
501
+ access_token?: string;
502
+ /** Data format for response. */
503
+ alt?: string;
504
+ /** JSONP */
505
+ callback?: string;
506
+ /** Selector specifying which fields to include in a partial response. */
507
+ fields?: string;
508
+ /** 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. */
509
+ key?: string;
510
+ /** Output only. The resource name of the Folder. Its format is `folders/{folder_id}`, for example: "folders/1234". */
511
+ name: string;
512
+ /** OAuth 2.0 token for the current user. */
513
+ oauth_token?: string;
514
+ /** Returns response with indentations and line breaks. */
515
+ prettyPrint?: boolean;
516
+ /** 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. */
517
+ quotaUser?: string;
518
+ /** Required. Fields to be updated. Only the `display_name` can be updated. */
519
+ updateMask?: string;
520
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
521
+ upload_protocol?: string;
522
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
523
+ uploadType?: string;
524
+ },
525
+ body: Folder
526
+ ): Request<Folder>;
527
+ /** 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`. */
528
+ search(request: {
529
+ /** V1 error format. */
530
+ '$.xgafv'?: string;
531
+ /** OAuth access token. */
532
+ access_token?: string;
533
+ /** Data format for response. */
534
+ alt?: string;
535
+ /** JSONP */
536
+ callback?: string;
537
+ /** Selector specifying which fields to include in a partial response. */
538
+ fields?: string;
539
+ /** 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. */
540
+ key?: string;
541
+ /** OAuth 2.0 token for the current user. */
542
+ oauth_token?: string;
543
+ /** Returns response with indentations and line breaks. */
544
+ prettyPrint?: boolean;
545
+ /** 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. */
546
+ quotaUser?: string;
547
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
548
+ upload_protocol?: string;
549
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
550
+ uploadType?: string;
551
+ /** Request body */
552
+ resource: SearchFoldersRequest;
553
+ }): Request<SearchFoldersResponse>;
554
+ search(
555
+ request: {
556
+ /** V1 error format. */
557
+ '$.xgafv'?: string;
558
+ /** OAuth access token. */
559
+ access_token?: string;
560
+ /** Data format for response. */
561
+ alt?: string;
562
+ /** JSONP */
563
+ callback?: string;
564
+ /** Selector specifying which fields to include in a partial response. */
565
+ fields?: string;
566
+ /** 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. */
567
+ key?: string;
568
+ /** OAuth 2.0 token for the current user. */
569
+ oauth_token?: string;
570
+ /** Returns response with indentations and line breaks. */
571
+ prettyPrint?: boolean;
572
+ /** 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. */
573
+ quotaUser?: string;
574
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
575
+ upload_protocol?: string;
576
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
577
+ uploadType?: string;
578
+ },
579
+ body: SearchFoldersRequest
580
+ ): Request<SearchFoldersResponse>;
581
+ /** 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. */
582
+ setIamPolicy(
583
+ request: {
584
+ /** V1 error format. */
585
+ '$.xgafv'?: string;
586
+ /** OAuth access token. */
587
+ access_token?: string;
588
+ /** Data format for response. */
589
+ alt?: string;
590
+ /** JSONP */
591
+ callback?: string;
592
+ /** Selector specifying which fields to include in a partial response. */
593
+ fields?: string;
594
+ /** 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. */
595
+ key?: string;
596
+ /** OAuth 2.0 token for the current user. */
597
+ oauth_token?: string;
598
+ /** Returns response with indentations and line breaks. */
599
+ prettyPrint?: boolean;
600
+ /** 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. */
601
+ quotaUser?: string;
602
+ /** REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */
603
+ resource: string;
604
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
605
+ upload_protocol?: string;
606
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
607
+ uploadType?: string;
608
+ },
609
+ body: SetIamPolicyRequest
610
+ ): Request<Policy>;
611
+ /** 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. */
612
+ testIamPermissions(
613
+ request: {
614
+ /** V1 error format. */
615
+ '$.xgafv'?: string;
616
+ /** OAuth access token. */
617
+ access_token?: string;
618
+ /** Data format for response. */
619
+ alt?: string;
620
+ /** JSONP */
621
+ callback?: string;
622
+ /** Selector specifying which fields to include in a partial response. */
623
+ fields?: string;
624
+ /** 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. */
625
+ key?: string;
626
+ /** OAuth 2.0 token for the current user. */
627
+ oauth_token?: string;
628
+ /** Returns response with indentations and line breaks. */
629
+ prettyPrint?: boolean;
630
+ /** 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. */
631
+ quotaUser?: string;
632
+ /** REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */
633
+ resource: string;
634
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
635
+ upload_protocol?: string;
636
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
637
+ uploadType?: string;
638
+ },
639
+ body: TestIamPermissionsRequest
640
+ ): Request<TestIamPermissionsResponse>;
641
+ /** 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. */
642
+ undelete(request: {
643
+ /** V1 error format. */
644
+ '$.xgafv'?: string;
645
+ /** OAuth access token. */
646
+ access_token?: string;
647
+ /** Data format for response. */
648
+ alt?: string;
649
+ /** JSONP */
650
+ callback?: string;
651
+ /** Selector specifying which fields to include in a partial response. */
652
+ fields?: string;
653
+ /** 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. */
654
+ key?: string;
655
+ /** Required. The resource name of the Folder to undelete. Must be of the form `folders/{folder_id}`. */
656
+ name: string;
657
+ /** OAuth 2.0 token for the current user. */
658
+ oauth_token?: string;
659
+ /** Returns response with indentations and line breaks. */
660
+ prettyPrint?: boolean;
661
+ /** 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. */
662
+ quotaUser?: string;
663
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
664
+ upload_protocol?: string;
665
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
666
+ uploadType?: string;
667
+ /** Request body */
668
+ resource: UndeleteFolderRequest;
669
+ }): Request<Folder>;
670
+ undelete(
671
+ request: {
672
+ /** V1 error format. */
673
+ '$.xgafv'?: string;
674
+ /** OAuth access token. */
675
+ access_token?: string;
676
+ /** Data format for response. */
677
+ alt?: string;
678
+ /** JSONP */
679
+ callback?: string;
680
+ /** Selector specifying which fields to include in a partial response. */
681
+ fields?: string;
682
+ /** 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. */
683
+ key?: string;
684
+ /** Required. The resource name of the Folder to undelete. Must be of the form `folders/{folder_id}`. */
685
+ name: string;
686
+ /** OAuth 2.0 token for the current user. */
687
+ oauth_token?: string;
688
+ /** Returns response with indentations and line breaks. */
689
+ prettyPrint?: boolean;
690
+ /** 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. */
691
+ quotaUser?: string;
692
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
693
+ upload_protocol?: string;
694
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
695
+ uploadType?: string;
696
+ },
697
+ body: UndeleteFolderRequest
698
+ ): Request<Folder>;
699
+ }
700
+ interface OperationsResource {
701
+ /** 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. */
702
+ get(request?: {
703
+ /** V1 error format. */
704
+ '$.xgafv'?: string;
705
+ /** OAuth access token. */
706
+ access_token?: string;
707
+ /** Data format for response. */
708
+ alt?: string;
709
+ /** JSONP */
710
+ callback?: string;
711
+ /** Selector specifying which fields to include in a partial response. */
712
+ fields?: string;
713
+ /** 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. */
714
+ key?: string;
715
+ /** The name of the operation resource. */
716
+ name: string;
717
+ /** OAuth 2.0 token for the current user. */
718
+ oauth_token?: string;
719
+ /** Returns response with indentations and line breaks. */
720
+ prettyPrint?: boolean;
721
+ /** 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. */
722
+ quotaUser?: string;
723
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
724
+ upload_protocol?: string;
725
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
726
+ uploadType?: string;
727
+ }): Request<Operation>;
728
+ }
1158
729
 
1159
- const folders: FoldersResource;
730
+ const folders: FoldersResource;
1160
731
 
1161
- const operations: OperationsResource;
1162
- }
732
+ const operations: OperationsResource;
733
+ }
1163
734
  }