Interface BackupPlan.ScheduleOrBuilder (0.41.0)

public static interface BackupPlan.ScheduleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCronSchedule()

public abstract String getCronSchedule()

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.

string cron_schedule = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The cronSchedule.

getCronScheduleBytes()

public abstract ByteString getCronScheduleBytes()

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.

string cron_schedule = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for cronSchedule.

getNextScheduledBackupTime()

public abstract Timestamp getNextScheduledBackupTime()

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

.google.protobuf.Timestamp next_scheduled_backup_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The nextScheduledBackupTime.

getNextScheduledBackupTimeOrBuilder()

public abstract TimestampOrBuilder getNextScheduledBackupTimeOrBuilder()

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

.google.protobuf.Timestamp next_scheduled_backup_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getPaused()

public abstract boolean getPaused()

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

Default: False

bool paused = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The paused.

getRpoConfig()

public abstract RpoConfig getRpoConfig()

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.

.google.cloud.gkebackup.v1.RpoConfig rpo_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RpoConfig

The rpoConfig.

getRpoConfigOrBuilder()

public abstract RpoConfigOrBuilder getRpoConfigOrBuilder()

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.

.google.cloud.gkebackup.v1.RpoConfig rpo_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RpoConfigOrBuilder

hasNextScheduledBackupTime()

public abstract boolean hasNextScheduledBackupTime()

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

.google.protobuf.Timestamp next_scheduled_backup_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the nextScheduledBackupTime field is set.

hasRpoConfig()

public abstract boolean hasRpoConfig()

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.

.google.cloud.gkebackup.v1.RpoConfig rpo_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the rpoConfig field is set.