Class BackupPlan.Schedule.Builder (0.44.0)

public static final class BackupPlan.Schedule.Builder extends GeneratedMessageV3.Builder<BackupPlan.Schedule.Builder> implements BackupPlan.ScheduleOrBuilder

Defines scheduling parameters for automatically creating Backups via this BackupPlan.

Protobuf type google.cloud.gkebackup.v1.BackupPlan.Schedule

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BackupPlan.Schedule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BackupPlan.Schedule.Builder
Overrides

build()

public BackupPlan.Schedule build()
Returns
Type Description
BackupPlan.Schedule

buildPartial()

public BackupPlan.Schedule buildPartial()
Returns
Type Description
BackupPlan.Schedule

clear()

public BackupPlan.Schedule.Builder clear()
Returns
Type Description
BackupPlan.Schedule.Builder
Overrides

clearCronSchedule()

public BackupPlan.Schedule.Builder clearCronSchedule()

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
BackupPlan.Schedule.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BackupPlan.Schedule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BackupPlan.Schedule.Builder
Overrides

clearNextScheduledBackupTime()

public BackupPlan.Schedule.Builder clearNextScheduledBackupTime()

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
BackupPlan.Schedule.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public BackupPlan.Schedule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BackupPlan.Schedule.Builder
Overrides

clearPaused()

public BackupPlan.Schedule.Builder clearPaused()

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
BackupPlan.Schedule.Builder

This builder for chaining.

clearRpoConfig()

public BackupPlan.Schedule.Builder clearRpoConfig()

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
BackupPlan.Schedule.Builder

clone()

public BackupPlan.Schedule.Builder clone()
Returns
Type Description
BackupPlan.Schedule.Builder
Overrides

getCronSchedule()

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

getDefaultInstanceForType()

public BackupPlan.Schedule getDefaultInstanceForType()
Returns
Type Description
BackupPlan.Schedule

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getNextScheduledBackupTime()

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

getNextScheduledBackupTimeBuilder()

public Timestamp.Builder getNextScheduledBackupTimeBuilder()

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
Builder

getNextScheduledBackupTimeOrBuilder()

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

getRpoConfigBuilder()

public RpoConfig.Builder getRpoConfigBuilder()

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

getRpoConfigOrBuilder()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(BackupPlan.Schedule other)

public BackupPlan.Schedule.Builder mergeFrom(BackupPlan.Schedule other)
Parameter
Name Description
other BackupPlan.Schedule
Returns
Type Description
BackupPlan.Schedule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BackupPlan.Schedule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupPlan.Schedule.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BackupPlan.Schedule.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BackupPlan.Schedule.Builder
Overrides

mergeNextScheduledBackupTime(Timestamp value)

public BackupPlan.Schedule.Builder mergeNextScheduledBackupTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
BackupPlan.Schedule.Builder

mergeRpoConfig(RpoConfig value)

public BackupPlan.Schedule.Builder mergeRpoConfig(RpoConfig value)

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];

Parameter
Name Description
value RpoConfig
Returns
Type Description
BackupPlan.Schedule.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BackupPlan.Schedule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BackupPlan.Schedule.Builder
Overrides

setCronSchedule(String value)

public BackupPlan.Schedule.Builder setCronSchedule(String value)

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];

Parameter
Name Description
value String

The cronSchedule to set.

Returns
Type Description
BackupPlan.Schedule.Builder

This builder for chaining.

setCronScheduleBytes(ByteString value)

public BackupPlan.Schedule.Builder setCronScheduleBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for cronSchedule to set.

Returns
Type Description
BackupPlan.Schedule.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BackupPlan.Schedule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BackupPlan.Schedule.Builder
Overrides

setNextScheduledBackupTime(Timestamp value)

public BackupPlan.Schedule.Builder setNextScheduledBackupTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
BackupPlan.Schedule.Builder

setNextScheduledBackupTime(Timestamp.Builder builderForValue)

public BackupPlan.Schedule.Builder setNextScheduledBackupTime(Timestamp.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BackupPlan.Schedule.Builder

setPaused(boolean value)

public BackupPlan.Schedule.Builder setPaused(boolean value)

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

Default: False

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

Parameter
Name Description
value boolean

The paused to set.

Returns
Type Description
BackupPlan.Schedule.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BackupPlan.Schedule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BackupPlan.Schedule.Builder
Overrides

setRpoConfig(RpoConfig value)

public BackupPlan.Schedule.Builder setRpoConfig(RpoConfig value)

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];

Parameter
Name Description
value RpoConfig
Returns
Type Description
BackupPlan.Schedule.Builder

setRpoConfig(RpoConfig.Builder builderForValue)

public BackupPlan.Schedule.Builder setRpoConfig(RpoConfig.Builder builderForValue)

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];

Parameter
Name Description
builderForValue RpoConfig.Builder
Returns
Type Description
BackupPlan.Schedule.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final BackupPlan.Schedule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BackupPlan.Schedule.Builder
Overrides