Class StandardSchedule (0.13.0)

public final class StandardSchedule extends GeneratedMessageV3 implements StandardScheduleOrBuilder

StandardSchedule defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY.

Protobuf type google.cloud.backupdr.v1.StandardSchedule

Static Fields

BACKUP_WINDOW_FIELD_NUMBER

public static final int BACKUP_WINDOW_FIELD_NUMBER
Field Value
Type Description
int

DAYS_OF_MONTH_FIELD_NUMBER

public static final int DAYS_OF_MONTH_FIELD_NUMBER
Field Value
Type Description
int

DAYS_OF_WEEK_FIELD_NUMBER

public static final int DAYS_OF_WEEK_FIELD_NUMBER
Field Value
Type Description
int

HOURLY_FREQUENCY_FIELD_NUMBER

public static final int HOURLY_FREQUENCY_FIELD_NUMBER
Field Value
Type Description
int

MONTHS_FIELD_NUMBER

public static final int MONTHS_FIELD_NUMBER
Field Value
Type Description
int

RECURRENCE_TYPE_FIELD_NUMBER

public static final int RECURRENCE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER
Field Value
Type Description
int

WEEK_DAY_OF_MONTH_FIELD_NUMBER

public static final int WEEK_DAY_OF_MONTH_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StandardSchedule getDefaultInstance()
Returns
Type Description
StandardSchedule

getDescriptor()

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

newBuilder()

public static StandardSchedule.Builder newBuilder()
Returns
Type Description
StandardSchedule.Builder

newBuilder(StandardSchedule prototype)

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

parseDelimitedFrom(InputStream input)

public static StandardSchedule parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StandardSchedule
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static StandardSchedule parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
StandardSchedule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static StandardSchedule parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
StandardSchedule
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static StandardSchedule parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StandardSchedule
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static StandardSchedule parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
StandardSchedule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<StandardSchedule> parser()
Returns
Type Description
Parser<StandardSchedule>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBackupWindow()

public BackupWindow getBackupWindow()

Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as NOT_RUN if they do not start by the end of the window.

Note: running jobs will not be cancelled at the end of the window.

.google.cloud.backupdr.v1.BackupWindow backup_window = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BackupWindow

The backupWindow.

getBackupWindowOrBuilder()

public BackupWindowOrBuilder getBackupWindowOrBuilder()

Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as NOT_RUN if they do not start by the end of the window.

Note: running jobs will not be cancelled at the end of the window.

.google.cloud.backupdr.v1.BackupWindow backup_window = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BackupWindowOrBuilder

getDaysOfMonth(int index)

public int getDaysOfMonth(int index)

Optional. Specifies days of months like 1, 5, or 14 on which jobs will run.

Values for days_of_month are only applicable for recurrence_type, MONTHLY and YEARLY. A validation error will occur if other values are supplied.

repeated int32 days_of_month = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
int

The daysOfMonth at the given index.

getDaysOfMonthCount()

public int getDaysOfMonthCount()

Optional. Specifies days of months like 1, 5, or 14 on which jobs will run.

Values for days_of_month are only applicable for recurrence_type, MONTHLY and YEARLY. A validation error will occur if other values are supplied.

repeated int32 days_of_month = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of daysOfMonth.

getDaysOfMonthList()

public List<Integer> getDaysOfMonthList()

Optional. Specifies days of months like 1, 5, or 14 on which jobs will run.

Values for days_of_month are only applicable for recurrence_type, MONTHLY and YEARLY. A validation error will occur if other values are supplied.

repeated int32 days_of_month = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the daysOfMonth.

getDaysOfWeek(int index)

public DayOfWeek getDaysOfWeek(int index)

Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run.

This is required for recurrence_type, WEEKLY and is not applicable otherwise. A validation error will occur if a value is supplied and recurrence_type is not WEEKLY.

repeated .google.type.DayOfWeek days_of_week = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
com.google.type.DayOfWeek

The daysOfWeek at the given index.

getDaysOfWeekCount()

public int getDaysOfWeekCount()

Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run.

This is required for recurrence_type, WEEKLY and is not applicable otherwise. A validation error will occur if a value is supplied and recurrence_type is not WEEKLY.

repeated .google.type.DayOfWeek days_of_week = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of daysOfWeek.

getDaysOfWeekList()

public List<DayOfWeek> getDaysOfWeekList()

Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run.

This is required for recurrence_type, WEEKLY and is not applicable otherwise. A validation error will occur if a value is supplied and recurrence_type is not WEEKLY.

repeated .google.type.DayOfWeek days_of_week = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<com.google.type.DayOfWeek>

A list containing the daysOfWeek.

getDaysOfWeekValue(int index)

public int getDaysOfWeekValue(int index)

Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run.

This is required for recurrence_type, WEEKLY and is not applicable otherwise. A validation error will occur if a value is supplied and recurrence_type is not WEEKLY.

repeated .google.type.DayOfWeek days_of_week = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of daysOfWeek at the given index.

getDaysOfWeekValueList()

public List<Integer> getDaysOfWeekValueList()

Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run.

This is required for recurrence_type, WEEKLY and is not applicable otherwise. A validation error will occur if a value is supplied and recurrence_type is not WEEKLY.

repeated .google.type.DayOfWeek days_of_week = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for daysOfWeek.

getDefaultInstanceForType()

public StandardSchedule getDefaultInstanceForType()
Returns
Type Description
StandardSchedule

getHourlyFrequency()

public int getHourlyFrequency()

Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined.

This is required for recurrence_type, HOURLY and is not applicable otherwise. A validation error will occur if a value is supplied and recurrence_type is not HOURLY.

Value of hourly frequency should be between 6 and 23.

Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the backup time to mins and hours (in worst case scenario).

int32 hourly_frequency = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The hourlyFrequency.

getMonths(int index)

public Month getMonths(int index)

Optional. Specifies the months of year, like FEBRUARY and/or MAY, on which jobs will run.

This field is only applicable when recurrence_type is YEARLY. A validation error will occur if other values are supplied.

repeated .google.type.Month months = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
com.google.type.Month

The months at the given index.

getMonthsCount()

public int getMonthsCount()

Optional. Specifies the months of year, like FEBRUARY and/or MAY, on which jobs will run.

This field is only applicable when recurrence_type is YEARLY. A validation error will occur if other values are supplied.

repeated .google.type.Month months = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of months.

getMonthsList()

public List<Month> getMonthsList()

Optional. Specifies the months of year, like FEBRUARY and/or MAY, on which jobs will run.

This field is only applicable when recurrence_type is YEARLY. A validation error will occur if other values are supplied.

repeated .google.type.Month months = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<com.google.type.Month>

A list containing the months.

getMonthsValue(int index)

public int getMonthsValue(int index)

Optional. Specifies the months of year, like FEBRUARY and/or MAY, on which jobs will run.

This field is only applicable when recurrence_type is YEARLY. A validation error will occur if other values are supplied.

repeated .google.type.Month months = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of months at the given index.

getMonthsValueList()

public List<Integer> getMonthsValueList()

Optional. Specifies the months of year, like FEBRUARY and/or MAY, on which jobs will run.

This field is only applicable when recurrence_type is YEARLY. A validation error will occur if other values are supplied.

repeated .google.type.Month months = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for months.

getParserForType()

public Parser<StandardSchedule> getParserForType()
Returns
Type Description
Parser<StandardSchedule>
Overrides

getRecurrenceType()

public StandardSchedule.RecurrenceType getRecurrenceType()

Required. Specifies the RecurrenceType for the schedule.

.google.cloud.backupdr.v1.StandardSchedule.RecurrenceType recurrence_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
StandardSchedule.RecurrenceType

The recurrenceType.

getRecurrenceTypeValue()

public int getRecurrenceTypeValue()

Required. Specifies the RecurrenceType for the schedule.

.google.cloud.backupdr.v1.StandardSchedule.RecurrenceType recurrence_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for recurrenceType.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTimeZone()

public String getTimeZone()

Required. The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris.

string time_zone = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The timeZone.

getTimeZoneBytes()

public ByteString getTimeZoneBytes()

Required. The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris.

string time_zone = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for timeZone.

getWeekDayOfMonth()

public WeekDayOfMonth getWeekDayOfMonth()

Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST MONDAY, on which jobs will run. This will be specified by two fields in WeekDayOfMonth, one for the day, e.g. MONDAY, and one for the week, e.g. LAST.

This field is only applicable for recurrence_type, MONTHLY and YEARLY. A validation error will occur if other values are supplied.

.google.cloud.backupdr.v1.WeekDayOfMonth week_day_of_month = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WeekDayOfMonth

The weekDayOfMonth.

getWeekDayOfMonthOrBuilder()

public WeekDayOfMonthOrBuilder getWeekDayOfMonthOrBuilder()

Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST MONDAY, on which jobs will run. This will be specified by two fields in WeekDayOfMonth, one for the day, e.g. MONDAY, and one for the week, e.g. LAST.

This field is only applicable for recurrence_type, MONTHLY and YEARLY. A validation error will occur if other values are supplied.

.google.cloud.backupdr.v1.WeekDayOfMonth week_day_of_month = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WeekDayOfMonthOrBuilder

hasBackupWindow()

public boolean hasBackupWindow()

Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as NOT_RUN if they do not start by the end of the window.

Note: running jobs will not be cancelled at the end of the window.

.google.cloud.backupdr.v1.BackupWindow backup_window = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the backupWindow field is set.

hasWeekDayOfMonth()

public boolean hasWeekDayOfMonth()

Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST MONDAY, on which jobs will run. This will be specified by two fields in WeekDayOfMonth, one for the day, e.g. MONDAY, and one for the week, e.g. LAST.

This field is only applicable for recurrence_type, MONTHLY and YEARLY. A validation error will occur if other values are supplied.

.google.cloud.backupdr.v1.WeekDayOfMonth week_day_of_month = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the weekDayOfMonth 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 StandardSchedule.Builder newBuilderForType()
Returns
Type Description
StandardSchedule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public StandardSchedule.Builder toBuilder()
Returns
Type Description
StandardSchedule.Builder

writeTo(CodedOutputStream output)

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