Class BackupPlan.Schedule (0.43.0) 

public static final class BackupPlan.Schedule extends GeneratedMessageV3 implements BackupPlan.ScheduleOrBuilder

Defines scheduling parameters for automatically creating Backups via this BackupPlan.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BackupPlan.Schedule

Static Fields

CRON_SCHEDULE_FIELD_NUMBER

public static final int CRON_SCHEDULE_FIELD_NUMBER
Field Value
Type Description
int

NEXT_SCHEDULED_BACKUP_TIME_FIELD_NUMBER

public static final int NEXT_SCHEDULED_BACKUP_TIME_FIELD_NUMBER
Field Value
Type Description
int

PAUSED_FIELD_NUMBER

public static final int PAUSED_FIELD_NUMBER
Field Value
Type Description
int

RPO_CONFIG_FIELD_NUMBER

public static final int RPO_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BackupPlan.Schedule getDefaultInstance()
Returns
Type Description
BackupPlan.Schedule

getDescriptor()

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

newBuilder()

public static BackupPlan.Schedule.Builder newBuilder()
Returns
Type Description
BackupPlan.Schedule.Builder

newBuilder(BackupPlan.Schedule prototype)

public static BackupPlan.Schedule.Builder newBuilder(BackupPlan.Schedule prototype)
Parameter
Name Description
prototype BackupPlan.Schedule
Returns
Type Description
BackupPlan.Schedule.Builder

parseDelimitedFrom(InputStream input)

public static BackupPlan.Schedule parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BackupPlan.Schedule
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.Schedule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupPlan.Schedule
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BackupPlan.Schedule parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BackupPlan.Schedule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.Schedule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupPlan.Schedule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BackupPlan.Schedule parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BackupPlan.Schedule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.Schedule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupPlan.Schedule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BackupPlan.Schedule parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BackupPlan.Schedule
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.Schedule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupPlan.Schedule
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BackupPlan.Schedule parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BackupPlan.Schedule
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.Schedule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupPlan.Schedule
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BackupPlan.Schedule parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BackupPlan.Schedule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BackupPlan.Schedule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupPlan.Schedule
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BackupPlan.Schedule> parser()
Returns
Type Description
Parser<Schedule>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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.

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

getParserForType()

public Parser<BackupPlan.Schedule> getParserForType()
Returns
Type Description
Parser<Schedule>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BackupPlan.Schedule.Builder newBuilderForType()
Returns
Type Description
BackupPlan.Schedule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BackupPlan.Schedule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BackupPlan.Schedule.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BackupPlan.Schedule.Builder toBuilder()
Returns
Type Description
BackupPlan.Schedule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException