Class StandardSchedule.Builder (0.13.0) 

public static final class StandardSchedule.Builder extends GeneratedMessageV3.Builder<StandardSchedule.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > StandardSchedule.Builder

Static Methods

getDescriptor()

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

Methods

addAllDaysOfMonth(Iterable<? extends Integer> values)

public StandardSchedule.Builder addAllDaysOfMonth(Iterable<? extends Integer> values)

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
values Iterable<? extends java.lang.Integer>

The daysOfMonth to add.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

addAllDaysOfWeek(Iterable<? extends DayOfWeek> values)

public StandardSchedule.Builder addAllDaysOfWeek(Iterable<? extends DayOfWeek> values)

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
values Iterable<? extends com.google.type.DayOfWeek>

The daysOfWeek to add.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

addAllDaysOfWeekValue(Iterable<Integer> values)

public StandardSchedule.Builder addAllDaysOfWeekValue(Iterable<Integer> values)

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
values Iterable<Integer>

The enum numeric values on the wire for daysOfWeek to add.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

addAllMonths(Iterable<? extends Month> values)

public StandardSchedule.Builder addAllMonths(Iterable<? extends Month> values)

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
values Iterable<? extends com.google.type.Month>

The months to add.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

addAllMonthsValue(Iterable<Integer> values)

public StandardSchedule.Builder addAllMonthsValue(Iterable<Integer> values)

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
values Iterable<Integer>

The enum numeric values on the wire for months to add.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

addDaysOfMonth(int value)

public StandardSchedule.Builder addDaysOfMonth(int value)

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
value int

The daysOfMonth to add.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

addDaysOfWeek(DayOfWeek value)

public StandardSchedule.Builder addDaysOfWeek(DayOfWeek value)

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
value com.google.type.DayOfWeek

The daysOfWeek to add.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

addDaysOfWeekValue(int value)

public StandardSchedule.Builder addDaysOfWeekValue(int value)

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
value int

The enum numeric value on the wire for daysOfWeek to add.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

addMonths(Month value)

public StandardSchedule.Builder addMonths(Month value)

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
value com.google.type.Month

The months to add.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

addMonthsValue(int value)

public StandardSchedule.Builder addMonthsValue(int value)

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
value int

The enum numeric value on the wire for months to add.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public StandardSchedule build()
Returns
Type Description
StandardSchedule

buildPartial()

public StandardSchedule buildPartial()
Returns
Type Description
StandardSchedule

clear()

public StandardSchedule.Builder clear()
Returns
Type Description
StandardSchedule.Builder
Overrides

clearBackupWindow()

public StandardSchedule.Builder clearBackupWindow()

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

clearDaysOfMonth()

public StandardSchedule.Builder clearDaysOfMonth()

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

This builder for chaining.

clearDaysOfWeek()

public StandardSchedule.Builder clearDaysOfWeek()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearHourlyFrequency()

public StandardSchedule.Builder clearHourlyFrequency()

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

This builder for chaining.

clearMonths()

public StandardSchedule.Builder clearMonths()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRecurrenceType()

public StandardSchedule.Builder clearRecurrenceType()

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

This builder for chaining.

clearTimeZone()

public StandardSchedule.Builder clearTimeZone()

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

This builder for chaining.

clearWeekDayOfMonth()

public StandardSchedule.Builder clearWeekDayOfMonth()

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

clone()

public StandardSchedule.Builder clone()
Returns
Type Description
StandardSchedule.Builder
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.

getBackupWindowBuilder()

public BackupWindow.Builder getBackupWindowBuilder()

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

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

getDescriptorForType()

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

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.

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.

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.

getWeekDayOfMonthBuilder()

public WeekDayOfMonth.Builder getWeekDayOfMonthBuilder()

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBackupWindow(BackupWindow value)

public StandardSchedule.Builder mergeBackupWindow(BackupWindow value)

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

Parameter
Name Description
value BackupWindow
Returns
Type Description
StandardSchedule.Builder

mergeFrom(StandardSchedule other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeWeekDayOfMonth(WeekDayOfMonth value)

public StandardSchedule.Builder mergeWeekDayOfMonth(WeekDayOfMonth value)

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

Parameter
Name Description
value WeekDayOfMonth
Returns
Type Description
StandardSchedule.Builder

setBackupWindow(BackupWindow value)

public StandardSchedule.Builder setBackupWindow(BackupWindow value)

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

Parameter
Name Description
value BackupWindow
Returns
Type Description
StandardSchedule.Builder

setBackupWindow(BackupWindow.Builder builderForValue)

public StandardSchedule.Builder setBackupWindow(BackupWindow.Builder builderForValue)

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

Parameter
Name Description
builderForValue BackupWindow.Builder
Returns
Type Description
StandardSchedule.Builder

setDaysOfMonth(int index, int value)

public StandardSchedule.Builder setDaysOfMonth(int index, int value)

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

Parameters
Name Description
index int

The index to set the value at.
value int

The daysOfMonth to set.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

setDaysOfWeek(int index, DayOfWeek value)

public StandardSchedule.Builder setDaysOfWeek(int index, DayOfWeek value)

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

Parameters
Name Description
index int

The index to set the value at.
value com.google.type.DayOfWeek

The daysOfWeek to set.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

setDaysOfWeekValue(int index, int value)

public StandardSchedule.Builder setDaysOfWeekValue(int index, int value)

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

Parameters
Name Description
index int

The index to set the value at.
value int

The enum numeric value on the wire for daysOfWeek to set.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setHourlyFrequency(int value)

public StandardSchedule.Builder setHourlyFrequency(int value)

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

Parameter
Name Description
value int

The hourlyFrequency to set.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

setMonths(int index, Month value)

public StandardSchedule.Builder setMonths(int index, Month value)

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

Parameters
Name Description
index int

The index to set the value at.
value com.google.type.Month

The months to set.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

setMonthsValue(int index, int value)

public StandardSchedule.Builder setMonthsValue(int index, int value)

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

Parameters
Name Description
index int

The index to set the value at.
value int

The enum numeric value on the wire for months to set.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

setRecurrenceType(StandardSchedule.RecurrenceType value)

public StandardSchedule.Builder setRecurrenceType(StandardSchedule.RecurrenceType value)

Required. Specifies the RecurrenceType for the schedule.

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

Parameter
Name Description
value StandardSchedule.RecurrenceType

The recurrenceType to set.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

setRecurrenceTypeValue(int value)

public StandardSchedule.Builder setRecurrenceTypeValue(int value)

Required. Specifies the RecurrenceType for the schedule.

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

Parameter
Name Description
value int

The enum numeric value on the wire for recurrenceType to set.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

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

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

setTimeZone(String value)

public StandardSchedule.Builder setTimeZone(String value)

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

Parameter
Name Description
value String

The timeZone to set.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

setTimeZoneBytes(ByteString value)

public StandardSchedule.Builder setTimeZoneBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for timeZone to set.
Returns
Type Description
StandardSchedule.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setWeekDayOfMonth(WeekDayOfMonth value)

public StandardSchedule.Builder setWeekDayOfMonth(WeekDayOfMonth value)

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

Parameter
Name Description
value WeekDayOfMonth
Returns
Type Description
StandardSchedule.Builder

setWeekDayOfMonth(WeekDayOfMonth.Builder builderForValue)

public StandardSchedule.Builder setWeekDayOfMonth(WeekDayOfMonth.Builder builderForValue)

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

Parameter
Name Description
builderForValue WeekDayOfMonth.Builder
Returns
Type Description
StandardSchedule.Builder