REST Resource: projects.locations.backupPlans

Resource: BackupPlan

Defines the configuration and scheduling for a "line" of Backups.

JSON representation 
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "description": string,
  "cluster": string,
  "retentionPolicy": {
    object (RetentionPolicy)
  },
  "labels": {
    string: string,
    ...
  },
  "backupSchedule": {
    object (Schedule)
  },
  "etag": string,
  "deactivated": boolean,
  "backupConfig": {
    object (BackupConfig)
  },
  "protectedPodCount": integer,
  "state": enum (State),
  "stateReason": string
}
Fields
name

string

Output only. The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*
uid

string

Output only. Server generated global unique identifier of UUID format.
createTime

string (Timestamp format)

Output only. The timestamp when this BackupPlan resource was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The timestamp when this BackupPlan resource was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
description

string

User specified descriptive string for this BackupPlan.
cluster

string

Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats:

  • projects/*/locations/*/clusters/*
  • projects/*/zones/*/clusters/*
retentionPolicy

object (RetentionPolicy)

RetentionPolicy governs lifecycle of Backups created under this plan.
labels

map (key: string, value: string)

A set of custom labels supplied by user.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
backupSchedule

object (Schedule)

Defines a schedule for automatic Backup creation via this BackupPlan.
etag

string

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 backupPlans.get, and systems are expected to put that etag in the request to backupPlans.patch or backupPlans.delete to ensure that their change will be applied to the same version of the resource.
deactivated

boolean

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
backupConfig

object (BackupConfig)

Defines the configuration of Backups created via this BackupPlan.
protectedPodCount

integer

Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
state

enum (State)

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
stateReason

string

Output only. Human-readable description of why BackupPlan is in the current state

RetentionPolicy

RetentionPolicy defines a Backup retention policy for a BackupPlan.

JSON representation 
{
  "backupDeleteLockDays": integer,
  "backupRetainDays": integer,
  "locked": boolean
}
Fields
backupDeleteLockDays

integer

Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (createTime + backupDeleteLockDays). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value.

Default: 0 (no delete blocking)
backupRetainDays

integer

The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (createTime + backupRetainDays). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backupRetainDays must be >= backupDeleteLockDays. If cronSchedule is defined, then this must be <= 360 * the creation interval.

Default: 0 (no automatic deletion)
locked

boolean

This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself.

Default: False

Schedule

Defines scheduling parameters for automatically creating Backups via this BackupPlan.

JSON representation 
{
  "cronSchedule": string,
  "paused": boolean
}
Fields
cronSchedule

string

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. This is mutually exclusive with the rpoConfig field since at most one schedule can be defined for a BackupPlan. If this is defined, then backupRetainDays must also be defined.

Default (empty): no automatic backup creation will occur.
paused

boolean

This flag denotes whether automatic Backup creation is paused for this BackupPlan.

Default: False

BackupConfig

BackupConfig defines the configuration of Backups created via this BackupPlan.

JSON representation 
{
  "includeVolumeData": boolean,
  "includeSecrets": boolean,
  "encryptionKey": {
    object (EncryptionKey)
  },

  // Union field backup_scope can be only one of the following:
  "allNamespaces": boolean,
  "selectedNamespaces": {
    object (Namespaces)
  },
  "selectedApplications": {
    object (NamespacedNames)
  }
  // End of list of possible types for union field backup_scope.
}
Fields
includeVolumeData

boolean

This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup.

Default: False
includeSecrets

boolean

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups.

Default: False
encryptionKey

object (EncryptionKey)

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.
Union field backup_scope. This defines the "scope" of the Backup - which namespaced resources in the cluster will be included in a Backup. Exactly one of the fields of backup_scope MUST be specified. backup_scope can be only one of the following:
allNamespaces

boolean

If True, include all namespaced resources
selectedNamespaces

object (Namespaces)

If set, include just the resources in the listed namespaces.
selectedApplications

object (NamespacedNames)

If set, include just the resources referenced by the listed ProtectedApplications.

State

State

Enums
STATE_UNSPECIFIED Default first value for Enums.
CLUSTER_PENDING Waiting for cluster state to be RUNNING.
PROVISIONING The BackupPlan is in the process of being created.
READY The BackupPlan has successfully been created and is ready for Backups.
FAILED BackupPlan creation has failed.
DEACTIVATED The BackupPlan has been deactivated.
DELETING The BackupPlan is in the process of being deleted.

Methods

create

 Creates a new BackupPlan in a given location.

delete

 Deletes an existing BackupPlan.

get

 Retrieve the details of a single BackupPlan.

getIamPolicy

 Gets the access control policy for a resource.

list

 Lists BackupPlans in a given location.

patch

 Update a BackupPlan.

setIamPolicy

 Sets the access control policy on the specified resource.

testIamPermissions

 Returns permissions that a caller has on the specified resource.