@maxim_mazurok/gapi.client.gkebackup-v1 0.0.20220728

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts ADDED
@@ -0,0 +1,2603 @@
1
+ /* Type definitions for non-npm package Backup for GKE API v1 0.0 */
2
+ // Project: https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke
3
+ // Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
4
+ // Nick Amoscato <https://github.com/namoscato>
5
+ // Declan Vong <https://github.com/declanvong>
6
+ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
7
+ // TypeScript Version: 2.8
8
+
9
+ // IMPORTANT
10
+ // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
11
+ // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
12
+ // Generated from: https://gkebackup.googleapis.com/$discovery/rest?version=v1
13
+ // Revision: 20220728
14
+
15
+ /// <reference types="gapi.client" />
16
+
17
+ declare namespace gapi.client {
18
+ /** Load Backup for GKE API v1 */
19
+ function load(urlOrObject: "https://gkebackup.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
20
+ /** @deprecated Please load APIs with discovery documents. */
21
+ function load(name: "gkebackup", version: "v1"): Promise<void>;
22
+ /** @deprecated Please load APIs with discovery documents. */
23
+ function load(name: "gkebackup", version: "v1", callback: () => any): void;
24
+
25
+ namespace gkebackup {
26
+ interface AuditConfig {
27
+ /** The configuration for logging of each type of permission. */
28
+ auditLogConfigs?: 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?: string;
34
+ }
35
+ interface AuditLogConfig {
36
+ /** Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */
37
+ exemptedMembers?: string[];
38
+ /** The log type that this config enables. */
39
+ logType?: string;
40
+ }
41
+ interface Backup {
42
+ /** Output only. If True, all namespaces were included in the Backup. */
43
+ allNamespaces?: boolean;
44
+ /** Output only. Information about the GKE cluster from which this Backup was created. */
45
+ clusterMetadata?: ClusterMetadata;
46
+ /** Output only. Completion time of the Backup */
47
+ completeTime?: string;
48
+ /** Output only. The size of the config backup in bytes. */
49
+ configBackupSizeBytes?: string;
50
+ /** Output only. Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value. */
51
+ containsSecrets?: boolean;
52
+ /** Output only. Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value. */
53
+ containsVolumeData?: boolean;
54
+ /** Output only. The timestamp when this Backup resource was created. */
55
+ createTime?: string;
56
+ /**
57
+ * Minimum age for this Backup (in days). If this field is set to a non-zero value, the Backup will be "locked" against deletion (either manual or automatic deletion) for the number of
58
+ * days provided (measured from the creation time of the Backup). MUST be an integer value between 0-90 (inclusive). Defaults to parent BackupPlan's backup_delete_lock_days setting and
59
+ * may only be increased (either at creation time or in a subsequent update).
60
+ */
61
+ deleteLockDays?: number;
62
+ /** Output only. The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days). */
63
+ deleteLockExpireTime?: string;
64
+ /** User specified descriptive string for this Backup. */
65
+ description?: string;
66
+ /** Output only. The customer managed encryption key that was used to encrypt the Backup's artifacts. Inherited from the parent BackupPlan's encryption_key value. */
67
+ encryptionKey?: EncryptionKey;
68
+ /**
69
+ * Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup from overwriting each other. It is strongly suggested that
70
+ * systems make use of the `etag` in the read-modify-write cycle to perform backup updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackup`, and
71
+ * systems are expected to put that etag in the request to `UpdateBackup` or `DeleteBackup` to ensure that their change will be applied to the same version of the resource.
72
+ */
73
+ etag?: string;
74
+ /** A set of custom labels supplied by user. */
75
+ labels?: { [P in string]: string };
76
+ /**
77
+ * Output only. This flag indicates whether this Backup resource was created manually by a user or via a schedule in the BackupPlan. A value of True means that the Backup was created
78
+ * manually.
79
+ */
80
+ manual?: boolean;
81
+ /** Output only. The fully qualified name of the Backup. `projects/*‍/locations/*‍/backupPlans/*‍/backups/*` */
82
+ name?: string;
83
+ /** Output only. The total number of Kubernetes Pods contained in the Backup. */
84
+ podCount?: number;
85
+ /** Output only. The total number of Kubernetes resources included in the Backup. */
86
+ resourceCount?: number;
87
+ /**
88
+ * The age (in days) after which this Backup will be automatically deleted. Must be an integer value >= 0: - If 0, no automatic deletion will occur for this Backup. - If not 0, this
89
+ * must be >= delete_lock_days and <= 365. Once a Backup is created, this value may only be increased. Defaults to the parent BackupPlan's backup_retain_days value.
90
+ */
91
+ retainDays?: number;
92
+ /** Output only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days). */
93
+ retainExpireTime?: string;
94
+ /** Output only. If set, the list of ProtectedApplications whose resources were included in the Backup. */
95
+ selectedApplications?: NamespacedNames;
96
+ /** Output only. If set, the list of namespaces that were included in the Backup. */
97
+ selectedNamespaces?: Namespaces;
98
+ /** Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes) */
99
+ sizeBytes?: string;
100
+ /** Output only. Current state of the Backup */
101
+ state?: string;
102
+ /** Output only. Human-readable description of why the backup is in the current `state`. */
103
+ stateReason?: string;
104
+ /** Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier) */
105
+ uid?: string;
106
+ /** Output only. The timestamp when this Backup resource was last updated. */
107
+ updateTime?: string;
108
+ /** Output only. The total number of volume backups contained in the Backup. */
109
+ volumeCount?: number;
110
+ }
111
+ interface BackupConfig {
112
+ /** If True, include all namespaced resources */
113
+ allNamespaces?: boolean;
114
+ /**
115
+ * This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config
116
+ * backup artifacts will not be encrypted.
117
+ */
118
+ encryptionKey?: EncryptionKey;
119
+ /** This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False */
120
+ includeSecrets?: boolean;
121
+ /** This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False */
122
+ includeVolumeData?: boolean;
123
+ /** If set, include just the resources referenced by the listed ProtectedApplications. */
124
+ selectedApplications?: NamespacedNames;
125
+ /** If set, include just the resources in the listed namespaces. */
126
+ selectedNamespaces?: Namespaces;
127
+ }
128
+ interface BackupPlan {
129
+ /** Defines the configuration of Backups created via this BackupPlan. */
130
+ backupConfig?: BackupConfig;
131
+ /** Defines a schedule for automatic Backup creation via this BackupPlan. */
132
+ backupSchedule?: Schedule;
133
+ /**
134
+ * Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - `projects/*‍/locations/*‍/clusters/*` -
135
+ * `projects/*‍/zones/*‍/clusters/*`
136
+ */
137
+ cluster?: string;
138
+ /** Output only. The timestamp when this BackupPlan resource was created. */
139
+ createTime?: string;
140
+ /**
141
+ * This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes),
142
+ * including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False
143
+ */
144
+ deactivated?: boolean;
145
+ /** User specified descriptive string for this BackupPlan. */
146
+ description?: string;
147
+ /**
148
+ * Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested
149
+ * that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An `etag` is returned in the response to
150
+ * `GetBackupPlan`, and systems are expected to put that etag in the request to `UpdateBackupPlan` or `DeleteBackupPlan` to ensure that their change will be applied to the same version
151
+ * of the resource.
152
+ */
153
+ etag?: string;
154
+ /** A set of custom labels supplied by user. */
155
+ labels?: { [P in string]: string };
156
+ /** Output only. The full name of the BackupPlan resource. Format: `projects/*‍/locations/*‍/backupPlans/*` */
157
+ name?: string;
158
+ /** Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan. */
159
+ protectedPodCount?: number;
160
+ /** RetentionPolicy governs lifecycle of Backups created under this plan. */
161
+ retentionPolicy?: RetentionPolicy;
162
+ /** Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. */
163
+ uid?: string;
164
+ /** Output only. The timestamp when this BackupPlan resource was last updated. */
165
+ updateTime?: string;
166
+ }
167
+ interface Binding {
168
+ /**
169
+ * 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`,
170
+ * 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
171
+ * resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
172
+ */
173
+ condition?: Expr;
174
+ /**
175
+ * 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
176
+ * 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
177
+ * account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that
178
+ * represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example,
179
+ * `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example,
180
+ * `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. *
181
+ * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example,
182
+ * `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service
183
+ * 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
184
+ * 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
185
+ * the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
186
+ */
187
+ members?: string[];
188
+ /** Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */
189
+ role?: string;
190
+ }
191
+ interface ClusterMetadata {
192
+ /** Anthos version */
193
+ anthosVersion?: string;
194
+ /** A list of the Backup for GKE CRD versions found in the cluster. */
195
+ backupCrdVersions?: { [P in string]: string };
196
+ /**
197
+ * The source cluster from which this Backup was created. Valid formats: - `projects/*‍/locations/*‍/clusters/*` - `projects/*‍/zones/*‍/clusters/*` This is inherited from the parent
198
+ * BackupPlan's cluster field.
199
+ */
200
+ cluster?: string;
201
+ /** GKE version */
202
+ gkeVersion?: string;
203
+ /** The Kubernetes server version of the source cluster. */
204
+ k8sVersion?: string;
205
+ }
206
+ interface ClusterResourceRestoreScope {
207
+ /**
208
+ * A list of "types" of cluster-scoped resources to be restored from the Backup. An empty list means that NO cluster-scoped resources will be restored. Note that Namespaces and
209
+ * PersistentVolume restoration is handled separately and is not governed by this field.
210
+ */
211
+ selectedGroupKinds?: GroupKind[];
212
+ }
213
+ // tslint:disable-next-line:no-empty-interface
214
+ interface Empty {
215
+ }
216
+ interface EncryptionKey {
217
+ /** Google Cloud KMS encryption key. Format: `projects/*‍/locations/*‍/keyRings/*‍/cryptoKeys/*` */
218
+ gcpKmsEncryptionKey?: string;
219
+ }
220
+ interface Expr {
221
+ /** Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */
222
+ description?: string;
223
+ /** Textual representation of an expression in Common Expression Language syntax. */
224
+ expression?: string;
225
+ /** Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */
226
+ location?: string;
227
+ /** 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. */
228
+ title?: string;
229
+ }
230
+ // tslint:disable-next-line:no-empty-interface
231
+ interface GoogleLongrunningCancelOperationRequest {
232
+ }
233
+ interface GoogleLongrunningListOperationsResponse {
234
+ /** The standard List next-page token. */
235
+ nextPageToken?: string;
236
+ /** A list of operations that matches the specified filter in the request. */
237
+ operations?: GoogleLongrunningOperation[];
238
+ }
239
+ interface GoogleLongrunningOperation {
240
+ /** 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. */
241
+ done?: boolean;
242
+ /** The error result of the operation in case of failure or cancellation. */
243
+ error?: GoogleRpcStatus;
244
+ /**
245
+ * 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
246
+ * metadata. Any method that returns a long-running operation should document the metadata type, if any.
247
+ */
248
+ metadata?: { [P in string]: any };
249
+ /**
250
+ * 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
251
+ * with `operations/{unique_id}`.
252
+ */
253
+ name?: string;
254
+ /**
255
+ * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the
256
+ * 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
257
+ * original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
258
+ */
259
+ response?: { [P in string]: any };
260
+ }
261
+ interface GoogleRpcStatus {
262
+ /** The status code, which should be an enum value of google.rpc.Code. */
263
+ code?: number;
264
+ /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
265
+ details?: Array<{ [P in string]: any }>;
266
+ /**
267
+ * 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
268
+ * client.
269
+ */
270
+ message?: string;
271
+ }
272
+ interface GroupKind {
273
+ /** API group string of a Kubernetes resource, e.g. "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string for core API group */
274
+ resourceGroup?: string;
275
+ /** Kind of a Kubernetes resource, e.g. "CustomResourceDefinition", "StorageClass", etc. */
276
+ resourceKind?: string;
277
+ }
278
+ interface ListBackupPlansResponse {
279
+ /** The list of BackupPlans matching the given criteria. */
280
+ backupPlans?: BackupPlan[];
281
+ /**
282
+ * A token which may be sent as page_token in a subsequent `ListBackupPlans` call to retrieve the next page of results. If this field is omitted or empty, then there are no more
283
+ * results to return.
284
+ */
285
+ nextPageToken?: string;
286
+ /** Locations that could not be reached. */
287
+ unreachable?: string[];
288
+ }
289
+ interface ListBackupsResponse {
290
+ /** The list of Backups matching the given criteria. */
291
+ backups?: Backup[];
292
+ /**
293
+ * A token which may be sent as page_token in a subsequent `ListBackups` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to
294
+ * return.
295
+ */
296
+ nextPageToken?: string;
297
+ }
298
+ interface ListLocationsResponse {
299
+ /** A list of locations that matches the specified filter in the request. */
300
+ locations?: Location[];
301
+ /** The standard List next-page token. */
302
+ nextPageToken?: string;
303
+ }
304
+ interface ListRestorePlansResponse {
305
+ /**
306
+ * A token which may be sent as page_token in a subsequent `ListRestorePlans` call to retrieve the next page of results. If this field is omitted or empty, then there are no more
307
+ * results to return.
308
+ */
309
+ nextPageToken?: string;
310
+ /** The list of RestorePlans matching the given criteria. */
311
+ restorePlans?: RestorePlan[];
312
+ /** Locations that could not be reached. */
313
+ unreachable?: string[];
314
+ }
315
+ interface ListRestoresResponse {
316
+ /**
317
+ * A token which may be sent as page_token in a subsequent `ListRestores` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results
318
+ * to return.
319
+ */
320
+ nextPageToken?: string;
321
+ /** The list of Restores matching the given criteria. */
322
+ restores?: Restore[];
323
+ /** Locations that could not be reached. */
324
+ unreachable?: string[];
325
+ }
326
+ interface ListVolumeBackupsResponse {
327
+ /**
328
+ * A token which may be sent as page_token in a subsequent `ListVolumeBackups` call to retrieve the next page of results. If this field is omitted or empty, then there are no more
329
+ * results to return.
330
+ */
331
+ nextPageToken?: string;
332
+ /** The list of VolumeBackups matching the given criteria. */
333
+ volumeBackups?: VolumeBackup[];
334
+ }
335
+ interface ListVolumeRestoresResponse {
336
+ /**
337
+ * A token which may be sent as page_token in a subsequent `ListVolumeRestores` call to retrieve the next page of results. If this field is omitted or empty, then there are no more
338
+ * results to return.
339
+ */
340
+ nextPageToken?: string;
341
+ /** The list of VolumeRestores matching the given criteria. */
342
+ volumeRestores?: VolumeRestore[];
343
+ }
344
+ interface Location {
345
+ /** The friendly name for this location, typically a nearby city name. For example, "Tokyo". */
346
+ displayName?: string;
347
+ /** Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */
348
+ labels?: { [P in string]: string };
349
+ /** The canonical id for this location. For example: `"us-east1"`. */
350
+ locationId?: string;
351
+ /** Service-specific metadata. For example the available capacity at the given location. */
352
+ metadata?: { [P in string]: any };
353
+ /** Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */
354
+ name?: string;
355
+ }
356
+ interface NamespacedName {
357
+ /** The name of the Kubernetes resource. */
358
+ name?: string;
359
+ /** The Namespace of the Kubernetes resource. */
360
+ namespace?: string;
361
+ }
362
+ interface NamespacedNames {
363
+ /** A list of namespaced Kubernetes resources. */
364
+ namespacedNames?: NamespacedName[];
365
+ }
366
+ interface Namespaces {
367
+ /** A list of Kubernetes Namespaces */
368
+ namespaces?: string[];
369
+ }
370
+ interface OperationMetadata {
371
+ /** Output only. API version used to start the operation. */
372
+ apiVersion?: string;
373
+ /** Output only. The time the operation was created. */
374
+ createTime?: string;
375
+ /** Output only. The time the operation finished running. */
376
+ endTime?: string;
377
+ /**
378
+ * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a
379
+ * google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
380
+ */
381
+ requestedCancellation?: boolean;
382
+ /** Output only. Human-readable status of the operation, if any. */
383
+ statusMessage?: string;
384
+ /** Output only. Server-defined resource path for the target of the operation. */
385
+ target?: string;
386
+ /** Output only. Name of the verb executed by the operation. */
387
+ verb?: string;
388
+ }
389
+ interface Policy {
390
+ /** Specifies cloud audit logging configuration for this policy. */
391
+ auditConfigs?: AuditConfig[];
392
+ /**
393
+ * 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`
394
+ * 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
395
+ * 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
396
+ * 1,450 principals to the `bindings` in the `Policy`.
397
+ */
398
+ bindings?: Binding[];
399
+ /**
400
+ * `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
401
+ * 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
402
+ * 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
403
+ * 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`
404
+ * policy, and all of the conditions in the version `3` policy are lost.
405
+ */
406
+ etag?: string;
407
+ /**
408
+ * 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
409
+ * 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
410
+ * 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
411
+ * 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`
412
+ * 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
413
+ * 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).
414
+ */
415
+ version?: number;
416
+ }
417
+ interface Restore {
418
+ /**
419
+ * Required. Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's
420
+ * backup_plan. Format: `projects/*‍/locations/*‍/backupPlans/*‍/backups/*`.
421
+ */
422
+ backup?: string;
423
+ /**
424
+ * Output only. The target cluster into which this Restore will restore data. Valid formats: - `projects/*‍/locations/*‍/clusters/*` - `projects/*‍/zones/*‍/clusters/*` Inherited from
425
+ * parent RestorePlan's cluster value.
426
+ */
427
+ cluster?: string;
428
+ /** Output only. Timestamp of when the restore operation completed. */
429
+ completeTime?: string;
430
+ /** Output only. The timestamp when this Restore resource was created. */
431
+ createTime?: string;
432
+ /** User specified descriptive string for this Restore. */
433
+ description?: string;
434
+ /**
435
+ * Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that
436
+ * systems make use of the `etag` in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestore`,
437
+ * and systems are expected to put that etag in the request to `UpdateRestore` or `DeleteRestore` to ensure that their change will be applied to the same version of the resource.
438
+ */
439
+ etag?: string;
440
+ /** A set of custom labels supplied by user. */
441
+ labels?: { [P in string]: string };
442
+ /** Output only. The full name of the Restore resource. Format: `projects/*‍/locations/*‍/restorePlans/*‍/restores/*` */
443
+ name?: string;
444
+ /** Output only. Number of resources excluded during the restore execution. */
445
+ resourcesExcludedCount?: number;
446
+ /** Output only. Number of resources that failed to be restored during the restore execution. */
447
+ resourcesFailedCount?: number;
448
+ /** Output only. Number of resources restored during the restore execution. */
449
+ resourcesRestoredCount?: number;
450
+ /** Output only. Configuration of the Restore. Inherited from parent RestorePlan's restore_config. */
451
+ restoreConfig?: RestoreConfig;
452
+ /** Output only. The current state of the Restore. */
453
+ state?: string;
454
+ /** Output only. Human-readable description of why the Restore is in its current state. */
455
+ stateReason?: string;
456
+ /** Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. */
457
+ uid?: string;
458
+ /** Output only. The timestamp when this Restore resource was last updated. */
459
+ updateTime?: string;
460
+ /** Output only. Number of volumes restored during the restore execution. */
461
+ volumesRestoredCount?: number;
462
+ }
463
+ interface RestoreConfig {
464
+ /** Restore all namespaced resources in the Backup if set to "True". Specifying this field to "False" is an error. */
465
+ allNamespaces?: boolean;
466
+ /**
467
+ * Defines the behavior for handling the situation where cluster-scoped resources being restored already exist in the target cluster. This MUST be set to a value other than
468
+ * CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED if cluster_resource_restore_scope is not empty.
469
+ */
470
+ clusterResourceConflictPolicy?: string;
471
+ /** Identifies the cluster-scoped resources to restore from the Backup. Not specifying it means NO cluster resource will be restored. */
472
+ clusterResourceRestoreScope?: ClusterResourceRestoreScope;
473
+ /**
474
+ * Defines the behavior for handling the situation where sets of namespaced resources being restored already exist in the target cluster. This MUST be set to a value other than
475
+ * NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED.
476
+ */
477
+ namespacedResourceRestoreMode?: string;
478
+ /** A list of selected ProtectedApplications to restore. The listed ProtectedApplications and all the resources to which they refer will be restored. */
479
+ selectedApplications?: NamespacedNames;
480
+ /** A list of selected Namespaces to restore from the Backup. The listed Namespaces and all resources contained in them will be restored. */
481
+ selectedNamespaces?: Namespaces;
482
+ /**
483
+ * A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order
484
+ * matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no substitution will occur.
485
+ */
486
+ substitutionRules?: SubstitutionRule[];
487
+ /** Specifies the mechanism to be used to restore volume data. Default: VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED (will be treated as NO_VOLUME_DATA_RESTORATION). */
488
+ volumeDataRestorePolicy?: string;
489
+ }
490
+ interface RestorePlan {
491
+ /**
492
+ * Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format:
493
+ * `projects/*‍/locations/*‍/backupPlans/*`.
494
+ */
495
+ backupPlan?: string;
496
+ /**
497
+ * Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid
498
+ * formats: - `projects/*‍/locations/*‍/clusters/*` - `projects/*‍/zones/*‍/clusters/*`
499
+ */
500
+ cluster?: string;
501
+ /** Output only. The timestamp when this RestorePlan resource was created. */
502
+ createTime?: string;
503
+ /** User specified descriptive string for this RestorePlan. */
504
+ description?: string;
505
+ /**
506
+ * Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that
507
+ * systems make use of the `etag` in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An `etag` is returned in the response to
508
+ * `GetRestorePlan`, and systems are expected to put that etag in the request to `UpdateRestorePlan` or `DeleteRestorePlan` to ensure that their change will be applied to the same
509
+ * version of the resource.
510
+ */
511
+ etag?: string;
512
+ /** A set of custom labels supplied by user. */
513
+ labels?: { [P in string]: string };
514
+ /** Output only. The full name of the RestorePlan resource. Format: `projects/*‍/locations/*‍/restorePlans/*`. */
515
+ name?: string;
516
+ /** Required. Configuration of Restores created via this RestorePlan. */
517
+ restoreConfig?: RestoreConfig;
518
+ /** Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. */
519
+ uid?: string;
520
+ /** Output only. The timestamp when this RestorePlan resource was last updated. */
521
+ updateTime?: string;
522
+ }
523
+ interface RetentionPolicy {
524
+ /**
525
+ * Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be
526
+ * deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a
527
+ * successful update will inherit the new value. Default: 0 (no delete blocking)
528
+ */
529
+ backupDeleteLockDays?: number;
530
+ /**
531
+ * The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be
532
+ * automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion.
533
+ * Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be
534
+ * >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. Default: 0 (no automatic deletion)
535
+ */
536
+ backupRetainDays?: number;
537
+ /**
538
+ * This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the `locked` field itself.
539
+ * Default: False
540
+ */
541
+ locked?: boolean;
542
+ }
543
+ interface Schedule {
544
+ /**
545
+ * A standard [cron](https://wikipedia.com/wiki/cron) string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days
546
+ * must also be defined. Default (empty): no automatic backup creation will occur.
547
+ */
548
+ cronSchedule?: string;
549
+ /** This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False */
550
+ paused?: boolean;
551
+ }
552
+ interface SetIamPolicyRequest {
553
+ /**
554
+ * 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
555
+ * services (such as Projects) might reject them.
556
+ */
557
+ policy?: Policy;
558
+ /**
559
+ * 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:
560
+ * `paths: "bindings, etag"`
561
+ */
562
+ updateMask?: string;
563
+ }
564
+ interface SubstitutionRule {
565
+ /**
566
+ * This is the new value to set for any fields that pass the filtering and selection criteria. To remove a value from a Kubernetes resource, either leave this field unspecified, or set
567
+ * it to the empty string ("").
568
+ */
569
+ newValue?: string;
570
+ /**
571
+ * (Filtering parameter) This is a [regular expression] (https://en.wikipedia.org/wiki/Regular_expression) that is compared against the fields matched by the target_json_path
572
+ * expression (and must also have passed the previous filters). Substitution will not be performed against fields whose value does not match this expression. If this field is NOT
573
+ * specified, then ALL fields matched by the target_json_path expression will undergo substitution. Note that an empty (e.g., "", rather than unspecified) value for for this field will
574
+ * only match empty fields.
575
+ */
576
+ originalValuePattern?: string;
577
+ /**
578
+ * (Filtering parameter) Any resource subject to substitution must belong to one of the listed "types". If this field is not provided, no type filtering will be performed (all
579
+ * resources of all types matching previous filtering parameters will be candidates for substitution).
580
+ */
581
+ targetGroupKinds?: GroupKind[];
582
+ /**
583
+ * Required. This is a [JSONPath] (https://kubernetes.io/docs/reference/kubectl/jsonpath/) expression that matches specific fields of candidate resources and it operates as both a
584
+ * filtering parameter (resources that are not matched with this expression will not be candidates for substitution) as well as a field identifier (identifies exactly which fields out
585
+ * of the candidate resources will be modified).
586
+ */
587
+ targetJsonPath?: string;
588
+ /**
589
+ * (Filtering parameter) Any resource subject to substitution must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace
590
+ * filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for substitution). To mix cluster-scoped and namespaced
591
+ * resources in the same rule, use an empty string ("") as one of the target namespaces.
592
+ */
593
+ targetNamespaces?: string[];
594
+ }
595
+ interface TestIamPermissionsRequest {
596
+ /**
597
+ * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM
598
+ * Overview](https://cloud.google.com/iam/docs/overview#permissions).
599
+ */
600
+ permissions?: string[];
601
+ }
602
+ interface TestIamPermissionsResponse {
603
+ /** A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */
604
+ permissions?: string[];
605
+ }
606
+ interface VolumeBackup {
607
+ /** Output only. The timestamp when the associated underlying volume backup operation completed. */
608
+ completeTime?: string;
609
+ /** Output only. The timestamp when this VolumeBackup resource was created. */
610
+ createTime?: string;
611
+ /** Output only. The minimum size of the disk to which this VolumeBackup can be restored. */
612
+ diskSizeBytes?: string;
613
+ /**
614
+ * Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a volume backup from overwriting each other. It is strongly suggested
615
+ * that systems make use of the `etag` in the read-modify-write cycle to perform volume backup updates in order to avoid race conditions.
616
+ */
617
+ etag?: string;
618
+ /** Output only. The format used for the volume backup. */
619
+ format?: string;
620
+ /** Output only. The full name of the VolumeBackup resource. Format: `projects/*‍/locations/*‍/backupPlans/*‍/backups/*‍/volumeBackups/*`. */
621
+ name?: string;
622
+ /** Output only. A reference to the source Kubernetes PVC from which this VolumeBackup was created. */
623
+ sourcePvc?: NamespacedName;
624
+ /** Output only. The current state of this VolumeBackup. */
625
+ state?: string;
626
+ /** Output only. A human readable message explaining why the VolumeBackup is in its current state. */
627
+ stateMessage?: string;
628
+ /**
629
+ * Output only. The aggregate size of the underlying artifacts associated with this VolumeBackup in the backup storage. This may change over time when multiple backups of the same
630
+ * volume share the same backup storage location. In particular, this is likely to increase in size when the immediately preceding backup of the same volume is deleted.
631
+ */
632
+ storageBytes?: string;
633
+ /** Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. */
634
+ uid?: string;
635
+ /** Output only. The timestamp when this VolumeBackup resource was last updated. */
636
+ updateTime?: string;
637
+ /** Output only. A storage system-specific opaque handle to the underlying volume backup. */
638
+ volumeBackupHandle?: string;
639
+ }
640
+ interface VolumeRestore {
641
+ /** Output only. The timestamp when the associated underlying volume restoration completed. */
642
+ completeTime?: string;
643
+ /** Output only. The timestamp when this VolumeRestore resource was created. */
644
+ createTime?: string;
645
+ /**
646
+ * Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a volume restore from overwriting each other. It is strongly
647
+ * suggested that systems make use of the `etag` in the read-modify-write cycle to perform volume restore updates in order to avoid race conditions.
648
+ */
649
+ etag?: string;
650
+ /** Output only. Full name of the VolumeRestore resource. Format: `projects/*‍/locations/*‍/restorePlans/*‍/restores/*‍/volumeRestores/*` */
651
+ name?: string;
652
+ /** Output only. The current state of this VolumeRestore. */
653
+ state?: string;
654
+ /** Output only. A human readable message explaining why the VolumeRestore is in its current state. */
655
+ stateMessage?: string;
656
+ /** Output only. The reference to the target Kubernetes PVC to be restored. */
657
+ targetPvc?: NamespacedName;
658
+ /** Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. */
659
+ uid?: string;
660
+ /** Output only. The timestamp when this VolumeRestore resource was last updated. */
661
+ updateTime?: string;
662
+ /** Output only. The full name of the VolumeBackup from which the volume will be restored. Format: `projects/*‍/locations/*‍/backupPlans/*‍/backups/*‍/volumeBackups/*`. */
663
+ volumeBackup?: string;
664
+ /** Output only. A storage system-specific opaque handler to the underlying volume created for the target PVC from the volume backup. */
665
+ volumeHandle?: string;
666
+ /** Output only. The type of volume provisioned */
667
+ volumeType?: string;
668
+ }
669
+ interface VolumeBackupsResource {
670
+ /** Retrieve the details of a single VolumeBackup. */
671
+ get(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. Full name of the VolumeBackup resource. Format: `projects/*‍/locations/*‍/backupPlans/*‍/backups/*‍/volumeBackups/*` */
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
+ }): Request<VolumeBackup>;
697
+ /** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
698
+ getIamPolicy(request?: {
699
+ /** V1 error format. */
700
+ "$.xgafv"?: string;
701
+ /** OAuth access token. */
702
+ access_token?: string;
703
+ /** Data format for response. */
704
+ alt?: string;
705
+ /** JSONP */
706
+ callback?: string;
707
+ /** Selector specifying which fields to include in a partial response. */
708
+ fields?: string;
709
+ /** 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. */
710
+ key?: string;
711
+ /** OAuth 2.0 token for the current user. */
712
+ oauth_token?: string;
713
+ /**
714
+ * 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
715
+ * 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
716
+ * 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
717
+ * role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM
718
+ * documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
719
+ */
720
+ "options.requestedPolicyVersion"?: number;
721
+ /** Returns response with indentations and line breaks. */
722
+ prettyPrint?: boolean;
723
+ /** 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. */
724
+ quotaUser?: string;
725
+ /**
726
+ * 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
727
+ * field.
728
+ */
729
+ resource: string;
730
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
731
+ upload_protocol?: string;
732
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
733
+ uploadType?: string;
734
+ }): Request<Policy>;
735
+ /** Lists the VolumeBackups for a given Backup. */
736
+ list(request?: {
737
+ /** V1 error format. */
738
+ "$.xgafv"?: string;
739
+ /** OAuth access token. */
740
+ access_token?: string;
741
+ /** Data format for response. */
742
+ alt?: string;
743
+ /** JSONP */
744
+ callback?: string;
745
+ /** Selector specifying which fields to include in a partial response. */
746
+ fields?: string;
747
+ /** Field match expression used to filter the results. */
748
+ filter?: string;
749
+ /** 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. */
750
+ key?: string;
751
+ /** OAuth 2.0 token for the current user. */
752
+ oauth_token?: string;
753
+ /** Field by which to sort the results. */
754
+ orderBy?: string;
755
+ /**
756
+ * The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list
757
+ * and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
758
+ */
759
+ pageSize?: number;
760
+ /**
761
+ * The value of next_page_token received from a previous `ListVolumeBackups` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating,
762
+ * all other parameters provided to `ListVolumeBackups` must match the call that provided the page token.
763
+ */
764
+ pageToken?: string;
765
+ /** Required. The Backup that contains the VolumeBackups to list. Format: `projects/*‍/locations/*‍/backupPlans/*‍/backups/*` */
766
+ parent: string;
767
+ /** Returns response with indentations and line breaks. */
768
+ prettyPrint?: boolean;
769
+ /** 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. */
770
+ quotaUser?: string;
771
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
772
+ upload_protocol?: string;
773
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
774
+ uploadType?: string;
775
+ }): Request<ListVolumeBackupsResponse>;
776
+ /** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
777
+ setIamPolicy(request: {
778
+ /** V1 error format. */
779
+ "$.xgafv"?: string;
780
+ /** OAuth access token. */
781
+ access_token?: string;
782
+ /** Data format for response. */
783
+ alt?: string;
784
+ /** JSONP */
785
+ callback?: string;
786
+ /** Selector specifying which fields to include in a partial response. */
787
+ fields?: string;
788
+ /** 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. */
789
+ key?: string;
790
+ /** OAuth 2.0 token for the current user. */
791
+ oauth_token?: string;
792
+ /** Returns response with indentations and line breaks. */
793
+ prettyPrint?: boolean;
794
+ /** 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. */
795
+ quotaUser?: string;
796
+ /**
797
+ * 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
798
+ * field.
799
+ */
800
+ resource: string;
801
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
802
+ upload_protocol?: string;
803
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
804
+ uploadType?: string;
805
+ },
806
+ body: SetIamPolicyRequest): Request<Policy>;
807
+ /**
808
+ * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This
809
+ * operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
810
+ */
811
+ testIamPermissions(request: {
812
+ /** V1 error format. */
813
+ "$.xgafv"?: string;
814
+ /** OAuth access token. */
815
+ access_token?: string;
816
+ /** Data format for response. */
817
+ alt?: string;
818
+ /** JSONP */
819
+ callback?: string;
820
+ /** Selector specifying which fields to include in a partial response. */
821
+ fields?: string;
822
+ /** 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. */
823
+ key?: string;
824
+ /** OAuth 2.0 token for the current user. */
825
+ oauth_token?: string;
826
+ /** Returns response with indentations and line breaks. */
827
+ prettyPrint?: boolean;
828
+ /** 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. */
829
+ quotaUser?: string;
830
+ /**
831
+ * 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
832
+ * this field.
833
+ */
834
+ resource: string;
835
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
836
+ upload_protocol?: string;
837
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
838
+ uploadType?: string;
839
+ },
840
+ body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
841
+ }
842
+ interface BackupsResource {
843
+ /** Creates a Backup for the given BackupPlan. */
844
+ create(request: {
845
+ /** V1 error format. */
846
+ "$.xgafv"?: string;
847
+ /** OAuth access token. */
848
+ access_token?: string;
849
+ /** Data format for response. */
850
+ alt?: string;
851
+ /**
852
+ * The client-provided short name for the Backup resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers,
853
+ * and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Backups in this BackupPlan
854
+ */
855
+ backupId?: string;
856
+ /** JSONP */
857
+ callback?: string;
858
+ /** Selector specifying which fields to include in a partial response. */
859
+ fields?: string;
860
+ /** 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. */
861
+ key?: string;
862
+ /** OAuth 2.0 token for the current user. */
863
+ oauth_token?: string;
864
+ /** Required. The BackupPlan within which to create the Backup. Format: `projects/*‍/locations/*‍/backupPlans/*` */
865
+ parent: string;
866
+ /** Returns response with indentations and line breaks. */
867
+ prettyPrint?: boolean;
868
+ /** 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. */
869
+ quotaUser?: string;
870
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
871
+ upload_protocol?: string;
872
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
873
+ uploadType?: string;
874
+ /** Request body */
875
+ resource: Backup;
876
+ }): Request<GoogleLongrunningOperation>;
877
+ create(request: {
878
+ /** V1 error format. */
879
+ "$.xgafv"?: string;
880
+ /** OAuth access token. */
881
+ access_token?: string;
882
+ /** Data format for response. */
883
+ alt?: string;
884
+ /**
885
+ * The client-provided short name for the Backup resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers,
886
+ * and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Backups in this BackupPlan
887
+ */
888
+ backupId?: string;
889
+ /** JSONP */
890
+ callback?: string;
891
+ /** Selector specifying which fields to include in a partial response. */
892
+ fields?: string;
893
+ /** 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. */
894
+ key?: string;
895
+ /** OAuth 2.0 token for the current user. */
896
+ oauth_token?: string;
897
+ /** Required. The BackupPlan within which to create the Backup. Format: `projects/*‍/locations/*‍/backupPlans/*` */
898
+ parent: string;
899
+ /** Returns response with indentations and line breaks. */
900
+ prettyPrint?: boolean;
901
+ /** 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. */
902
+ quotaUser?: string;
903
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
904
+ upload_protocol?: string;
905
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
906
+ uploadType?: string;
907
+ },
908
+ body: Backup): Request<GoogleLongrunningOperation>;
909
+ /** Deletes an existing Backup. */
910
+ delete(request?: {
911
+ /** V1 error format. */
912
+ "$.xgafv"?: string;
913
+ /** OAuth access token. */
914
+ access_token?: string;
915
+ /** Data format for response. */
916
+ alt?: string;
917
+ /** JSONP */
918
+ callback?: string;
919
+ /** If provided, this value must match the current value of the target Backup's etag field or the request is rejected. */
920
+ etag?: string;
921
+ /** Selector specifying which fields to include in a partial response. */
922
+ fields?: string;
923
+ /** If set to true, any VolumeBackups below this Backup will also be deleted. Otherwise, the request will only succeed if the Backup has no VolumeBackups. */
924
+ force?: boolean;
925
+ /** 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. */
926
+ key?: string;
927
+ /** Required. Name of the Backup resource. Format: `projects/*‍/locations/*‍/backupPlans/*‍/backups/*` */
928
+ name: string;
929
+ /** OAuth 2.0 token for the current user. */
930
+ oauth_token?: string;
931
+ /** Returns response with indentations and line breaks. */
932
+ prettyPrint?: boolean;
933
+ /** 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. */
934
+ quotaUser?: string;
935
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
936
+ upload_protocol?: string;
937
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
938
+ uploadType?: string;
939
+ }): Request<GoogleLongrunningOperation>;
940
+ /** Retrieve the details of a single Backup. */
941
+ get(request?: {
942
+ /** V1 error format. */
943
+ "$.xgafv"?: string;
944
+ /** OAuth access token. */
945
+ access_token?: string;
946
+ /** Data format for response. */
947
+ alt?: string;
948
+ /** JSONP */
949
+ callback?: string;
950
+ /** Selector specifying which fields to include in a partial response. */
951
+ fields?: string;
952
+ /** 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. */
953
+ key?: string;
954
+ /** Required. Full name of the Backup resource. Format: `projects/*‍/locations/*‍/backupPlans/*‍/backups/*` */
955
+ name: string;
956
+ /** OAuth 2.0 token for the current user. */
957
+ oauth_token?: string;
958
+ /** Returns response with indentations and line breaks. */
959
+ prettyPrint?: boolean;
960
+ /** 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. */
961
+ quotaUser?: string;
962
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
963
+ upload_protocol?: string;
964
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
965
+ uploadType?: string;
966
+ }): Request<Backup>;
967
+ /** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
968
+ getIamPolicy(request?: {
969
+ /** V1 error format. */
970
+ "$.xgafv"?: string;
971
+ /** OAuth access token. */
972
+ access_token?: string;
973
+ /** Data format for response. */
974
+ alt?: string;
975
+ /** JSONP */
976
+ callback?: string;
977
+ /** Selector specifying which fields to include in a partial response. */
978
+ fields?: string;
979
+ /** 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. */
980
+ key?: string;
981
+ /** OAuth 2.0 token for the current user. */
982
+ oauth_token?: string;
983
+ /**
984
+ * 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
985
+ * 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
986
+ * 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
987
+ * role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM
988
+ * documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
989
+ */
990
+ "options.requestedPolicyVersion"?: number;
991
+ /** Returns response with indentations and line breaks. */
992
+ prettyPrint?: boolean;
993
+ /** 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. */
994
+ quotaUser?: string;
995
+ /**
996
+ * 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
997
+ * field.
998
+ */
999
+ resource: string;
1000
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1001
+ upload_protocol?: string;
1002
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1003
+ uploadType?: string;
1004
+ }): Request<Policy>;
1005
+ /** Lists the Backups for a given BackupPlan. */
1006
+ list(request?: {
1007
+ /** V1 error format. */
1008
+ "$.xgafv"?: string;
1009
+ /** OAuth access token. */
1010
+ access_token?: string;
1011
+ /** Data format for response. */
1012
+ alt?: string;
1013
+ /** JSONP */
1014
+ callback?: string;
1015
+ /** Selector specifying which fields to include in a partial response. */
1016
+ fields?: string;
1017
+ /** Field match expression used to filter the results. */
1018
+ filter?: string;
1019
+ /** 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. */
1020
+ key?: string;
1021
+ /** OAuth 2.0 token for the current user. */
1022
+ oauth_token?: string;
1023
+ /** Field by which to sort the results. */
1024
+ orderBy?: string;
1025
+ /**
1026
+ * The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list
1027
+ * and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
1028
+ */
1029
+ pageSize?: number;
1030
+ /**
1031
+ * The value of next_page_token received from a previous `ListBackups` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all
1032
+ * other parameters provided to `ListBackups` must match the call that provided the page token.
1033
+ */
1034
+ pageToken?: string;
1035
+ /** Required. The BackupPlan that contains the Backups to list. Format: `projects/*‍/locations/*‍/backupPlans/*` */
1036
+ parent: string;
1037
+ /** Returns response with indentations and line breaks. */
1038
+ prettyPrint?: boolean;
1039
+ /** 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. */
1040
+ quotaUser?: string;
1041
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1042
+ upload_protocol?: string;
1043
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1044
+ uploadType?: string;
1045
+ }): Request<ListBackupsResponse>;
1046
+ /** Update a Backup. */
1047
+ patch(request: {
1048
+ /** V1 error format. */
1049
+ "$.xgafv"?: string;
1050
+ /** OAuth access token. */
1051
+ access_token?: string;
1052
+ /** Data format for response. */
1053
+ alt?: string;
1054
+ /** JSONP */
1055
+ callback?: string;
1056
+ /** Selector specifying which fields to include in a partial response. */
1057
+ fields?: string;
1058
+ /** 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. */
1059
+ key?: string;
1060
+ /** Output only. The fully qualified name of the Backup. `projects/*‍/locations/*‍/backupPlans/*‍/backups/*` */
1061
+ name: string;
1062
+ /** OAuth 2.0 token for the current user. */
1063
+ oauth_token?: string;
1064
+ /** Returns response with indentations and line breaks. */
1065
+ prettyPrint?: boolean;
1066
+ /** 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. */
1067
+ quotaUser?: string;
1068
+ /**
1069
+ * This is used to specify the fields to be overwritten in the Backup targeted for update. The values for each of these updated fields will be taken from the `backup_plan` provided
1070
+ * with this request. Field names are relative to the root of the resource. If no `update_mask` is provided, all fields in `backup` will be written to the target Backup resource.
1071
+ * Note that OUTPUT_ONLY and IMMUTABLE fields in `backup` are ignored and are not used to update the target Backup.
1072
+ */
1073
+ updateMask?: string;
1074
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1075
+ upload_protocol?: string;
1076
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1077
+ uploadType?: string;
1078
+ /** Request body */
1079
+ resource: Backup;
1080
+ }): Request<GoogleLongrunningOperation>;
1081
+ patch(request: {
1082
+ /** V1 error format. */
1083
+ "$.xgafv"?: string;
1084
+ /** OAuth access token. */
1085
+ access_token?: string;
1086
+ /** Data format for response. */
1087
+ alt?: string;
1088
+ /** JSONP */
1089
+ callback?: string;
1090
+ /** Selector specifying which fields to include in a partial response. */
1091
+ fields?: string;
1092
+ /** 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. */
1093
+ key?: string;
1094
+ /** Output only. The fully qualified name of the Backup. `projects/*‍/locations/*‍/backupPlans/*‍/backups/*` */
1095
+ name: string;
1096
+ /** OAuth 2.0 token for the current user. */
1097
+ oauth_token?: string;
1098
+ /** Returns response with indentations and line breaks. */
1099
+ prettyPrint?: boolean;
1100
+ /** 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. */
1101
+ quotaUser?: string;
1102
+ /**
1103
+ * This is used to specify the fields to be overwritten in the Backup targeted for update. The values for each of these updated fields will be taken from the `backup_plan` provided
1104
+ * with this request. Field names are relative to the root of the resource. If no `update_mask` is provided, all fields in `backup` will be written to the target Backup resource.
1105
+ * Note that OUTPUT_ONLY and IMMUTABLE fields in `backup` are ignored and are not used to update the target Backup.
1106
+ */
1107
+ updateMask?: string;
1108
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1109
+ upload_protocol?: string;
1110
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1111
+ uploadType?: string;
1112
+ },
1113
+ body: Backup): Request<GoogleLongrunningOperation>;
1114
+ /** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
1115
+ setIamPolicy(request: {
1116
+ /** V1 error format. */
1117
+ "$.xgafv"?: string;
1118
+ /** OAuth access token. */
1119
+ access_token?: string;
1120
+ /** Data format for response. */
1121
+ alt?: string;
1122
+ /** JSONP */
1123
+ callback?: string;
1124
+ /** Selector specifying which fields to include in a partial response. */
1125
+ fields?: string;
1126
+ /** 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. */
1127
+ key?: string;
1128
+ /** OAuth 2.0 token for the current user. */
1129
+ oauth_token?: string;
1130
+ /** Returns response with indentations and line breaks. */
1131
+ prettyPrint?: boolean;
1132
+ /** 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. */
1133
+ quotaUser?: string;
1134
+ /**
1135
+ * 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
1136
+ * field.
1137
+ */
1138
+ resource: string;
1139
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1140
+ upload_protocol?: string;
1141
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1142
+ uploadType?: string;
1143
+ },
1144
+ body: SetIamPolicyRequest): Request<Policy>;
1145
+ /**
1146
+ * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This
1147
+ * operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
1148
+ */
1149
+ testIamPermissions(request: {
1150
+ /** V1 error format. */
1151
+ "$.xgafv"?: string;
1152
+ /** OAuth access token. */
1153
+ access_token?: string;
1154
+ /** Data format for response. */
1155
+ alt?: string;
1156
+ /** JSONP */
1157
+ callback?: string;
1158
+ /** Selector specifying which fields to include in a partial response. */
1159
+ fields?: string;
1160
+ /** 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. */
1161
+ key?: string;
1162
+ /** OAuth 2.0 token for the current user. */
1163
+ oauth_token?: string;
1164
+ /** Returns response with indentations and line breaks. */
1165
+ prettyPrint?: boolean;
1166
+ /** 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. */
1167
+ quotaUser?: string;
1168
+ /**
1169
+ * 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
1170
+ * this field.
1171
+ */
1172
+ resource: string;
1173
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1174
+ upload_protocol?: string;
1175
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1176
+ uploadType?: string;
1177
+ },
1178
+ body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
1179
+ volumeBackups: VolumeBackupsResource;
1180
+ }
1181
+ interface BackupPlansResource {
1182
+ /** Creates a new BackupPlan in a given location. */
1183
+ create(request: {
1184
+ /** V1 error format. */
1185
+ "$.xgafv"?: string;
1186
+ /** OAuth access token. */
1187
+ access_token?: string;
1188
+ /** Data format for response. */
1189
+ alt?: string;
1190
+ /**
1191
+ * Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII
1192
+ * letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupPlans in this location
1193
+ */
1194
+ backupPlanId?: string;
1195
+ /** JSONP */
1196
+ callback?: string;
1197
+ /** Selector specifying which fields to include in a partial response. */
1198
+ fields?: string;
1199
+ /** 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. */
1200
+ key?: string;
1201
+ /** OAuth 2.0 token for the current user. */
1202
+ oauth_token?: string;
1203
+ /** Required. The location within which to create the BackupPlan. Format: `projects/*‍/locations/*` */
1204
+ parent: string;
1205
+ /** Returns response with indentations and line breaks. */
1206
+ prettyPrint?: boolean;
1207
+ /** 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. */
1208
+ quotaUser?: string;
1209
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1210
+ upload_protocol?: string;
1211
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1212
+ uploadType?: string;
1213
+ /** Request body */
1214
+ resource: BackupPlan;
1215
+ }): Request<GoogleLongrunningOperation>;
1216
+ create(request: {
1217
+ /** V1 error format. */
1218
+ "$.xgafv"?: string;
1219
+ /** OAuth access token. */
1220
+ access_token?: string;
1221
+ /** Data format for response. */
1222
+ alt?: string;
1223
+ /**
1224
+ * Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII
1225
+ * letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupPlans in this location
1226
+ */
1227
+ backupPlanId?: string;
1228
+ /** JSONP */
1229
+ callback?: string;
1230
+ /** Selector specifying which fields to include in a partial response. */
1231
+ fields?: string;
1232
+ /** 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. */
1233
+ key?: string;
1234
+ /** OAuth 2.0 token for the current user. */
1235
+ oauth_token?: string;
1236
+ /** Required. The location within which to create the BackupPlan. Format: `projects/*‍/locations/*` */
1237
+ parent: string;
1238
+ /** Returns response with indentations and line breaks. */
1239
+ prettyPrint?: boolean;
1240
+ /** 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. */
1241
+ quotaUser?: string;
1242
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1243
+ upload_protocol?: string;
1244
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1245
+ uploadType?: string;
1246
+ },
1247
+ body: BackupPlan): Request<GoogleLongrunningOperation>;
1248
+ /** Deletes an existing BackupPlan. */
1249
+ delete(request?: {
1250
+ /** V1 error format. */
1251
+ "$.xgafv"?: string;
1252
+ /** OAuth access token. */
1253
+ access_token?: string;
1254
+ /** Data format for response. */
1255
+ alt?: string;
1256
+ /** JSONP */
1257
+ callback?: string;
1258
+ /** If provided, this value must match the current value of the target BackupPlan's etag field or the request is rejected. */
1259
+ etag?: string;
1260
+ /** Selector specifying which fields to include in a partial response. */
1261
+ fields?: string;
1262
+ /** 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. */
1263
+ key?: string;
1264
+ /** Required. Fully qualified BackupPlan name. Format: `projects/*‍/locations/*‍/backupPlans/*` */
1265
+ name: string;
1266
+ /** OAuth 2.0 token for the current user. */
1267
+ oauth_token?: string;
1268
+ /** Returns response with indentations and line breaks. */
1269
+ prettyPrint?: boolean;
1270
+ /** 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. */
1271
+ quotaUser?: string;
1272
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1273
+ upload_protocol?: string;
1274
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1275
+ uploadType?: string;
1276
+ }): Request<GoogleLongrunningOperation>;
1277
+ /** Retrieve the details of a single BackupPlan. */
1278
+ get(request?: {
1279
+ /** V1 error format. */
1280
+ "$.xgafv"?: string;
1281
+ /** OAuth access token. */
1282
+ access_token?: string;
1283
+ /** Data format for response. */
1284
+ alt?: string;
1285
+ /** JSONP */
1286
+ callback?: string;
1287
+ /** Selector specifying which fields to include in a partial response. */
1288
+ fields?: string;
1289
+ /** 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. */
1290
+ key?: string;
1291
+ /** Required. Fully qualified BackupPlan name. Format: `projects/*‍/locations/*‍/backupPlans/*` */
1292
+ name: string;
1293
+ /** OAuth 2.0 token for the current user. */
1294
+ oauth_token?: string;
1295
+ /** Returns response with indentations and line breaks. */
1296
+ prettyPrint?: boolean;
1297
+ /** 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. */
1298
+ quotaUser?: string;
1299
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1300
+ upload_protocol?: string;
1301
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1302
+ uploadType?: string;
1303
+ }): Request<BackupPlan>;
1304
+ /** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
1305
+ getIamPolicy(request?: {
1306
+ /** V1 error format. */
1307
+ "$.xgafv"?: string;
1308
+ /** OAuth access token. */
1309
+ access_token?: string;
1310
+ /** Data format for response. */
1311
+ alt?: string;
1312
+ /** JSONP */
1313
+ callback?: string;
1314
+ /** Selector specifying which fields to include in a partial response. */
1315
+ fields?: string;
1316
+ /** 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. */
1317
+ key?: string;
1318
+ /** OAuth 2.0 token for the current user. */
1319
+ oauth_token?: string;
1320
+ /**
1321
+ * 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
1322
+ * 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
1323
+ * 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
1324
+ * role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM
1325
+ * documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1326
+ */
1327
+ "options.requestedPolicyVersion"?: number;
1328
+ /** Returns response with indentations and line breaks. */
1329
+ prettyPrint?: boolean;
1330
+ /** 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. */
1331
+ quotaUser?: string;
1332
+ /**
1333
+ * 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
1334
+ * field.
1335
+ */
1336
+ resource: string;
1337
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1338
+ upload_protocol?: string;
1339
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1340
+ uploadType?: string;
1341
+ }): Request<Policy>;
1342
+ /** Lists BackupPlans in a given location. */
1343
+ list(request?: {
1344
+ /** V1 error format. */
1345
+ "$.xgafv"?: string;
1346
+ /** OAuth access token. */
1347
+ access_token?: string;
1348
+ /** Data format for response. */
1349
+ alt?: string;
1350
+ /** JSONP */
1351
+ callback?: string;
1352
+ /** Selector specifying which fields to include in a partial response. */
1353
+ fields?: string;
1354
+ /** Field match expression used to filter the results. */
1355
+ filter?: string;
1356
+ /** 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. */
1357
+ key?: string;
1358
+ /** OAuth 2.0 token for the current user. */
1359
+ oauth_token?: string;
1360
+ /** Field by which to sort the results. */
1361
+ orderBy?: string;
1362
+ /**
1363
+ * The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list
1364
+ * and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
1365
+ */
1366
+ pageSize?: number;
1367
+ /**
1368
+ * The value of next_page_token received from a previous `ListBackupPlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all
1369
+ * other parameters provided to `ListBackupPlans` must match the call that provided the page token.
1370
+ */
1371
+ pageToken?: string;
1372
+ /** Required. The location that contains the BackupPlans to list. Format: `projects/*‍/locations/*` */
1373
+ parent: string;
1374
+ /** Returns response with indentations and line breaks. */
1375
+ prettyPrint?: boolean;
1376
+ /** 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. */
1377
+ quotaUser?: string;
1378
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1379
+ upload_protocol?: string;
1380
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1381
+ uploadType?: string;
1382
+ }): Request<ListBackupPlansResponse>;
1383
+ /** Update a BackupPlan. */
1384
+ patch(request: {
1385
+ /** V1 error format. */
1386
+ "$.xgafv"?: string;
1387
+ /** OAuth access token. */
1388
+ access_token?: string;
1389
+ /** Data format for response. */
1390
+ alt?: string;
1391
+ /** JSONP */
1392
+ callback?: string;
1393
+ /** Selector specifying which fields to include in a partial response. */
1394
+ fields?: string;
1395
+ /** 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. */
1396
+ key?: string;
1397
+ /** Output only. The full name of the BackupPlan resource. Format: `projects/*‍/locations/*‍/backupPlans/*` */
1398
+ name: string;
1399
+ /** OAuth 2.0 token for the current user. */
1400
+ oauth_token?: string;
1401
+ /** Returns response with indentations and line breaks. */
1402
+ prettyPrint?: boolean;
1403
+ /** 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. */
1404
+ quotaUser?: string;
1405
+ /**
1406
+ * This is used to specify the fields to be overwritten in the BackupPlan targeted for update. The values for each of these updated fields will be taken from the `backup_plan`
1407
+ * provided with this request. Field names are relative to the root of the resource (e.g., `description`, `backup_config.include_volume_data`, etc.) If no `update_mask` is
1408
+ * provided, all fields in `backup_plan` will be written to the target BackupPlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup_plan` are ignored and are not used
1409
+ * to update the target BackupPlan.
1410
+ */
1411
+ updateMask?: string;
1412
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1413
+ upload_protocol?: string;
1414
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1415
+ uploadType?: string;
1416
+ /** Request body */
1417
+ resource: BackupPlan;
1418
+ }): Request<GoogleLongrunningOperation>;
1419
+ patch(request: {
1420
+ /** V1 error format. */
1421
+ "$.xgafv"?: string;
1422
+ /** OAuth access token. */
1423
+ access_token?: string;
1424
+ /** Data format for response. */
1425
+ alt?: string;
1426
+ /** JSONP */
1427
+ callback?: string;
1428
+ /** Selector specifying which fields to include in a partial response. */
1429
+ fields?: string;
1430
+ /** 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. */
1431
+ key?: string;
1432
+ /** Output only. The full name of the BackupPlan resource. Format: `projects/*‍/locations/*‍/backupPlans/*` */
1433
+ name: string;
1434
+ /** OAuth 2.0 token for the current user. */
1435
+ oauth_token?: string;
1436
+ /** Returns response with indentations and line breaks. */
1437
+ prettyPrint?: boolean;
1438
+ /** 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. */
1439
+ quotaUser?: string;
1440
+ /**
1441
+ * This is used to specify the fields to be overwritten in the BackupPlan targeted for update. The values for each of these updated fields will be taken from the `backup_plan`
1442
+ * provided with this request. Field names are relative to the root of the resource (e.g., `description`, `backup_config.include_volume_data`, etc.) If no `update_mask` is
1443
+ * provided, all fields in `backup_plan` will be written to the target BackupPlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup_plan` are ignored and are not used
1444
+ * to update the target BackupPlan.
1445
+ */
1446
+ updateMask?: string;
1447
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1448
+ upload_protocol?: string;
1449
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1450
+ uploadType?: string;
1451
+ },
1452
+ body: BackupPlan): Request<GoogleLongrunningOperation>;
1453
+ /** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
1454
+ setIamPolicy(request: {
1455
+ /** V1 error format. */
1456
+ "$.xgafv"?: string;
1457
+ /** OAuth access token. */
1458
+ access_token?: string;
1459
+ /** Data format for response. */
1460
+ alt?: string;
1461
+ /** JSONP */
1462
+ callback?: string;
1463
+ /** Selector specifying which fields to include in a partial response. */
1464
+ fields?: string;
1465
+ /** 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. */
1466
+ key?: string;
1467
+ /** OAuth 2.0 token for the current user. */
1468
+ oauth_token?: string;
1469
+ /** Returns response with indentations and line breaks. */
1470
+ prettyPrint?: boolean;
1471
+ /** 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. */
1472
+ quotaUser?: string;
1473
+ /**
1474
+ * 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
1475
+ * field.
1476
+ */
1477
+ resource: string;
1478
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1479
+ upload_protocol?: string;
1480
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1481
+ uploadType?: string;
1482
+ },
1483
+ body: SetIamPolicyRequest): Request<Policy>;
1484
+ /**
1485
+ * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This
1486
+ * operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
1487
+ */
1488
+ testIamPermissions(request: {
1489
+ /** V1 error format. */
1490
+ "$.xgafv"?: string;
1491
+ /** OAuth access token. */
1492
+ access_token?: string;
1493
+ /** Data format for response. */
1494
+ alt?: string;
1495
+ /** JSONP */
1496
+ callback?: string;
1497
+ /** Selector specifying which fields to include in a partial response. */
1498
+ fields?: string;
1499
+ /** 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. */
1500
+ key?: string;
1501
+ /** OAuth 2.0 token for the current user. */
1502
+ oauth_token?: string;
1503
+ /** Returns response with indentations and line breaks. */
1504
+ prettyPrint?: boolean;
1505
+ /** 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. */
1506
+ quotaUser?: string;
1507
+ /**
1508
+ * 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
1509
+ * this field.
1510
+ */
1511
+ resource: string;
1512
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1513
+ upload_protocol?: string;
1514
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1515
+ uploadType?: string;
1516
+ },
1517
+ body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
1518
+ backups: BackupsResource;
1519
+ }
1520
+ interface OperationsResource {
1521
+ /**
1522
+ * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support
1523
+ * this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the
1524
+ * operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a
1525
+ * google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
1526
+ */
1527
+ cancel(request: {
1528
+ /** V1 error format. */
1529
+ "$.xgafv"?: string;
1530
+ /** OAuth access token. */
1531
+ access_token?: string;
1532
+ /** Data format for response. */
1533
+ alt?: string;
1534
+ /** JSONP */
1535
+ callback?: string;
1536
+ /** Selector specifying which fields to include in a partial response. */
1537
+ fields?: string;
1538
+ /** 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. */
1539
+ key?: string;
1540
+ /** The name of the operation resource to be cancelled. */
1541
+ name: string;
1542
+ /** OAuth 2.0 token for the current user. */
1543
+ oauth_token?: string;
1544
+ /** Returns response with indentations and line breaks. */
1545
+ prettyPrint?: boolean;
1546
+ /** 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. */
1547
+ quotaUser?: string;
1548
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1549
+ upload_protocol?: string;
1550
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1551
+ uploadType?: string;
1552
+ /** Request body */
1553
+ resource: GoogleLongrunningCancelOperationRequest;
1554
+ }): Request<{}>;
1555
+ cancel(request: {
1556
+ /** V1 error format. */
1557
+ "$.xgafv"?: string;
1558
+ /** OAuth access token. */
1559
+ access_token?: string;
1560
+ /** Data format for response. */
1561
+ alt?: string;
1562
+ /** JSONP */
1563
+ callback?: string;
1564
+ /** Selector specifying which fields to include in a partial response. */
1565
+ fields?: string;
1566
+ /** 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. */
1567
+ key?: string;
1568
+ /** The name of the operation resource to be cancelled. */
1569
+ name: string;
1570
+ /** OAuth 2.0 token for the current user. */
1571
+ oauth_token?: string;
1572
+ /** Returns response with indentations and line breaks. */
1573
+ prettyPrint?: boolean;
1574
+ /** 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. */
1575
+ quotaUser?: string;
1576
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1577
+ upload_protocol?: string;
1578
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1579
+ uploadType?: string;
1580
+ },
1581
+ body: GoogleLongrunningCancelOperationRequest): Request<{}>;
1582
+ /** 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. */
1583
+ get(request?: {
1584
+ /** V1 error format. */
1585
+ "$.xgafv"?: string;
1586
+ /** OAuth access token. */
1587
+ access_token?: string;
1588
+ /** Data format for response. */
1589
+ alt?: string;
1590
+ /** JSONP */
1591
+ callback?: string;
1592
+ /** Selector specifying which fields to include in a partial response. */
1593
+ fields?: string;
1594
+ /** 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. */
1595
+ key?: string;
1596
+ /** The name of the operation resource. */
1597
+ name: string;
1598
+ /** OAuth 2.0 token for the current user. */
1599
+ oauth_token?: string;
1600
+ /** Returns response with indentations and line breaks. */
1601
+ prettyPrint?: boolean;
1602
+ /** 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. */
1603
+ quotaUser?: string;
1604
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1605
+ upload_protocol?: string;
1606
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1607
+ uploadType?: string;
1608
+ }): Request<GoogleLongrunningOperation>;
1609
+ /**
1610
+ * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
1611
+ * to override the binding to use different resource name schemes, such as `users/*‍/operations`. To override the binding, API services can add a binding such as
1612
+ * `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
1613
+ * ensure the name binding is the parent resource, without the operations collection id.
1614
+ */
1615
+ list(request?: {
1616
+ /** V1 error format. */
1617
+ "$.xgafv"?: string;
1618
+ /** OAuth access token. */
1619
+ access_token?: string;
1620
+ /** Data format for response. */
1621
+ alt?: string;
1622
+ /** JSONP */
1623
+ callback?: string;
1624
+ /** Selector specifying which fields to include in a partial response. */
1625
+ fields?: string;
1626
+ /** The standard list filter. */
1627
+ filter?: string;
1628
+ /** 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. */
1629
+ key?: string;
1630
+ /** The name of the operation's parent resource. */
1631
+ name: string;
1632
+ /** OAuth 2.0 token for the current user. */
1633
+ oauth_token?: string;
1634
+ /** The standard list page size. */
1635
+ pageSize?: number;
1636
+ /** The standard list page token. */
1637
+ pageToken?: string;
1638
+ /** Returns response with indentations and line breaks. */
1639
+ prettyPrint?: boolean;
1640
+ /** 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. */
1641
+ quotaUser?: string;
1642
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1643
+ upload_protocol?: string;
1644
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1645
+ uploadType?: string;
1646
+ }): Request<GoogleLongrunningListOperationsResponse>;
1647
+ }
1648
+ interface VolumeRestoresResource {
1649
+ /** Retrieve the details of a single VolumeRestore. */
1650
+ get(request?: {
1651
+ /** V1 error format. */
1652
+ "$.xgafv"?: string;
1653
+ /** OAuth access token. */
1654
+ access_token?: string;
1655
+ /** Data format for response. */
1656
+ alt?: string;
1657
+ /** JSONP */
1658
+ callback?: string;
1659
+ /** Selector specifying which fields to include in a partial response. */
1660
+ fields?: string;
1661
+ /** 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. */
1662
+ key?: string;
1663
+ /** Required. Full name of the VolumeRestore resource. Format: `projects/*‍/locations/*‍/restorePlans/*‍/restores/*‍/volumeRestores/*` */
1664
+ name: string;
1665
+ /** OAuth 2.0 token for the current user. */
1666
+ oauth_token?: string;
1667
+ /** Returns response with indentations and line breaks. */
1668
+ prettyPrint?: boolean;
1669
+ /** 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. */
1670
+ quotaUser?: string;
1671
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1672
+ upload_protocol?: string;
1673
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1674
+ uploadType?: string;
1675
+ }): Request<VolumeRestore>;
1676
+ /** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
1677
+ getIamPolicy(request?: {
1678
+ /** V1 error format. */
1679
+ "$.xgafv"?: string;
1680
+ /** OAuth access token. */
1681
+ access_token?: string;
1682
+ /** Data format for response. */
1683
+ alt?: string;
1684
+ /** JSONP */
1685
+ callback?: string;
1686
+ /** Selector specifying which fields to include in a partial response. */
1687
+ fields?: string;
1688
+ /** 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. */
1689
+ key?: string;
1690
+ /** OAuth 2.0 token for the current user. */
1691
+ oauth_token?: string;
1692
+ /**
1693
+ * 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
1694
+ * 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
1695
+ * 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
1696
+ * role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM
1697
+ * documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1698
+ */
1699
+ "options.requestedPolicyVersion"?: number;
1700
+ /** Returns response with indentations and line breaks. */
1701
+ prettyPrint?: boolean;
1702
+ /** 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. */
1703
+ quotaUser?: string;
1704
+ /**
1705
+ * 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
1706
+ * field.
1707
+ */
1708
+ resource: string;
1709
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1710
+ upload_protocol?: string;
1711
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1712
+ uploadType?: string;
1713
+ }): Request<Policy>;
1714
+ /** Lists the VolumeRestores for a given Restore. */
1715
+ list(request?: {
1716
+ /** V1 error format. */
1717
+ "$.xgafv"?: string;
1718
+ /** OAuth access token. */
1719
+ access_token?: string;
1720
+ /** Data format for response. */
1721
+ alt?: string;
1722
+ /** JSONP */
1723
+ callback?: string;
1724
+ /** Selector specifying which fields to include in a partial response. */
1725
+ fields?: string;
1726
+ /** Field match expression used to filter the results. */
1727
+ filter?: string;
1728
+ /** 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. */
1729
+ key?: string;
1730
+ /** OAuth 2.0 token for the current user. */
1731
+ oauth_token?: string;
1732
+ /** Field by which to sort the results. */
1733
+ orderBy?: string;
1734
+ /**
1735
+ * The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list
1736
+ * and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
1737
+ */
1738
+ pageSize?: number;
1739
+ /**
1740
+ * The value of next_page_token received from a previous `ListVolumeRestores` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating,
1741
+ * all other parameters provided to `ListVolumeRestores` must match the call that provided the page token.
1742
+ */
1743
+ pageToken?: string;
1744
+ /** Required. The Restore that contains the VolumeRestores to list. Format: `projects/*‍/locations/*‍/restorePlans/*‍/restores/*` */
1745
+ parent: string;
1746
+ /** Returns response with indentations and line breaks. */
1747
+ prettyPrint?: boolean;
1748
+ /** 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. */
1749
+ quotaUser?: string;
1750
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1751
+ upload_protocol?: string;
1752
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1753
+ uploadType?: string;
1754
+ }): Request<ListVolumeRestoresResponse>;
1755
+ /** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
1756
+ setIamPolicy(request: {
1757
+ /** V1 error format. */
1758
+ "$.xgafv"?: string;
1759
+ /** OAuth access token. */
1760
+ access_token?: string;
1761
+ /** Data format for response. */
1762
+ alt?: string;
1763
+ /** JSONP */
1764
+ callback?: string;
1765
+ /** Selector specifying which fields to include in a partial response. */
1766
+ fields?: string;
1767
+ /** 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. */
1768
+ key?: string;
1769
+ /** OAuth 2.0 token for the current user. */
1770
+ oauth_token?: string;
1771
+ /** Returns response with indentations and line breaks. */
1772
+ prettyPrint?: boolean;
1773
+ /** 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. */
1774
+ quotaUser?: string;
1775
+ /**
1776
+ * 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
1777
+ * field.
1778
+ */
1779
+ resource: string;
1780
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1781
+ upload_protocol?: string;
1782
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1783
+ uploadType?: string;
1784
+ },
1785
+ body: SetIamPolicyRequest): Request<Policy>;
1786
+ /**
1787
+ * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This
1788
+ * operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
1789
+ */
1790
+ testIamPermissions(request: {
1791
+ /** V1 error format. */
1792
+ "$.xgafv"?: string;
1793
+ /** OAuth access token. */
1794
+ access_token?: string;
1795
+ /** Data format for response. */
1796
+ alt?: string;
1797
+ /** JSONP */
1798
+ callback?: string;
1799
+ /** Selector specifying which fields to include in a partial response. */
1800
+ fields?: string;
1801
+ /** 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. */
1802
+ key?: string;
1803
+ /** OAuth 2.0 token for the current user. */
1804
+ oauth_token?: string;
1805
+ /** Returns response with indentations and line breaks. */
1806
+ prettyPrint?: boolean;
1807
+ /** 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. */
1808
+ quotaUser?: string;
1809
+ /**
1810
+ * 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
1811
+ * this field.
1812
+ */
1813
+ resource: string;
1814
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1815
+ upload_protocol?: string;
1816
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1817
+ uploadType?: string;
1818
+ },
1819
+ body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
1820
+ }
1821
+ interface RestoresResource {
1822
+ /** Creates a new Restore for the given RestorePlan. */
1823
+ create(request: {
1824
+ /** V1 error format. */
1825
+ "$.xgafv"?: string;
1826
+ /** OAuth access token. */
1827
+ access_token?: string;
1828
+ /** Data format for response. */
1829
+ alt?: string;
1830
+ /** JSONP */
1831
+ callback?: string;
1832
+ /** Selector specifying which fields to include in a partial response. */
1833
+ fields?: string;
1834
+ /** 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. */
1835
+ key?: string;
1836
+ /** OAuth 2.0 token for the current user. */
1837
+ oauth_token?: string;
1838
+ /** Required. The RestorePlan within which to create the Restore. Format: `projects/*‍/locations/*‍/restorePlans/*` */
1839
+ parent: string;
1840
+ /** Returns response with indentations and line breaks. */
1841
+ prettyPrint?: boolean;
1842
+ /** 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. */
1843
+ quotaUser?: string;
1844
+ /**
1845
+ * Required. The client-provided short name for the Restore resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters,
1846
+ * numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Restores in this RestorePlan.
1847
+ */
1848
+ restoreId?: string;
1849
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1850
+ upload_protocol?: string;
1851
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1852
+ uploadType?: string;
1853
+ /** Request body */
1854
+ resource: Restore;
1855
+ }): Request<GoogleLongrunningOperation>;
1856
+ create(request: {
1857
+ /** V1 error format. */
1858
+ "$.xgafv"?: string;
1859
+ /** OAuth access token. */
1860
+ access_token?: string;
1861
+ /** Data format for response. */
1862
+ alt?: string;
1863
+ /** JSONP */
1864
+ callback?: string;
1865
+ /** Selector specifying which fields to include in a partial response. */
1866
+ fields?: string;
1867
+ /** 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. */
1868
+ key?: string;
1869
+ /** OAuth 2.0 token for the current user. */
1870
+ oauth_token?: string;
1871
+ /** Required. The RestorePlan within which to create the Restore. Format: `projects/*‍/locations/*‍/restorePlans/*` */
1872
+ parent: string;
1873
+ /** Returns response with indentations and line breaks. */
1874
+ prettyPrint?: boolean;
1875
+ /** 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. */
1876
+ quotaUser?: string;
1877
+ /**
1878
+ * Required. The client-provided short name for the Restore resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters,
1879
+ * numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Restores in this RestorePlan.
1880
+ */
1881
+ restoreId?: string;
1882
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1883
+ upload_protocol?: string;
1884
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1885
+ uploadType?: string;
1886
+ },
1887
+ body: Restore): Request<GoogleLongrunningOperation>;
1888
+ /** Deletes an existing Restore. */
1889
+ delete(request?: {
1890
+ /** V1 error format. */
1891
+ "$.xgafv"?: string;
1892
+ /** OAuth access token. */
1893
+ access_token?: string;
1894
+ /** Data format for response. */
1895
+ alt?: string;
1896
+ /** JSONP */
1897
+ callback?: string;
1898
+ /** If provided, this value must match the current value of the target Restore's etag field or the request is rejected. */
1899
+ etag?: string;
1900
+ /** Selector specifying which fields to include in a partial response. */
1901
+ fields?: string;
1902
+ /** If set to true, any VolumeRestores below this restore will also be deleted. Otherwise, the request will only succeed if the restore has no VolumeRestores. */
1903
+ force?: boolean;
1904
+ /** 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. */
1905
+ key?: string;
1906
+ /** Required. Full name of the Restore Format: `projects/*‍/locations/*‍/restorePlans/*‍/restores/*` */
1907
+ name: string;
1908
+ /** OAuth 2.0 token for the current user. */
1909
+ oauth_token?: string;
1910
+ /** Returns response with indentations and line breaks. */
1911
+ prettyPrint?: boolean;
1912
+ /** 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. */
1913
+ quotaUser?: string;
1914
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1915
+ upload_protocol?: string;
1916
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1917
+ uploadType?: string;
1918
+ }): Request<GoogleLongrunningOperation>;
1919
+ /** Retrieves the details of a single Restore. */
1920
+ get(request?: {
1921
+ /** V1 error format. */
1922
+ "$.xgafv"?: string;
1923
+ /** OAuth access token. */
1924
+ access_token?: string;
1925
+ /** Data format for response. */
1926
+ alt?: string;
1927
+ /** JSONP */
1928
+ callback?: string;
1929
+ /** Selector specifying which fields to include in a partial response. */
1930
+ fields?: string;
1931
+ /** 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. */
1932
+ key?: string;
1933
+ /** Required. Name of the restore resource. Format: `projects/*‍/locations/*‍/restorePlans/*‍/restores/*` */
1934
+ name: string;
1935
+ /** OAuth 2.0 token for the current user. */
1936
+ oauth_token?: string;
1937
+ /** Returns response with indentations and line breaks. */
1938
+ prettyPrint?: boolean;
1939
+ /** 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. */
1940
+ quotaUser?: string;
1941
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1942
+ upload_protocol?: string;
1943
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1944
+ uploadType?: string;
1945
+ }): Request<Restore>;
1946
+ /** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
1947
+ getIamPolicy(request?: {
1948
+ /** V1 error format. */
1949
+ "$.xgafv"?: string;
1950
+ /** OAuth access token. */
1951
+ access_token?: string;
1952
+ /** Data format for response. */
1953
+ alt?: string;
1954
+ /** JSONP */
1955
+ callback?: string;
1956
+ /** Selector specifying which fields to include in a partial response. */
1957
+ fields?: string;
1958
+ /** 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. */
1959
+ key?: string;
1960
+ /** OAuth 2.0 token for the current user. */
1961
+ oauth_token?: string;
1962
+ /**
1963
+ * 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
1964
+ * 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
1965
+ * 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
1966
+ * role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM
1967
+ * documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1968
+ */
1969
+ "options.requestedPolicyVersion"?: number;
1970
+ /** Returns response with indentations and line breaks. */
1971
+ prettyPrint?: boolean;
1972
+ /** 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. */
1973
+ quotaUser?: string;
1974
+ /**
1975
+ * 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
1976
+ * field.
1977
+ */
1978
+ resource: string;
1979
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1980
+ upload_protocol?: string;
1981
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1982
+ uploadType?: string;
1983
+ }): Request<Policy>;
1984
+ /** Lists the Restores for a given RestorePlan. */
1985
+ list(request?: {
1986
+ /** V1 error format. */
1987
+ "$.xgafv"?: string;
1988
+ /** OAuth access token. */
1989
+ access_token?: string;
1990
+ /** Data format for response. */
1991
+ alt?: string;
1992
+ /** JSONP */
1993
+ callback?: string;
1994
+ /** Selector specifying which fields to include in a partial response. */
1995
+ fields?: string;
1996
+ /** Field match expression used to filter the results. */
1997
+ filter?: string;
1998
+ /** 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. */
1999
+ key?: string;
2000
+ /** OAuth 2.0 token for the current user. */
2001
+ oauth_token?: string;
2002
+ /** Field by which to sort the results. */
2003
+ orderBy?: string;
2004
+ /**
2005
+ * The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list
2006
+ * and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
2007
+ */
2008
+ pageSize?: number;
2009
+ /**
2010
+ * The value of next_page_token received from a previous `ListRestores` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all
2011
+ * other parameters provided to `ListRestores` must match the call that provided the page token.
2012
+ */
2013
+ pageToken?: string;
2014
+ /** Required. The RestorePlan that contains the Restores to list. Format: `projects/*‍/locations/*‍/restorePlans/*` */
2015
+ parent: string;
2016
+ /** Returns response with indentations and line breaks. */
2017
+ prettyPrint?: boolean;
2018
+ /** 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. */
2019
+ quotaUser?: string;
2020
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2021
+ upload_protocol?: string;
2022
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2023
+ uploadType?: string;
2024
+ }): Request<ListRestoresResponse>;
2025
+ /** Update a Restore. */
2026
+ patch(request: {
2027
+ /** V1 error format. */
2028
+ "$.xgafv"?: string;
2029
+ /** OAuth access token. */
2030
+ access_token?: string;
2031
+ /** Data format for response. */
2032
+ alt?: string;
2033
+ /** JSONP */
2034
+ callback?: string;
2035
+ /** Selector specifying which fields to include in a partial response. */
2036
+ fields?: string;
2037
+ /** 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. */
2038
+ key?: string;
2039
+ /** Output only. The full name of the Restore resource. Format: `projects/*‍/locations/*‍/restorePlans/*‍/restores/*` */
2040
+ name: string;
2041
+ /** OAuth 2.0 token for the current user. */
2042
+ oauth_token?: string;
2043
+ /** Returns response with indentations and line breaks. */
2044
+ prettyPrint?: boolean;
2045
+ /** 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. */
2046
+ quotaUser?: string;
2047
+ /**
2048
+ * This is used to specify the fields to be overwritten in the Restore targeted for update. The values for each of these updated fields will be taken from the `restore` provided
2049
+ * with this request. Field names are relative to the root of the resource. If no `update_mask` is provided, all fields in `restore` will be written to the target Restore resource.
2050
+ * Note that OUTPUT_ONLY and IMMUTABLE fields in `restore` are ignored and are not used to update the target Restore.
2051
+ */
2052
+ updateMask?: string;
2053
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2054
+ upload_protocol?: string;
2055
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2056
+ uploadType?: string;
2057
+ /** Request body */
2058
+ resource: Restore;
2059
+ }): Request<GoogleLongrunningOperation>;
2060
+ patch(request: {
2061
+ /** V1 error format. */
2062
+ "$.xgafv"?: string;
2063
+ /** OAuth access token. */
2064
+ access_token?: string;
2065
+ /** Data format for response. */
2066
+ alt?: string;
2067
+ /** JSONP */
2068
+ callback?: string;
2069
+ /** Selector specifying which fields to include in a partial response. */
2070
+ fields?: string;
2071
+ /** 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. */
2072
+ key?: string;
2073
+ /** Output only. The full name of the Restore resource. Format: `projects/*‍/locations/*‍/restorePlans/*‍/restores/*` */
2074
+ name: string;
2075
+ /** OAuth 2.0 token for the current user. */
2076
+ oauth_token?: string;
2077
+ /** Returns response with indentations and line breaks. */
2078
+ prettyPrint?: boolean;
2079
+ /** 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. */
2080
+ quotaUser?: string;
2081
+ /**
2082
+ * This is used to specify the fields to be overwritten in the Restore targeted for update. The values for each of these updated fields will be taken from the `restore` provided
2083
+ * with this request. Field names are relative to the root of the resource. If no `update_mask` is provided, all fields in `restore` will be written to the target Restore resource.
2084
+ * Note that OUTPUT_ONLY and IMMUTABLE fields in `restore` are ignored and are not used to update the target Restore.
2085
+ */
2086
+ updateMask?: string;
2087
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2088
+ upload_protocol?: string;
2089
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2090
+ uploadType?: string;
2091
+ },
2092
+ body: Restore): Request<GoogleLongrunningOperation>;
2093
+ /** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
2094
+ setIamPolicy(request: {
2095
+ /** V1 error format. */
2096
+ "$.xgafv"?: string;
2097
+ /** OAuth access token. */
2098
+ access_token?: string;
2099
+ /** Data format for response. */
2100
+ alt?: string;
2101
+ /** JSONP */
2102
+ callback?: string;
2103
+ /** Selector specifying which fields to include in a partial response. */
2104
+ fields?: string;
2105
+ /** 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. */
2106
+ key?: string;
2107
+ /** OAuth 2.0 token for the current user. */
2108
+ oauth_token?: string;
2109
+ /** Returns response with indentations and line breaks. */
2110
+ prettyPrint?: boolean;
2111
+ /** 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. */
2112
+ quotaUser?: string;
2113
+ /**
2114
+ * 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
2115
+ * field.
2116
+ */
2117
+ resource: string;
2118
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2119
+ upload_protocol?: string;
2120
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2121
+ uploadType?: string;
2122
+ },
2123
+ body: SetIamPolicyRequest): Request<Policy>;
2124
+ /**
2125
+ * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This
2126
+ * operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
2127
+ */
2128
+ testIamPermissions(request: {
2129
+ /** V1 error format. */
2130
+ "$.xgafv"?: string;
2131
+ /** OAuth access token. */
2132
+ access_token?: string;
2133
+ /** Data format for response. */
2134
+ alt?: string;
2135
+ /** JSONP */
2136
+ callback?: string;
2137
+ /** Selector specifying which fields to include in a partial response. */
2138
+ fields?: string;
2139
+ /** 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. */
2140
+ key?: string;
2141
+ /** OAuth 2.0 token for the current user. */
2142
+ oauth_token?: string;
2143
+ /** Returns response with indentations and line breaks. */
2144
+ prettyPrint?: boolean;
2145
+ /** 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. */
2146
+ quotaUser?: string;
2147
+ /**
2148
+ * 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
2149
+ * this field.
2150
+ */
2151
+ resource: string;
2152
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2153
+ upload_protocol?: string;
2154
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2155
+ uploadType?: string;
2156
+ },
2157
+ body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
2158
+ volumeRestores: VolumeRestoresResource;
2159
+ }
2160
+ interface RestorePlansResource {
2161
+ /** Creates a new RestorePlan in a given location. */
2162
+ create(request: {
2163
+ /** V1 error format. */
2164
+ "$.xgafv"?: string;
2165
+ /** OAuth access token. */
2166
+ access_token?: string;
2167
+ /** Data format for response. */
2168
+ alt?: string;
2169
+ /** JSONP */
2170
+ callback?: string;
2171
+ /** Selector specifying which fields to include in a partial response. */
2172
+ fields?: string;
2173
+ /** 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. */
2174
+ key?: string;
2175
+ /** OAuth 2.0 token for the current user. */
2176
+ oauth_token?: string;
2177
+ /** Required. The location within which to create the RestorePlan. Format: `projects/*‍/locations/*` */
2178
+ parent: string;
2179
+ /** Returns response with indentations and line breaks. */
2180
+ prettyPrint?: boolean;
2181
+ /** 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. */
2182
+ quotaUser?: string;
2183
+ /**
2184
+ * Required. The client-provided short name for the RestorePlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII
2185
+ * letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of RestorePlans in this location
2186
+ */
2187
+ restorePlanId?: string;
2188
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2189
+ upload_protocol?: string;
2190
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2191
+ uploadType?: string;
2192
+ /** Request body */
2193
+ resource: RestorePlan;
2194
+ }): Request<GoogleLongrunningOperation>;
2195
+ create(request: {
2196
+ /** V1 error format. */
2197
+ "$.xgafv"?: string;
2198
+ /** OAuth access token. */
2199
+ access_token?: string;
2200
+ /** Data format for response. */
2201
+ alt?: string;
2202
+ /** JSONP */
2203
+ callback?: string;
2204
+ /** Selector specifying which fields to include in a partial response. */
2205
+ fields?: string;
2206
+ /** 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. */
2207
+ key?: string;
2208
+ /** OAuth 2.0 token for the current user. */
2209
+ oauth_token?: string;
2210
+ /** Required. The location within which to create the RestorePlan. Format: `projects/*‍/locations/*` */
2211
+ parent: string;
2212
+ /** Returns response with indentations and line breaks. */
2213
+ prettyPrint?: boolean;
2214
+ /** 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. */
2215
+ quotaUser?: string;
2216
+ /**
2217
+ * Required. The client-provided short name for the RestorePlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII
2218
+ * letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of RestorePlans in this location
2219
+ */
2220
+ restorePlanId?: string;
2221
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2222
+ upload_protocol?: string;
2223
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2224
+ uploadType?: string;
2225
+ },
2226
+ body: RestorePlan): Request<GoogleLongrunningOperation>;
2227
+ /** Deletes an existing RestorePlan. */
2228
+ delete(request?: {
2229
+ /** V1 error format. */
2230
+ "$.xgafv"?: string;
2231
+ /** OAuth access token. */
2232
+ access_token?: string;
2233
+ /** Data format for response. */
2234
+ alt?: string;
2235
+ /** JSONP */
2236
+ callback?: string;
2237
+ /** If provided, this value must match the current value of the target RestorePlan's etag field or the request is rejected. */
2238
+ etag?: string;
2239
+ /** Selector specifying which fields to include in a partial response. */
2240
+ fields?: string;
2241
+ /** If set to true, any Restores below this RestorePlan will also be deleted. Otherwise, the request will only succeed if the RestorePlan has no Restores. */
2242
+ force?: boolean;
2243
+ /** 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. */
2244
+ key?: string;
2245
+ /** Required. Fully qualified RestorePlan name. Format: `projects/*‍/locations/*‍/restorePlans/*` */
2246
+ name: string;
2247
+ /** OAuth 2.0 token for the current user. */
2248
+ oauth_token?: string;
2249
+ /** Returns response with indentations and line breaks. */
2250
+ prettyPrint?: boolean;
2251
+ /** 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. */
2252
+ quotaUser?: string;
2253
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2254
+ upload_protocol?: string;
2255
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2256
+ uploadType?: string;
2257
+ }): Request<GoogleLongrunningOperation>;
2258
+ /** Retrieve the details of a single RestorePlan. */
2259
+ get(request?: {
2260
+ /** V1 error format. */
2261
+ "$.xgafv"?: string;
2262
+ /** OAuth access token. */
2263
+ access_token?: string;
2264
+ /** Data format for response. */
2265
+ alt?: string;
2266
+ /** JSONP */
2267
+ callback?: string;
2268
+ /** Selector specifying which fields to include in a partial response. */
2269
+ fields?: string;
2270
+ /** 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. */
2271
+ key?: string;
2272
+ /** Required. Fully qualified RestorePlan name. Format: `projects/*‍/locations/*‍/restorePlans/*` */
2273
+ name: string;
2274
+ /** OAuth 2.0 token for the current user. */
2275
+ oauth_token?: string;
2276
+ /** Returns response with indentations and line breaks. */
2277
+ prettyPrint?: boolean;
2278
+ /** 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. */
2279
+ quotaUser?: string;
2280
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2281
+ upload_protocol?: string;
2282
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2283
+ uploadType?: string;
2284
+ }): Request<RestorePlan>;
2285
+ /** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
2286
+ getIamPolicy(request?: {
2287
+ /** V1 error format. */
2288
+ "$.xgafv"?: string;
2289
+ /** OAuth access token. */
2290
+ access_token?: string;
2291
+ /** Data format for response. */
2292
+ alt?: string;
2293
+ /** JSONP */
2294
+ callback?: string;
2295
+ /** Selector specifying which fields to include in a partial response. */
2296
+ fields?: string;
2297
+ /** 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. */
2298
+ key?: string;
2299
+ /** OAuth 2.0 token for the current user. */
2300
+ oauth_token?: string;
2301
+ /**
2302
+ * 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
2303
+ * 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
2304
+ * 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
2305
+ * role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM
2306
+ * documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2307
+ */
2308
+ "options.requestedPolicyVersion"?: number;
2309
+ /** Returns response with indentations and line breaks. */
2310
+ prettyPrint?: boolean;
2311
+ /** 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. */
2312
+ quotaUser?: string;
2313
+ /**
2314
+ * 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
2315
+ * field.
2316
+ */
2317
+ resource: string;
2318
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2319
+ upload_protocol?: string;
2320
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2321
+ uploadType?: string;
2322
+ }): Request<Policy>;
2323
+ /** Lists RestorePlans in a given location. */
2324
+ list(request?: {
2325
+ /** V1 error format. */
2326
+ "$.xgafv"?: string;
2327
+ /** OAuth access token. */
2328
+ access_token?: string;
2329
+ /** Data format for response. */
2330
+ alt?: string;
2331
+ /** JSONP */
2332
+ callback?: string;
2333
+ /** Selector specifying which fields to include in a partial response. */
2334
+ fields?: string;
2335
+ /** Field match expression used to filter the results. */
2336
+ filter?: string;
2337
+ /** 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. */
2338
+ key?: string;
2339
+ /** OAuth 2.0 token for the current user. */
2340
+ oauth_token?: string;
2341
+ /** Field by which to sort the results. */
2342
+ orderBy?: string;
2343
+ /**
2344
+ * The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list
2345
+ * and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
2346
+ */
2347
+ pageSize?: number;
2348
+ /**
2349
+ * The value of next_page_token received from a previous `ListRestorePlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all
2350
+ * other parameters provided to `ListRestorePlans` must match the call that provided the page token.
2351
+ */
2352
+ pageToken?: string;
2353
+ /** Required. The location that contains the RestorePlans to list. Format: `projects/*‍/locations/*` */
2354
+ parent: string;
2355
+ /** Returns response with indentations and line breaks. */
2356
+ prettyPrint?: boolean;
2357
+ /** 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. */
2358
+ quotaUser?: string;
2359
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2360
+ upload_protocol?: string;
2361
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2362
+ uploadType?: string;
2363
+ }): Request<ListRestorePlansResponse>;
2364
+ /** Update a RestorePlan. */
2365
+ patch(request: {
2366
+ /** V1 error format. */
2367
+ "$.xgafv"?: string;
2368
+ /** OAuth access token. */
2369
+ access_token?: string;
2370
+ /** Data format for response. */
2371
+ alt?: string;
2372
+ /** JSONP */
2373
+ callback?: string;
2374
+ /** Selector specifying which fields to include in a partial response. */
2375
+ fields?: string;
2376
+ /** 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. */
2377
+ key?: string;
2378
+ /** Output only. The full name of the RestorePlan resource. Format: `projects/*‍/locations/*‍/restorePlans/*`. */
2379
+ name: string;
2380
+ /** OAuth 2.0 token for the current user. */
2381
+ oauth_token?: string;
2382
+ /** Returns response with indentations and line breaks. */
2383
+ prettyPrint?: boolean;
2384
+ /** 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. */
2385
+ quotaUser?: string;
2386
+ /**
2387
+ * This is used to specify the fields to be overwritten in the RestorePlan targeted for update. The values for each of these updated fields will be taken from the `restore_plan`
2388
+ * provided with this request. Field names are relative to the root of the resource. If no `update_mask` is provided, all fields in `restore_plan` will be written to the target
2389
+ * RestorePlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `restore_plan` are ignored and are not used to update the target RestorePlan.
2390
+ */
2391
+ updateMask?: string;
2392
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2393
+ upload_protocol?: string;
2394
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2395
+ uploadType?: string;
2396
+ /** Request body */
2397
+ resource: RestorePlan;
2398
+ }): Request<GoogleLongrunningOperation>;
2399
+ patch(request: {
2400
+ /** V1 error format. */
2401
+ "$.xgafv"?: string;
2402
+ /** OAuth access token. */
2403
+ access_token?: string;
2404
+ /** Data format for response. */
2405
+ alt?: string;
2406
+ /** JSONP */
2407
+ callback?: string;
2408
+ /** Selector specifying which fields to include in a partial response. */
2409
+ fields?: string;
2410
+ /** 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. */
2411
+ key?: string;
2412
+ /** Output only. The full name of the RestorePlan resource. Format: `projects/*‍/locations/*‍/restorePlans/*`. */
2413
+ name: string;
2414
+ /** OAuth 2.0 token for the current user. */
2415
+ oauth_token?: string;
2416
+ /** Returns response with indentations and line breaks. */
2417
+ prettyPrint?: boolean;
2418
+ /** 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. */
2419
+ quotaUser?: string;
2420
+ /**
2421
+ * This is used to specify the fields to be overwritten in the RestorePlan targeted for update. The values for each of these updated fields will be taken from the `restore_plan`
2422
+ * provided with this request. Field names are relative to the root of the resource. If no `update_mask` is provided, all fields in `restore_plan` will be written to the target
2423
+ * RestorePlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `restore_plan` are ignored and are not used to update the target RestorePlan.
2424
+ */
2425
+ updateMask?: string;
2426
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2427
+ upload_protocol?: string;
2428
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2429
+ uploadType?: string;
2430
+ },
2431
+ body: RestorePlan): Request<GoogleLongrunningOperation>;
2432
+ /** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
2433
+ setIamPolicy(request: {
2434
+ /** V1 error format. */
2435
+ "$.xgafv"?: string;
2436
+ /** OAuth access token. */
2437
+ access_token?: string;
2438
+ /** Data format for response. */
2439
+ alt?: string;
2440
+ /** JSONP */
2441
+ callback?: string;
2442
+ /** Selector specifying which fields to include in a partial response. */
2443
+ fields?: string;
2444
+ /** 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. */
2445
+ key?: string;
2446
+ /** OAuth 2.0 token for the current user. */
2447
+ oauth_token?: string;
2448
+ /** Returns response with indentations and line breaks. */
2449
+ prettyPrint?: boolean;
2450
+ /** 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. */
2451
+ quotaUser?: string;
2452
+ /**
2453
+ * 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
2454
+ * field.
2455
+ */
2456
+ resource: string;
2457
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2458
+ upload_protocol?: string;
2459
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2460
+ uploadType?: string;
2461
+ },
2462
+ body: SetIamPolicyRequest): Request<Policy>;
2463
+ /**
2464
+ * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This
2465
+ * operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
2466
+ */
2467
+ testIamPermissions(request: {
2468
+ /** V1 error format. */
2469
+ "$.xgafv"?: string;
2470
+ /** OAuth access token. */
2471
+ access_token?: string;
2472
+ /** Data format for response. */
2473
+ alt?: string;
2474
+ /** JSONP */
2475
+ callback?: string;
2476
+ /** Selector specifying which fields to include in a partial response. */
2477
+ fields?: string;
2478
+ /** 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. */
2479
+ key?: string;
2480
+ /** OAuth 2.0 token for the current user. */
2481
+ oauth_token?: string;
2482
+ /** Returns response with indentations and line breaks. */
2483
+ prettyPrint?: boolean;
2484
+ /** 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. */
2485
+ quotaUser?: string;
2486
+ /**
2487
+ * 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
2488
+ * this field.
2489
+ */
2490
+ resource: string;
2491
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2492
+ upload_protocol?: string;
2493
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2494
+ uploadType?: string;
2495
+ },
2496
+ body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
2497
+ restores: RestoresResource;
2498
+ }
2499
+ interface LocationsResource {
2500
+ /**
2501
+ * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't
2502
+ * support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
2503
+ */
2504
+ deleteOperations(request?: {
2505
+ /** V1 error format. */
2506
+ "$.xgafv"?: string;
2507
+ /** OAuth access token. */
2508
+ access_token?: string;
2509
+ /** Data format for response. */
2510
+ alt?: string;
2511
+ /** JSONP */
2512
+ callback?: string;
2513
+ /** Selector specifying which fields to include in a partial response. */
2514
+ fields?: string;
2515
+ /** 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. */
2516
+ key?: string;
2517
+ /** The name of the operation resource to be deleted. */
2518
+ name: string;
2519
+ /** OAuth 2.0 token for the current user. */
2520
+ oauth_token?: string;
2521
+ /** Returns response with indentations and line breaks. */
2522
+ prettyPrint?: boolean;
2523
+ /** 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. */
2524
+ quotaUser?: string;
2525
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2526
+ upload_protocol?: string;
2527
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2528
+ uploadType?: string;
2529
+ }): Request<{}>;
2530
+ /** Gets information about a location. */
2531
+ get(request?: {
2532
+ /** V1 error format. */
2533
+ "$.xgafv"?: string;
2534
+ /** OAuth access token. */
2535
+ access_token?: string;
2536
+ /** Data format for response. */
2537
+ alt?: string;
2538
+ /** JSONP */
2539
+ callback?: string;
2540
+ /** Selector specifying which fields to include in a partial response. */
2541
+ fields?: string;
2542
+ /** 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. */
2543
+ key?: string;
2544
+ /** Resource name for the location. */
2545
+ name: string;
2546
+ /** OAuth 2.0 token for the current user. */
2547
+ oauth_token?: string;
2548
+ /** Returns response with indentations and line breaks. */
2549
+ prettyPrint?: boolean;
2550
+ /** 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. */
2551
+ quotaUser?: string;
2552
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2553
+ upload_protocol?: string;
2554
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2555
+ uploadType?: string;
2556
+ }): Request<Location>;
2557
+ /** Lists information about the supported locations for this service. */
2558
+ list(request?: {
2559
+ /** V1 error format. */
2560
+ "$.xgafv"?: string;
2561
+ /** OAuth access token. */
2562
+ access_token?: string;
2563
+ /** Data format for response. */
2564
+ alt?: string;
2565
+ /** JSONP */
2566
+ callback?: string;
2567
+ /** Selector specifying which fields to include in a partial response. */
2568
+ fields?: string;
2569
+ /**
2570
+ * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in
2571
+ * [AIP-160](https://google.aip.dev/160).
2572
+ */
2573
+ filter?: string;
2574
+ /** 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. */
2575
+ key?: string;
2576
+ /** The resource that owns the locations collection, if applicable. */
2577
+ name: string;
2578
+ /** OAuth 2.0 token for the current user. */
2579
+ oauth_token?: string;
2580
+ /** The maximum number of results to return. If not set, the service selects a default. */
2581
+ pageSize?: number;
2582
+ /** A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. */
2583
+ pageToken?: string;
2584
+ /** Returns response with indentations and line breaks. */
2585
+ prettyPrint?: boolean;
2586
+ /** 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. */
2587
+ quotaUser?: string;
2588
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2589
+ upload_protocol?: string;
2590
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2591
+ uploadType?: string;
2592
+ }): Request<ListLocationsResponse>;
2593
+ backupPlans: BackupPlansResource;
2594
+ operations: OperationsResource;
2595
+ restorePlans: RestorePlansResource;
2596
+ }
2597
+ interface ProjectsResource {
2598
+ locations: LocationsResource;
2599
+ }
2600
+
2601
+ const projects: ProjectsResource;
2602
+ }
2603
+ }