googleapis/build/src/apis/gkebackup/v1.d.ts

Google APIs Client Library for Node.js

import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, 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).
     */
    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. If false, Backup will fail when Backup for GKE detects Kubernetes configuration that is non-standard or requires additional setup to restore. Inherited from the parent BackupPlan's permissive_mode value.
         */
        permissiveMode?: boolean | 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. [Output Only] Reserved for future use.
         */
        satisfiesPzi?: boolean | null;
        /**
         * Output only. [Output Only] Reserved for future use.
         */
        satisfiesPzs?: boolean | 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 labels whose constituent namespaces were included in the Backup.
         */
        selectedNamespaceLabels?: Schema$ResourceLabels;
        /**
         * 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`. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.
         */
        stateReason?: string | null;
        /**
         * Output only. Information about the troubleshooting steps which will provide debugging information to the end users.
         */
        troubleshootingInfo?: Schema$TroubleshootingInfo;
        /**
         * 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;
    }
    /**
     * A BackupChannel imposes constraints on where clusters can be backed up. The BackupChannel should be in the same project and region as the cluster being backed up. The backup can be created only in destination_project.
     */
    export interface Schema$BackupChannel {
        /**
         * Output only. The timestamp when this BackupChannel resource was created.
         */
        createTime?: string | null;
        /**
         * Optional. User specified descriptive string for this BackupChannel.
         */
        description?: string | null;
        /**
         * Required. Immutable. The project where Backups are allowed to be stored. The format is `projects/{projectId\}` or `projects/{projectNumber\}`.
         */
        destinationProject?: string | null;
        /**
         * Output only. The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id". This will be an OUTPUT_ONLY field to return the project_id of the destination project.
         */
        destinationProjectId?: string | null;
        /**
         * Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupChannel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupChannel updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackupChannel`, and systems are expected to put that etag in the request to `UpdateBackupChannel` or `DeleteBackupChannel` 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;
        /**
         * Identifier. The fully qualified name of the BackupChannel. `projects/x/locations/x/backupChannels/x`
         */
        name?: 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 BackupChannel resource was last updated.
         */
        updateTime?: string | 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;
        /**
         * Optional. If false, Backups will fail when Backup for GKE detects Kubernetes configuration that is non-standard or requires additional setup to restore. Default: False
         */
        permissiveMode?: boolean | null;
        /**
         * If set, include just the resources referenced by the listed ProtectedApplications.
         */
        selectedApplications?: Schema$NamespacedNames;
        /**
         * If set, the list of labels whose constituent namespaces were included in the Backup.
         */
        selectedNamespaceLabels?: Schema$ResourceLabels;
        /**
         * If set, include just the resources in the listed namespaces.
         */
        selectedNamespaces?: Schema$Namespaces;
    }
    /**
     * BackupConfigDetails defines the configuration of Backups created via this BackupPlan.
     */
    export interface Schema$BackupConfigDetails {
        /**
         * Output only. If True, include all namespaced resources
         */
        allNamespaces?: boolean | null;
        /**
         * Output only. 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;
        /**
         * Output only. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False
         */
        includeSecrets?: boolean | null;
        /**
         * Output only. 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;
        /**
         * Output only. If set, include just the resources referenced by the listed ProtectedApplications.
         */
        selectedApplications?: Schema$NamespacedNames;
        /**
         * Output only. 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 {
        /**
         * Output only. The fully qualified name of the BackupChannel to be used to create a backup. This field is set only if the cluster being backed up is in a different project. `projects/x/locations/x/backupChannels/x`
         */
        backupChannel?: string | null;
        /**
         * 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. Completion time of the last successful Backup. This is sourced from a successful Backup's complete_time field. This field is added to maintain consistency with BackupPlanBinding to display last successful backup time.
         */
        lastSuccessfulBackupTime?: 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. A number that represents the current risk level of this BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk.
         */
        rpoRiskLevel?: number | null;
        /**
         * Output only. Human-readable description of why the BackupPlan is in the current rpo_risk_level and action items if any.
         */
        rpoRiskReason?: string | null;
        /**
         * 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`. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.
         */
        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;
    }
    /**
     * A BackupPlanBinding binds a BackupPlan with a BackupChannel. This resource is created automatically when a BackupPlan is created using a BackupChannel. This also serves as a holder for cross-project fields that need to be displayed in the current project.
     */
    export interface Schema$BackupPlanBinding {
        /**
         * Output only. Immutable. The fully qualified name of the BackupPlan bound with the parent BackupChannel. `projects/x/locations/x/backupPlans/{backup_plan\}`
         */
        backupPlan?: string | null;
        /**
         * Output only. Contains details about the backup plan/backup.
         */
        backupPlanDetails?: Schema$BackupPlanDetails;
        /**
         * Output only. Immutable. The fully qualified name of the cluster that is being backed up Valid formats: - `projects/x/locations/x/clusters/x` - `projects/x/zones/x/clusters/x`
         */
        cluster?: string | null;
        /**
         * Output only. The timestamp when this binding was created.
         */
        createTime?: string | null;
        /**
         * Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupPlanBinding from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlanBinding updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackupPlanBinding`, and systems are expected to put that etag in the request to `UpdateBackupPlanBinding` or `DeleteBackupPlanBinding` to ensure that their change will be applied to the same version of the resource.
         */
        etag?: string | null;
        /**
         * Identifier. The fully qualified name of the BackupPlanBinding. `projects/x/locations/x/backupChannels/x/backupPlanBindings/x`
         */
        name?: 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 binding was created.
         */
        updateTime?: string | null;
    }
    /**
     * Contains metadata about the backup plan/backup.
     */
    export interface Schema$BackupPlanDetails {
        /**
         * Output only. Contains details about the BackupConfig of Backups created via this BackupPlan.
         */
        backupConfigDetails?: Schema$BackupConfigDetails;
        /**
         * Output only. The fully qualified name of the last successful Backup created under this BackupPlan. `projects/x/locations/x/backupPlans/x/backups/x`
         */
        lastSuccessfulBackup?: string | null;
        /**
         * Output only. Completion time of the last successful Backup. This is sourced from a successful Backup's complete_time field.
         */
        lastSuccessfulBackupTime?: string | null;
        /**
         * Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule or rpo config. This is sourced from BackupPlan.
         */
        nextScheduledBackupTime?: string | null;
        /**
         * Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
         */
        protectedPodCount?: number | null;
        /**
         * Output only. Contains details about the RetentionPolicy of Backups created via this BackupPlan.
         */
        retentionPolicyDetails?: Schema$RetentionPolicyDetails;
        /**
         * Output only. A number that represents the current risk level of this BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk.
         */
        rpoRiskLevel?: number | null;
        /**
         * Output only. State of the BackupPlan.
         */
        state?: 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`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `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. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
         */
        members?: string[] | null;
        /**
         * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
         */
        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. - Node - ComponentStatus - gkebackup.gke.io/BackupJob - gkebackup.gke.io/RestoreJob - metrics.k8s.io/NodeMetrics - migration.k8s.io/StorageState - migration.k8s.io/StorageVersionMigration - snapshot.storage.k8s.io/VolumeSnapshotContent - storage.k8s.io/CSINode - storage.k8s.io/VolumeAttachment 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[];
    }
    /**
     * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
     */
    export interface Schema$Date {
        /**
         * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
         */
        day?: number | null;
        /**
         * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
         */
        month?: number | null;
        /**
         * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
         */
        year?: number | null;
    }
    /**
     * Holds repeated DaysOfWeek values as a container.
     */
    export interface Schema$DayOfWeekList {
        /**
         * Optional. A list of days of week.
         */
        daysOfWeek?: string[] | null;
    }
    /**
     * 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;
    }
    /**
     * Defines a time window during which no backup should happen. All time and date are in UTC.
     */
    export interface Schema$ExclusionWindow {
        /**
         * The exclusion window occurs every day if set to "True". Specifying this field to "False" is an error.
         */
        daily?: boolean | null;
        /**
         * The exclusion window occurs on these days of each week in UTC.
         */
        daysOfWeek?: Schema$DayOfWeekList;
        /**
         * Required. Specifies duration of the window. Duration must be \>= 5 minutes and < (target RPO - 20 minutes). Additional restrictions based on the recurrence type to allow some time for backup to happen: - single_occurrence_date: no restriction, but UI may warn about this when duration \>= target RPO - daily window: duration < 24 hours - weekly window: - days of week includes all seven days of a week: duration < 24 hours - all other weekly window: duration < 168 hours (i.e., 24 * 7 hours)
         */
        duration?: string | null;
        /**
         * No recurrence. The exclusion window occurs only once and on this date in UTC.
         */
        singleOccurrenceDate?: Schema$Date;
        /**
         * Required. Specifies the start time of the window using time of the day in UTC.
         */
        startTime?: Schema$TimeOfDay;
    }
    /**
     * 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;
    }
    /**
     * Defines the filter for `Restore`. This filter can be used to further refine the resource selection of the `Restore` beyond the coarse-grained scope defined in the `RestorePlan`. `exclusion_filters` take precedence over `inclusion_filters`. If a resource matches both `inclusion_filters` and `exclusion_filters`, it will not be restored.
     */
    export interface Schema$Filter {
        /**
         * Optional. Excludes resources from restoration. If specified, a resource will not be restored if it matches any `ResourceSelector` of the `exclusion_filters`.
         */
        exclusionFilters?: Schema$ResourceSelector[];
        /**
         * Optional. Selects resources for restoration. If specified, only resources which match `inclusion_filters` will be selected for restoration. A resource will be selected if it matches any `ResourceSelector` of the `inclusion_filters`.
         */
        inclusionFilters?: Schema$ResourceSelector[];
    }
    /**
     * Response message for GetBackupIndexDownloadUrl.
     */
    export interface Schema$GetBackupIndexDownloadUrlResponse {
        /**
         * Required. The signed URL for downloading the backup index.
         */
        signedUrl?: 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, must be in UpperCamelCase (PascalCase) and singular form. E.g. "CustomResourceDefinition", "StorageClass", etc.
         */
        resourceKind?: string | null;
    }
    /**
     * Defines a dependency between two group kinds.
     */
    export interface Schema$GroupKindDependency {
        /**
         * Required. The requiring group kind requires that the other group kind be restored first.
         */
        requiring?: Schema$GroupKind;
        /**
         * Required. The satisfying group kind must be restored first in order to satisfy the dependency.
         */
        satisfying?: Schema$GroupKind;
    }
    /**
     * A single Kubernetes label-value pair.
     */
    export interface Schema$Label {
        /**
         * Optional. The key/name of the label.
         */
        key?: string | null;
        /**
         * Optional. The value of the label.
         */
        value?: string | null;
    }
    /**
     * Response message for ListBackupChannels.
     */
    export interface Schema$ListBackupChannelsResponse {
        /**
         * The list of BackupChannels matching the given criteria.
         */
        backupChannels?: Schema$BackupChannel[];
        /**
         * A token which may be sent as page_token in a subsequent `ListBackupChannels` 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 ListBackupPlanBindings.
     */
    export interface Schema$ListBackupPlanBindingsResponse {
        /**
         * The list of BackupPlanBindings matching the given criteria.
         */
        backupPlanBindings?: Schema$BackupPlanBinding[];
        /**
         * A token which may be sent as page_token in a subsequent `ListBackupPlanBindingss` 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 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;
        /**
         * Locations that could not be reached.
         */
        unreachable?: 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 ListRestoreChannels.
     */
    export interface Schema$ListRestoreChannelsResponse {
        /**
         * A token which may be sent as page_token in a subsequent `ListRestoreChannels` 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 RestoreChannels matching the given criteria.
         */
        restoreChannels?: Schema$RestoreChannel[];
        /**
         * Locations that could not be reached.
         */
        unreachable?: string[] | null;
    }
    /**
     * Response message for ListRestorePlanBindings.
     */
    export interface Schema$ListRestorePlanBindingsResponse {
        /**
         * A token which may be sent as page_token in a subsequent `ListRestorePlanBindings` 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 RestorePlanBindings matching the given criteria.
         */
        restorePlanBindings?: Schema$RestorePlanBinding[];
        /**
         * Unordered list. Locations that could not be reached.
         */
        unreachable?: 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.
         */
        nextPag