Backup for GKE V1 API - Class Google::Cloud::GkeBackup::V1::Backup (v0.11.0)

Reference documentation and code samples for the Backup for GKE V1 API class Google::Cloud::GkeBackup::V1::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).

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#all_namespaces

def all_namespaces() -> ::Boolean
Returns
  • (::Boolean) — Output only. If True, all namespaces were included in the Backup.

#cluster_metadata

def cluster_metadata() -> ::Google::Cloud::GkeBackup::V1::Backup::ClusterMetadata
Returns

#complete_time

def complete_time() -> ::Google::Protobuf::Timestamp
Returns

#config_backup_size_bytes

def config_backup_size_bytes() -> ::Integer
Returns
  • (::Integer) — Output only. The size of the config backup in bytes.

#contains_secrets

def contains_secrets() -> ::Boolean
Returns
  • (::Boolean) — Output only. Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value.

#contains_volume_data

def contains_volume_data() -> ::Boolean
Returns
  • (::Boolean) — Output only. Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#delete_lock_days

def delete_lock_days() -> ::Integer
Returns
  • (::Integer) — 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_days=

def delete_lock_days=(value) -> ::Integer
Parameter
  • value (::Integer) — 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).

Returns
  • (::Integer) — 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

def delete_lock_expire_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. User specified descriptive string for this Backup.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. User specified descriptive string for this Backup.
Returns
  • (::String) — Optional. User specified descriptive string for this Backup.

#encryption_key

def encryption_key() -> ::Google::Cloud::GkeBackup::V1::EncryptionKey
Returns

#etag

def etag() -> ::String
Returns
  • (::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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. A set of custom labels supplied by user.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. A set of custom labels supplied by user.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. A set of custom labels supplied by user.

#manual

def manual() -> ::Boolean
Returns
  • (::Boolean) — 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.

#name

def name() -> ::String
Returns
  • (::String) — Output only. The fully qualified name of the Backup. projects/*/locations/*/backupPlans/*/backups/*

#permissive_mode

def permissive_mode() -> ::Boolean
Returns
  • (::Boolean) — 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.

#pod_count

def pod_count() -> ::Integer
Returns
  • (::Integer) — Output only. The total number of Kubernetes Pods contained in the Backup.

#resource_count

def resource_count() -> ::Integer
Returns
  • (::Integer) — Output only. The total number of Kubernetes resources included in the Backup.

#retain_days

def retain_days() -> ::Integer
Returns
  • (::Integer) — 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_days=

def retain_days=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.

Returns
  • (::Integer) — 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

def retain_expire_time() -> ::Google::Protobuf::Timestamp
Returns

#selected_applications

def selected_applications() -> ::Google::Cloud::GkeBackup::V1::NamespacedNames
Returns

#selected_namespaces

def selected_namespaces() -> ::Google::Cloud::GkeBackup::V1::Namespaces
Returns

#size_bytes

def size_bytes() -> ::Integer
Returns
  • (::Integer) — Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes)

#state

def state() -> ::Google::Cloud::GkeBackup::V1::Backup::State
Returns

#state_reason

def state_reason() -> ::String
Returns
  • (::String) — Output only. Human-readable description of why the backup is in the current state.

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. Server generated global unique identifier of UUID4

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#volume_count

def volume_count() -> ::Integer
Returns
  • (::Integer) — Output only. The total number of volume backups contained in the Backup.