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

Reference documentation and code samples for the Backup for GKE V1 API class Google::Cloud::GkeBackup::V1::BackupPlan.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#backup_config

def backup_config() -> ::Google::Cloud::GkeBackup::V1::BackupPlan::BackupConfig
Returns

#backup_config=

def backup_config=(value) -> ::Google::Cloud::GkeBackup::V1::BackupPlan::BackupConfig
Parameter
Returns

#backup_schedule

def backup_schedule() -> ::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule
Returns

#backup_schedule=

def backup_schedule=(value) -> ::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule
Parameter
Returns

#cluster

def cluster() -> ::String
Returns
  • (::String) —

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

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

#cluster=

def cluster=(value) -> ::String
Parameter
  • value (::String) —

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

    • projects/*/locations/*/clusters/*
    • projects/*/zones/*/clusters/*
Returns
  • (::String) —

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

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

#create_time

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

#deactivated

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

def deactivated=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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

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

#description

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

#description=

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

#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 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.

#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.

#name

def name() -> ::String
Returns
  • (::String) — Output only. The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*

#protected_pod_count

def protected_pod_count() -> ::Integer
Returns
  • (::Integer) — Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.

#retention_policy

def retention_policy() -> ::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy
Returns

#retention_policy=

def retention_policy=(value) -> ::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy
Parameter
Returns

#rpo_risk_level

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

#rpo_risk_reason

def rpo_risk_reason() -> ::String
Returns
  • (::String) — Output only. Human-readable description of why the BackupPlan is in the current rpo_risk_level and action items if any.

#state

def state() -> ::Google::Cloud::GkeBackup::V1::BackupPlan::State
Returns
  • (::Google::Cloud::GkeBackup::V1::BackupPlan::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

#state_reason

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

#uid

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

#update_time

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