Backup for GKE V1 API - Class Google::Cloud::GkeBackup::V1::BackupPlan::Schedule (v1.0.0)

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

Defines scheduling parameters for automatically creating Backups via this BackupPlan.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#cron_schedule

def cron_schedule() -> ::String
Returns
  • (::String) — Optional. A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. This is mutually exclusive with the rpo_config field since at most one schedule can be defined for a BackupPlan. If this is defined, then backup_retain_days must also be defined.

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

#cron_schedule=

def cron_schedule=(value) -> ::String
Parameter
  • value (::String) — Optional. A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. This is mutually exclusive with the rpo_config field since at most one schedule can be defined for a BackupPlan. If this is defined, then backup_retain_days must also be defined.

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

Returns
  • (::String) — Optional. A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. This is mutually exclusive with the rpo_config field since at most one schedule can be defined for a BackupPlan. If this is defined, then backup_retain_days must also be defined.

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

#next_scheduled_backup_time

def next_scheduled_backup_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule or rpo config.

#paused

def paused() -> ::Boolean
Returns
  • (::Boolean) — Optional. This flag denotes whether automatic Backup creation is paused for this BackupPlan.

    Default: False

#paused=

def paused=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. This flag denotes whether automatic Backup creation is paused for this BackupPlan.

    Default: False

Returns
  • (::Boolean) — Optional. This flag denotes whether automatic Backup creation is paused for this BackupPlan.

    Default: False

#rpo_config

def rpo_config() -> ::Google::Cloud::GkeBackup::V1::RpoConfig
Returns

#rpo_config=

def rpo_config=(value) -> ::Google::Cloud::GkeBackup::V1::RpoConfig
Parameter
  • value (::Google::Cloud::GkeBackup::V1::RpoConfig) — Optional. Defines the RPO schedule configuration for this BackupPlan. This is mutually exclusive with the cron_schedule field since at most one schedule can be defined for a BackupPLan. If this is defined, then backup_retain_days must also be defined.

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

Returns