googleapis
Version:
Google APIs Client Library for Node.js
876 lines (875 loc) • 171 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace gkebackup_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Backup for GKE API
*
* Backup for GKE is a managed Kubernetes workload backup and restore service for GKE clusters.
*
* @example
* ```js
* const {google} = require('googleapis');
* const gkebackup = google.gkebackup('v1');
* ```
*/
export class Gkebackup {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
*/
export interface Schema$AuditConfig {
/**
* The configuration for logging of each type of permission.
*/
auditLogConfigs?: Schema$AuditLogConfig[];
/**
* Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
*/
service?: string | null;
}
/**
* Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \} ] \} This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
*/
export interface Schema$AuditLogConfig {
/**
* Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
*/
exemptedMembers?: string[] | null;
/**
* The log type that this config enables.
*/
logType?: string | null;
}
/**
* Represents a request to perform a single point-in-time capture of some portion of the state of a GKE cluster, the record of the backup operation itself, and an anchor for the underlying artifacts that comprise the Backup (the config backup and VolumeBackups). Next id: 29
*/
export interface Schema$Backup {
/**
* Output only. If True, all namespaces were included in the Backup.
*/
allNamespaces?: boolean | null;
/**
* Output only. Information about the GKE cluster from which this Backup was created.
*/
clusterMetadata?: Schema$ClusterMetadata;
/**
* Output only. Completion time of the Backup
*/
completeTime?: string | null;
/**
* Output only. The size of the config backup in bytes.
*/
configBackupSizeBytes?: string | null;
/**
* Output only. Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.
*/
containsSecrets?: boolean | null;
/**
* Output only. Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.
*/
containsVolumeData?: boolean | null;
/**
* Output only. The timestamp when this Backup resource was created.
*/
createTime?: string | null;
/**
* Optional. 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 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 may only be increased (either at creation time or in a subsequent update).
*/
deleteLockDays?: number | null;
/**
* Output only. The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days).
*/
deleteLockExpireTime?: string | null;
/**
* Optional. User specified descriptive string for this Backup.
*/
description?: string | null;
/**
* 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.
*/
encryptionKey?: Schema$EncryptionKey;
/**
* 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 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 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.
*/
etag?: string | null;
/**
* Optional. A set of custom labels supplied by user.
*/
labels?: {
[key: string]: string;
} | null;
/**
* 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 manually.
*/
manual?: boolean | null;
/**
* Output only. The fully qualified name of the Backup. `projects/x/locations/x/backupPlans/x/backups/x`
*/
name?: string | null;
/**
* Output only. The total number of Kubernetes Pods contained in the Backup.
*/
podCount?: number | null;
/**
* Output only. The total number of Kubernetes resources included in the Backup.
*/
resourceCount?: number | null;
/**
* Optional. 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 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.
*/
retainDays?: number | null;
/**
* Output only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days).
*/
retainExpireTime?: string | null;
/**
* Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.
*/
selectedApplications?: Schema$NamespacedNames;
/**
* Output only. If set, the list of namespaces that were included in the Backup.
*/
selectedNamespaces?: Schema$Namespaces;
/**
* Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes)
*/
sizeBytes?: string | null;
/**
* Output only. Current state of the Backup
*/
state?: string | null;
/**
* Output only. Human-readable description of why the backup is in the current `state`.
*/
stateReason?: string | null;
/**
* Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)
*/
uid?: string | null;
/**
* Output only. The timestamp when this Backup resource was last updated.
*/
updateTime?: string | null;
/**
* Output only. The total number of volume backups contained in the Backup.
*/
volumeCount?: number | null;
}
/**
* BackupConfig defines the configuration of Backups created via this BackupPlan.
*/
export interface Schema$BackupConfig {
/**
* If True, include all namespaced resources
*/
allNamespaces?: boolean | null;
/**
* Optional. 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 backup artifacts will not be encrypted.
*/
encryptionKey?: Schema$EncryptionKey;
/**
* Optional. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False
*/
includeSecrets?: boolean | null;
/**
* Optional. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
*/
includeVolumeData?: boolean | null;
/**
* If set, include just the resources referenced by the listed ProtectedApplications.
*/
selectedApplications?: Schema$NamespacedNames;
/**
* If set, include just the resources in the listed namespaces.
*/
selectedNamespaces?: Schema$Namespaces;
}
/**
* Defines the configuration and scheduling for a "line" of Backups.
*/
export interface Schema$BackupPlan {
/**
* Optional. Defines the configuration of Backups created via this BackupPlan.
*/
backupConfig?: Schema$BackupConfig;
/**
* Optional. Defines a schedule for automatic Backup creation via this BackupPlan.
*/
backupSchedule?: Schema$Schedule;
/**
* Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - `projects/x/locations/x/clusters/x` - `projects/x/zones/x/clusters/x`
*/
cluster?: string | null;
/**
* Output only. The timestamp when this BackupPlan resource was created.
*/
createTime?: string | null;
/**
* Optional. 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), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False
*/
deactivated?: boolean | null;
/**
* Optional. User specified descriptive string for this BackupPlan.
*/
description?: string | null;
/**
* 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 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 `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 of the resource.
*/
etag?: string | null;
/**
* Optional. A set of custom labels supplied by user.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Output only. The full name of the BackupPlan resource. Format: `projects/x/locations/x/backupPlans/x`
*/
name?: string | null;
/**
* Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
*/
protectedPodCount?: number | null;
/**
* Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
*/
retentionPolicy?: Schema$RetentionPolicy;
/**
* Output only. State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update
*/
state?: string | null;
/**
* Output only. Human-readable description of why BackupPlan is in the current `state`
*/
stateReason?: string | null;
/**
* Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
*/
uid?: string | null;
/**
* Output only. The timestamp when this BackupPlan resource was last updated.
*/
updateTime?: string | null;
}
/**
* Associates `members`, or principals, with a `role`.
*/
export interface Schema$Binding {
/**
* The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
condition?: Schema$Expr;
/**
* Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding.
*/
members?: string[] | null;
/**
* Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
*/
role?: string | null;
}
/**
* Information about the GKE cluster from which this Backup was created.
*/
export interface Schema$ClusterMetadata {
/**
* Output only. Anthos version
*/
anthosVersion?: string | null;
/**
* Output only. A list of the Backup for GKE CRD versions found in the cluster.
*/
backupCrdVersions?: {
[key: string]: string;
} | null;
/**
* Output only. The source cluster from which this Backup was created. Valid formats: - `projects/x/locations/x/clusters/x` - `projects/x/zones/x/clusters/x` This is inherited from the parent BackupPlan's cluster field.
*/
cluster?: string | null;
/**
* Output only. GKE version
*/
gkeVersion?: string | null;
/**
* Output only. The Kubernetes server version of the source cluster.
*/
k8sVersion?: string | null;
}
/**
* Defines the scope of cluster-scoped resources to restore. Some group kinds are not reasonable choices for a restore, and will cause an error if selected here. Any scope selection that would restore "all valid" resources automatically excludes these group kinds. - gkebackup.gke.io/BackupJob - gkebackup.gke.io/RestoreJob - metrics.k8s.io/NodeMetrics - migration.k8s.io/StorageState - migration.k8s.io/StorageVersionMigration - Node - snapshot.storage.k8s.io/VolumeSnapshotContent - storage.k8s.io/CSINode Some group kinds are driven by restore configuration elsewhere, and will cause an error if selected here. - Namespace - PersistentVolume
*/
export interface Schema$ClusterResourceRestoreScope {
/**
* Optional. If True, all valid cluster-scoped resources will be restored. Mutually exclusive to any other field in the message.
*/
allGroupKinds?: boolean | null;
/**
* Optional. A list of cluster-scoped resource group kinds to NOT restore from the backup. If specified, all valid cluster-scoped resources will be restored except for those specified in the list. Mutually exclusive to any other field in the message.
*/
excludedGroupKinds?: Schema$GroupKind[];
/**
* Optional. If True, no cluster-scoped resources will be restored. This has the same restore scope as if the message is not defined. Mutually exclusive to any other field in the message.
*/
noGroupKinds?: boolean | null;
/**
* Optional. A list of cluster-scoped resource group kinds to restore from the backup. If specified, only the selected resources will be restored. Mutually exclusive to any other field in the message.
*/
selectedGroupKinds?: Schema$GroupKind[];
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
*/
export interface Schema$Empty {
}
/**
* Defined a customer managed encryption key that will be used to encrypt Backup artifacts.
*/
export interface Schema$EncryptionKey {
/**
* Optional. Google Cloud KMS encryption key. Format: `projects/x/locations/x/keyRings/x/cryptoKeys/x`
*/
gcpKmsEncryptionKey?: string | null;
}
/**
* Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
*/
export interface Schema$Expr {
/**
* Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
*/
description?: string | null;
/**
* Textual representation of an expression in Common Expression Language syntax.
*/
expression?: string | null;
/**
* Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string | null;
/**
* Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
*/
title?: string | null;
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$GoogleLongrunningCancelOperationRequest {
}
/**
* The response message for Operations.ListOperations.
*/
export interface Schema$GoogleLongrunningListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$GoogleLongrunningOperation[];
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$GoogleLongrunningOperation {
/**
* If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$GoogleRpcStatus;
/**
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`.
*/
name?: string | null;
/**
* The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {
[key: string]: any;
} | null;
}
/**
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$GoogleRpcStatus {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string | null;
}
/**
* This is a direct map to the Kubernetes GroupKind type [GroupKind](https://godoc.org/k8s.io/apimachinery/pkg/runtime/schema#GroupKind) and is used for identifying specific "types" of resources to restore.
*/
export interface Schema$GroupKind {
/**
* Optional. API group string of a Kubernetes resource, e.g. "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string for core API group
*/
resourceGroup?: string | null;
/**
* Optional. Kind of a Kubernetes resource, e.g. "CustomResourceDefinition", "StorageClass", etc.
*/
resourceKind?: string | null;
}
/**
* Response message for ListBackupPlans.
*/
export interface Schema$ListBackupPlansResponse {
/**
* The list of BackupPlans matching the given criteria.
*/
backupPlans?: Schema$BackupPlan[];
/**
* 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 results to return.
*/
nextPageToken?: string | null;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response message for ListBackups.
*/
export interface Schema$ListBackupsResponse {
/**
* The list of Backups matching the given criteria.
*/
backups?: Schema$Backup[];
/**
* 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 return.
*/
nextPageToken?: string | null;
}
/**
* The response message for Locations.ListLocations.
*/
export interface Schema$ListLocationsResponse {
/**
* A list of locations that matches the specified filter in the request.
*/
locations?: Schema$Location[];
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
}
/**
* Response message for ListRestorePlans.
*/
export interface Schema$ListRestorePlansResponse {
/**
* 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 results to return.
*/
nextPageToken?: string | null;
/**
* The list of RestorePlans matching the given criteria.
*/
restorePlans?: Schema$RestorePlan[];
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response message for ListRestores.
*/
export interface Schema$ListRestoresResponse {
/**
* 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 to return.
*/
nextPageToken?: string | null;
/**
* The list of Restores matching the given criteria.
*/
restores?: Schema$Restore[];
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response message for ListVolumeBackups.
*/
export interface Schema$ListVolumeBackupsResponse {
/**
* 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 results to return.
*/
nextPageToken?: string | null;
/**
* The list of VolumeBackups matching the given criteria.
*/
volumeBackups?: Schema$VolumeBackup[];
}
/**
* Response message for ListVolumeRestores.
*/
export interface Schema$ListVolumeRestoresResponse {
/**
* 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 results to return.
*/
nextPageToken?: string | null;
/**
* The list of VolumeRestores matching the given criteria.
*/
volumeRestores?: Schema$VolumeRestore[];
}
/**
* A resource that represents a Google Cloud location.
*/
export interface Schema$Location {
/**
* The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string | null;
/**
* Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\}
*/
labels?: {
[key: string]: string;
} | null;
/**
* The canonical id for this location. For example: `"us-east1"`.
*/
locationId?: string | null;
/**
* Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
*/
name?: string | null;
}
/**
* A reference to a namespaced resource in Kubernetes.
*/
export interface Schema$NamespacedName {
/**
* Optional. The name of the Kubernetes resource.
*/
name?: string | null;
/**
* Optional. The Namespace of the Kubernetes resource.
*/
namespace?: string | null;
}
/**
* A list of namespaced Kubernetes resources.
*/
export interface Schema$NamespacedNames {
/**
* Optional. A list of namespaced Kubernetes resources.
*/
namespacedNames?: Schema$NamespacedName[];
}
/**
* A list of Kubernetes Namespaces
*/
export interface Schema$Namespaces {
/**
* Optional. A list of Kubernetes Namespaces
*/
namespaces?: string[] | null;
}
/**
* Represents the metadata of the long-running operation.
*/
export interface Schema$OperationMetadata {
/**
* Output only. API version used to start the operation.
*/
apiVersion?: string | null;
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
*/
requestedCancellation?: boolean | null;
/**
* Output only. Human-readable status of the operation, if any.
*/
statusMessage?: string | null;
/**
* Output only. Server-defined resource path for the target of the operation.
*/
target?: string | null;
/**
* Output only. Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
*/
export interface Schema$Policy {
/**
* Specifies cloud audit logging configuration for this policy.
*/
auditConfigs?: Schema$AuditConfig[];
/**
* Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
*/
bindings?: Schema$Binding[];
/**
* `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
*/
etag?: string | null;
/**
* Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
version?: number | null;
}
/**
* ResourceFilter specifies matching criteria to limit the scope of a change to a specific set of kubernetes resources that are selected for restoration from a backup.
*/
export interface Schema$ResourceFilter {
/**
* Optional. (Filtering parameter) Any resource subject to transformation must belong to one of the listed "types". If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for transformation).
*/
groupKinds?: Schema$GroupKind[];
/**
* Optional. This is a [JSONPath] (https://github.com/json-path/JsonPath/blob/master/README.md) expression that matches specific fields of candidate resources and it operates as a filtering parameter (resources that are not matched with this expression will not be candidates for transformation).
*/
jsonPath?: string | null;
/**
* Optional. (Filtering parameter) Any resource subject to transformation must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for transformation). To mix cluster-scoped and namespaced resources in the same rule, use an empty string ("") as one of the target namespaces.
*/
namespaces?: string[] | null;
}
/**
* Represents both a request to Restore some portion of a Backup into a target GKE cluster and a record of the restore operation itself. Next id: 18
*/
export interface Schema$Restore {
/**
* 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 backup_plan. Format: `projects/x/locations/x/backupPlans/x/backups/x`.
*/
backup?: string | null;
/**
* Output only. The target cluster into which this Restore will restore data. Valid formats: - `projects/x/locations/x/clusters/x` - `projects/x/zones/x/clusters/x` Inherited from parent RestorePlan's cluster value.
*/
cluster?: string | null;
/**
* Output only. Timestamp of when the restore operation completed.
*/
completeTime?: string | null;
/**
* Output only. The timestamp when this Restore resource was created.
*/
createTime?: string | null;
/**
* User specified descriptive string for this Restore.
*/
description?: string | null;
/**
* 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 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`, 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.
*/
etag?: string | null;
/**
* A set of custom labels supplied by user.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Output only. The full name of the Restore resource. Format: `projects/x/locations/x/restorePlans/x/restores/x`
*/
name?: string | null;
/**
* Output only. Number of resources excluded during the restore execution.
*/
resourcesExcludedCount?: number | null;
/**
* Output only. Number of resources that failed to be restored during the restore execution.
*/
resourcesFailedCount?: number | null;
/**
* Output only. Number of resources restored during the restore execution.
*/
resourcesRestoredCount?: number | null;
/**
* Output only. Configuration of the Restore. Inherited from parent RestorePlan's restore_config.
*/
restoreConfig?: Schema$RestoreConfig;
/**
* Output only. The current state of the Restore.
*/
state?: string | null;
/**
* Output only. Human-readable description of why the Restore is in its current state.
*/
stateReason?: string | null;
/**
* Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
*/
uid?: string | null;
/**
* Output only. The timestamp when this Restore resource was last updated.
*/
updateTime?: string | null;
/**
* Output only. Number of volumes restored during the restore execution.
*/
volumesRestoredCount?: number | null;
}
/**
* Configuration of a restore. Next id: 12
*/
export interface Schema$RestoreConfig {
/**
* Restore all namespaced resources in the Backup if set to "True". Specifying this field to "False" is an error.
*/
allNamespaces?: boolean | null;
/**
* Optional. 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 CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED if cluster_resource_restore_scope is not empty.
*/
clusterResourceConflictPolicy?: string | null;
/**
* Optional. Identifies the cluster-scoped resources to restore from the Backup. Not specifying it means NO cluster resource will be restored.
*/
clusterResourceRestoreScope?: Schema$ClusterResourceRestoreScope;
/**
* A list of selected namespaces excluded from restoration. All namespaces except those in this list will be restored.
*/
excludedNamespaces?: Schema$Namespaces;
/**
* Optional. 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 NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED.
*/
namespacedResourceRestoreMode?: string | null;
/**
* Do not restore any namespaced resources if set to "True". Specifying this field to "False" is not allowed.
*/
noNamespaces?: boolean | null;
/**
* A list of selected ProtectedApplications to restore. The listed ProtectedApplications and all the resources to which they refer will be restored.
*/
selectedApplications?: Schema$NamespacedNames;
/**
* A list of selected Namespaces to restore from the Backup. The listed Namespaces and all resources contained in them will be restored.
*/
selectedNamespaces?: Schema$Namespaces;
/**
* Optional. 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 matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no substitution will occur.
*/
substitutionRules?: Schema$SubstitutionRule[];
/**
* Optional. 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 matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no transformation will occur.
*/
transformationRules?: Schema$TransformationRule[];
/**
* Optional. Specifies the mechanism to be used to restore volume data. Default: VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED (will be treated as NO_VOLUME_DATA_RESTORATION).
*/
volumeDataRestorePolicy?: string | null;
}
/**
* The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan. Next id: 13
*/
export interface Schema$RestorePlan {
/**
* Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: `projects/x/locations/x/backupPlans/x`.
*/
backupPlan?: string | null;
/**
* 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 formats: - `projects/x/locations/x/clusters/x` - `projects/x/zones/x/clusters/x`
*/
cluster?: string | null;
/**
* Output only. The timestamp when this RestorePlan resource was created.
*/
createTime?: string | null;
/**
* Optional. User specified descriptive string for this RestorePlan.
*/
description?: string | null;
/**
* 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 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 `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 version of the resource.
*/
etag?: string | null;
/**
* Optional. A set of custom labels supplied by user.
*/
labels?: {