Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class Backup.
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).
Generated from protobuf message google.cloud.gkebackup.v1.Backup
Namespace
Google \ Cloud \ GkeBackup \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The fully qualified name of the Backup. projects/*/locations/*/backupPlans/*/backups/*
↳ uid
↳ create_time
↳ update_time
↳ manual
bool
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.
↳ labels
↳ delete_lock_days
int
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).
↳ delete_lock_expire_time
Google\Protobuf\Timestamp
Output only. The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days ).
↳ retain_days
int
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.
↳ retain_expire_time
Google\Protobuf\Timestamp
Output only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days ).
↳ encryption_key
EncryptionKey
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.
↳ all_namespaces
bool
Output only. If True, all namespaces were included in the Backup.
↳ selected_namespaces
↳ selected_applications
NamespacedNames
Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.
↳ contains_volume_data
bool
Output only. Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.
↳ contains_secrets
bool
Output only. Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.
↳ cluster_metadata
Backup\ClusterMetadata
Output only. Information about the GKE cluster from which this Backup was created.
↳ state
int
Output only. Current state of the Backup
↳ state_reason
string
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.
↳ complete_time
↳ resource_count
int
Output only. The total number of Kubernetes resources included in the Backup.
↳ volume_count
int
Output only. The total number of volume backups contained in the Backup.
↳ size_bytes
int|string
Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes)
↳ etag
string
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.
↳ description
string
Optional. User specified descriptive string for this Backup.
↳ pod_count
int
Output only. The total number of Kubernetes Pods contained in the Backup.
↳ config_backup_size_bytes
int|string
Output only. The size of the config backup in bytes.
↳ permissive_mode
bool
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.
↳ satisfies_pzs
bool
Output only. [Output Only] Reserved for future use.
↳ satisfies_pzi
bool
Output only. [Output Only] Reserved for future use.
getName
Output only. The fully qualified name of the Backup.
projects/*/locations/*/backupPlans/*/backups/*
string
setName
Output only. The fully qualified name of the Backup.
projects/*/locations/*/backupPlans/*/backups/*
var
string
$this
getUid
Output only. Server generated global unique identifier of UUID4
string
setUid
Output only. Server generated global unique identifier of UUID4
var
string
$this
getCreateTime
Output only. The timestamp when this Backup resource was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp when this Backup resource was created.
$this
getUpdateTime
Output only. The timestamp when this Backup resource was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp when this Backup resource was last updated.
$this
getManual
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.
bool
setManual
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.
var
bool
$this
getLabels
Optional. A set of custom labels supplied by user.
setLabels
Optional. A set of custom labels supplied by user.
$this
getDeleteLockDays
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).
int
setDeleteLockDays
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).
var
int
$this
getDeleteLockExpireTime
Output only. The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days ).
hasDeleteLockExpireTime
clearDeleteLockExpireTime
setDeleteLockExpireTime
Output only. The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days ).
$this
getRetainDays
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.
int
setRetainDays
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.
var
int
$this
getRetainExpireTime
Output only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days ).
hasRetainExpireTime
clearRetainExpireTime
setRetainExpireTime
Output only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days ).
$this
getEncryptionKey
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.
hasEncryptionKey
clearEncryptionKey
setEncryptionKey
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.
$this
getAllNamespaces
Output only. If True, all namespaces were included in the Backup.
bool
hasAllNamespaces
setAllNamespaces
Output only. If True, all namespaces were included in the Backup.
var
bool
$this
getSelectedNamespaces
Output only. If set, the list of namespaces that were included in the Backup.
hasSelectedNamespaces
setSelectedNamespaces
Output only. If set, the list of namespaces that were included in the Backup.
$this
getSelectedApplications
Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.
hasSelectedApplications
setSelectedApplications
Output only. If set, the list of ProtectedApplications whose resources were included in the Backup.
$this
getContainsVolumeData
Output only. Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.
bool
setContainsVolumeData
Output only. Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.
var
bool
$this
getContainsSecrets
Output only. Whether or not the Backup contains Kubernetes Secrets.
Controlled by the parent BackupPlan's include_secrets value.
bool
setContainsSecrets
Output only. Whether or not the Backup contains Kubernetes Secrets.
Controlled by the parent BackupPlan's include_secrets value.
var
bool
$this
getClusterMetadata
Output only. Information about the GKE cluster from which this Backup was created.
hasClusterMetadata
clearClusterMetadata
setClusterMetadata
Output only. Information about the GKE cluster from which this Backup was created.
$this
getState
Output only. Current state of the Backup
int
setState
Output only. Current state of the Backup
var
int
$this
getStateReason
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.
string
setStateReason
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.
var
string
$this
getCompleteTime
Output only. Completion time of the Backup
hasCompleteTime
clearCompleteTime
setCompleteTime
Output only. Completion time of the Backup
$this
getResourceCount
Output only. The total number of Kubernetes resources included in the Backup.
int
setResourceCount
Output only. The total number of Kubernetes resources included in the Backup.
var
int
$this
getVolumeCount
Output only. The total number of volume backups contained in the Backup.
int
setVolumeCount
Output only. The total number of volume backups contained in the Backup.
var
int
$this
getSizeBytes
Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes)
int|string
setSizeBytes
Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes)
var
int|string
$this
getEtag
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.
string
setEtag
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.
var
string
$this
getDescription
Optional. User specified descriptive string for this Backup.
string
setDescription
Optional. User specified descriptive string for this Backup.
var
string
$this
getPodCount
Output only. The total number of Kubernetes Pods contained in the Backup.
int
setPodCount
Output only. The total number of Kubernetes Pods contained in the Backup.
var
int
$this
getConfigBackupSizeBytes
Output only. The size of the config backup in bytes.
int|string
setConfigBackupSizeBytes
Output only. The size of the config backup in bytes.
var
int|string
$this
getPermissiveMode
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.
bool
setPermissiveMode
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.
var
bool
$this
getSatisfiesPzs
Output only. [Output Only] Reserved for future use.
bool
setSatisfiesPzs
Output only. [Output Only] Reserved for future use.
var
bool
$this
getSatisfiesPzi
Output only. [Output Only] Reserved for future use.
bool
setSatisfiesPzi
Output only. [Output Only] Reserved for future use.
var
bool
$this
getBackupScope
string
