Class StandardSchedule.Builder (0.34.0)
Stay organized with collections
Save and categorize content based on your preferences.
publicstaticfinalclass StandardSchedule.BuilderextendsGeneratedMessageV3.Builder<StandardSchedule.Builder>implementsStandardScheduleOrBuilder 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.BuilderImplements
StandardScheduleOrBuilderInherited Members
Static Methods
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllDaysOfMonth(Iterable<? extends Integer> values)
publicStandardSchedule.BuilderaddAllDaysOfMonth(Iterable<?extendsInteger>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)
publicStandardSchedule.BuilderaddAllDaysOfWeek(Iterable<?extendsDayOfWeek>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)
publicStandardSchedule.BuilderaddAllDaysOfWeekValue(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)
publicStandardSchedule.BuilderaddAllMonths(Iterable<?extendsMonth>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)
publicStandardSchedule.BuilderaddAllMonthsValue(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)
publicStandardSchedule.BuilderaddDaysOfMonth(intvalue)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)
publicStandardSchedule.BuilderaddDaysOfWeek(DayOfWeekvalue)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.DayOfWeekThe daysOfWeek to add. |
| Returns | |
|---|---|
| Type | Description |
StandardSchedule.Builder |
This builder for chaining. |
addDaysOfWeekValue(int value)
publicStandardSchedule.BuilderaddDaysOfWeekValue(intvalue)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)
publicStandardSchedule.BuilderaddMonths(Monthvalue) 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.MonthThe months to add. |
| Returns | |
|---|---|
| Type | Description |
StandardSchedule.Builder |
This builder for chaining. |
addMonthsValue(int value)
publicStandardSchedule.BuilderaddMonthsValue(intvalue) 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)
publicStandardSchedule.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
StandardSchedule.Builder |
|
build()
publicStandardSchedulebuild()| Returns | |
|---|---|
| Type | Description |
StandardSchedule |
|
buildPartial()
publicStandardSchedulebuildPartial()| Returns | |
|---|---|
| Type | Description |
StandardSchedule |
|
clear()
publicStandardSchedule.Builderclear()| Returns | |
|---|---|
| Type | Description |
StandardSchedule.Builder |
|
clearBackupWindow()
publicStandardSchedule.BuilderclearBackupWindow() 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()
publicStandardSchedule.BuilderclearDaysOfMonth()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()
publicStandardSchedule.BuilderclearDaysOfWeek()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)
publicStandardSchedule.BuilderclearField(Descriptors.FieldDescriptorfield)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
StandardSchedule.Builder |
|
clearHourlyFrequency()
publicStandardSchedule.BuilderclearHourlyFrequency()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 4 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()
publicStandardSchedule.BuilderclearMonths() 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)
publicStandardSchedule.BuilderclearOneof(Descriptors.OneofDescriptoroneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
StandardSchedule.Builder |
|
clearRecurrenceType()
publicStandardSchedule.BuilderclearRecurrenceType() 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()
publicStandardSchedule.BuilderclearTimeZone()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()
publicStandardSchedule.BuilderclearWeekDayOfMonth() 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()
publicStandardSchedule.Builderclone()| Returns | |
|---|---|
| Type | Description |
StandardSchedule.Builder |
|
getBackupWindow()
publicBackupWindowgetBackupWindow() 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()
publicBackupWindow.BuildergetBackupWindowBuilder() 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()
publicBackupWindowOrBuildergetBackupWindowOrBuilder() 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)
publicintgetDaysOfMonth(intindex)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()
publicintgetDaysOfMonthCount()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()
publicList<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)
publicDayOfWeekgetDaysOfWeek(intindex)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()
publicintgetDaysOfWeekCount()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()
publicList<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)
publicintgetDaysOfWeekValue(intindex)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()
publicList<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()
publicStandardSchedulegetDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
StandardSchedule |
|
getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getHourlyFrequency()
publicintgetHourlyFrequency()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 4 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)
publicMonthgetMonths(intindex) 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()
publicintgetMonthsCount() 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()
publicList<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)
publicintgetMonthsValue(intindex) 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()
publicList<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()
publicStandardSchedule.RecurrenceTypegetRecurrenceType() 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()
publicintgetRecurrenceTypeValue() 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()
publicStringgetTimeZone()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()
publicByteStringgetTimeZoneBytes()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()
publicWeekDayOfMonthgetWeekDayOfMonth() 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()
publicWeekDayOfMonth.BuildergetWeekDayOfMonthBuilder() 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()
publicWeekDayOfMonthOrBuildergetWeekDayOfMonthOrBuilder() 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()
publicbooleanhasBackupWindow() 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()
publicbooleanhasWeekDayOfMonth() 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()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeBackupWindow(BackupWindow value)
publicStandardSchedule.BuildermergeBackupWindow(BackupWindowvalue) 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)
publicStandardSchedule.BuildermergeFrom(StandardScheduleother)| Parameter | |
|---|---|
| Name | Description |
other |
StandardSchedule |
| Returns | |
|---|---|
| Type | Description |
StandardSchedule.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicStandardSchedule.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StandardSchedule.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
publicStandardSchedule.BuildermergeFrom(Messageother)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
StandardSchedule.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
publicfinalStandardSchedule.BuildermergeUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
StandardSchedule.Builder |
|
mergeWeekDayOfMonth(WeekDayOfMonth value)
publicStandardSchedule.BuildermergeWeekDayOfMonth(WeekDayOfMonthvalue) 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)
publicStandardSchedule.BuildersetBackupWindow(BackupWindowvalue) 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)
publicStandardSchedule.BuildersetBackupWindow(BackupWindow.BuilderbuilderForValue) 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)
publicStandardSchedule.BuildersetDaysOfMonth(intindex,intvalue)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)
publicStandardSchedule.BuildersetDaysOfWeek(intindex,DayOfWeekvalue)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.DayOfWeekThe daysOfWeek to set. |
| Returns | |
|---|---|
| Type | Description |
StandardSchedule.Builder |
This builder for chaining. |
setDaysOfWeekValue(int index, int value)
publicStandardSchedule.BuildersetDaysOfWeekValue(intindex,intvalue)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)
publicStandardSchedule.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
StandardSchedule.Builder |
|
setHourlyFrequency(int value)
publicStandardSchedule.BuildersetHourlyFrequency(intvalue)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 4 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)
publicStandardSchedule.BuildersetMonths(intindex,Monthvalue) 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.MonthThe months to set. |
| Returns | |
|---|---|
| Type | Description |
StandardSchedule.Builder |
This builder for chaining. |
setMonthsValue(int index, int value)
publicStandardSchedule.BuildersetMonthsValue(intindex,intvalue) 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)
publicStandardSchedule.BuildersetRecurrenceType(StandardSchedule.RecurrenceTypevalue) 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)
publicStandardSchedule.BuildersetRecurrenceTypeValue(intvalue) 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)
publicStandardSchedule.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
StandardSchedule.Builder |
|
setTimeZone(String value)
publicStandardSchedule.BuildersetTimeZone(Stringvalue)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)
publicStandardSchedule.BuildersetTimeZoneBytes(ByteStringvalue)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)
publicfinalStandardSchedule.BuildersetUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
StandardSchedule.Builder |
|
setWeekDayOfMonth(WeekDayOfMonth value)
publicStandardSchedule.BuildersetWeekDayOfMonth(WeekDayOfMonthvalue) 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)
publicStandardSchedule.BuildersetWeekDayOfMonth(WeekDayOfMonth.BuilderbuilderForValue) 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 |
|