Backup for GKE v1 API - Class BackupPlan.Types.Schedule (2.4.0)

public sealed class BackupPlan.Types.Schedule : IMessage<BackupPlan.Types.Schedule>, IEquatable<BackupPlan.Types.Schedule>, IDeepCloneable<BackupPlan.Types.Schedule>, IBufferMessage, IMessage

Reference documentation and code samples for the Backup for GKE v1 API class BackupPlan.Types.Schedule.

Defines scheduling parameters for automatically creating Backups via this BackupPlan.

Inheritance

object > BackupPlan.Types.Schedule

Namespace

Google.Cloud.GkeBackup.V1

Assembly

Google.Cloud.GkeBackup.V1.dll

Constructors

Schedule()

public Schedule()

Schedule(Schedule)

public Schedule(BackupPlan.Types.Schedule other)
Parameter
Name Description
other BackupPlanTypesSchedule

Properties

CronSchedule

public string CronSchedule { get; set; }

Optional. A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. This is mutually exclusive with the [rpo_config][google.cloud.gkebackup.v1.BackupPlan.Schedule.rpo_config] field since at most one schedule can be defined for a BackupPlan. If this is defined, then [backup_retain_days][google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy.backup_retain_days] must also be defined.

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

Property Value
Type Description
string

NextScheduledBackupTime

public Timestamp NextScheduledBackupTime { get; set; }

Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule or rpo config.

Property Value
Type Description
Timestamp

Paused

public bool Paused { get; set; }

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

Default: False

Property Value
Type Description
bool

RpoConfig

public RpoConfig RpoConfig { get; set; }

Optional. Defines the RPO schedule configuration for this BackupPlan. This is mutually exclusive with the [cron_schedule][google.cloud.gkebackup.v1.BackupPlan.Schedule.cron_schedule] field since at most one schedule can be defined for a BackupPLan. If this is defined, then [backup_retain_days][google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy.backup_retain_days] must also be defined.

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

Property Value
Type Description
RpoConfig