Class ExclusionWindow.Builder (0.47.0)

public static final class ExclusionWindow.Builder extends GeneratedMessageV3.Builder<ExclusionWindow.Builder> implements ExclusionWindowOrBuilder

Defines a time window during which no backup should happen. All time and date are in UTC.

Protobuf type google.cloud.gkebackup.v1.ExclusionWindow

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ExclusionWindow build()
Returns
Type Description
ExclusionWindow

buildPartial()

public ExclusionWindow buildPartial()
Returns
Type Description
ExclusionWindow

clear()

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

clearDaily()

public ExclusionWindow.Builder clearDaily()

The exclusion window occurs every day if set to "True". Specifying this field to "False" is an error.

bool daily = 4;

Returns
Type Description
ExclusionWindow.Builder

This builder for chaining.

clearDaysOfWeek()

public ExclusionWindow.Builder clearDaysOfWeek()

The exclusion window occurs on these days of each week in UTC.

.google.cloud.gkebackup.v1.ExclusionWindow.DayOfWeekList days_of_week = 5;

Returns
Type Description
ExclusionWindow.Builder

clearDuration()

public ExclusionWindow.Builder clearDuration()

Required. Specifies duration of the window. Duration must be >= 5 minutes and < (target RPO - 20 minutes). Additional restrictions based on the recurrence type to allow some time for backup to happen:

  • single_occurrence_date: no restriction, but UI may warn about this when duration >= target RPO
  • daily window: duration < 24 hours
  • weekly window:
    • days of week includes all seven days of a week: duration < 24 hours
    • all other weekly window: duration < 168 hours (i.e., 24 * 7 hours)

.google.protobuf.Duration duration = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ExclusionWindow.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRecurrence()

public ExclusionWindow.Builder clearRecurrence()
Returns
Type Description
ExclusionWindow.Builder

clearSingleOccurrenceDate()

public ExclusionWindow.Builder clearSingleOccurrenceDate()

No recurrence. The exclusion window occurs only once and on this date in UTC.

.google.type.Date single_occurrence_date = 3;

Returns
Type Description
ExclusionWindow.Builder

clearStartTime()

public ExclusionWindow.Builder clearStartTime()

Required. Specifies the start time of the window using time of the day in UTC.

.google.type.TimeOfDay start_time = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ExclusionWindow.Builder

clone()

public ExclusionWindow.Builder clone()
Returns
Type Description
ExclusionWindow.Builder
Overrides

getDaily()

public boolean getDaily()

The exclusion window occurs every day if set to "True". Specifying this field to "False" is an error.

bool daily = 4;

Returns
Type Description
boolean

The daily.

getDaysOfWeek()

public ExclusionWindow.DayOfWeekList getDaysOfWeek()

The exclusion window occurs on these days of each week in UTC.

.google.cloud.gkebackup.v1.ExclusionWindow.DayOfWeekList days_of_week = 5;

Returns
Type Description
ExclusionWindow.DayOfWeekList

The daysOfWeek.

getDaysOfWeekBuilder()

public ExclusionWindow.DayOfWeekList.Builder getDaysOfWeekBuilder()

The exclusion window occurs on these days of each week in UTC.

.google.cloud.gkebackup.v1.ExclusionWindow.DayOfWeekList days_of_week = 5;

Returns
Type Description
ExclusionWindow.DayOfWeekList.Builder

getDaysOfWeekOrBuilder()

public ExclusionWindow.DayOfWeekListOrBuilder getDaysOfWeekOrBuilder()

The exclusion window occurs on these days of each week in UTC.

.google.cloud.gkebackup.v1.ExclusionWindow.DayOfWeekList days_of_week = 5;

Returns
Type Description
ExclusionWindow.DayOfWeekListOrBuilder

getDefaultInstanceForType()

public ExclusionWindow getDefaultInstanceForType()
Returns
Type Description
ExclusionWindow

getDescriptorForType()

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

getDuration()

public Duration getDuration()

Required. Specifies duration of the window. Duration must be >= 5 minutes and < (target RPO - 20 minutes). Additional restrictions based on the recurrence type to allow some time for backup to happen:

  • single_occurrence_date: no restriction, but UI may warn about this when duration >= target RPO
  • daily window: duration < 24 hours
  • weekly window:
    • days of week includes all seven days of a week: duration < 24 hours
    • all other weekly window: duration < 168 hours (i.e., 24 * 7 hours)

.google.protobuf.Duration duration = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Duration

The duration.

getDurationBuilder()

public Duration.Builder getDurationBuilder()

Required. Specifies duration of the window. Duration must be >= 5 minutes and < (target RPO - 20 minutes). Additional restrictions based on the recurrence type to allow some time for backup to happen:

  • single_occurrence_date: no restriction, but UI may warn about this when duration >= target RPO
  • daily window: duration < 24 hours
  • weekly window:
    • days of week includes all seven days of a week: duration < 24 hours
    • all other weekly window: duration < 168 hours (i.e., 24 * 7 hours)

.google.protobuf.Duration duration = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Builder

getDurationOrBuilder()

public DurationOrBuilder getDurationOrBuilder()

Required. Specifies duration of the window. Duration must be >= 5 minutes and < (target RPO - 20 minutes). Additional restrictions based on the recurrence type to allow some time for backup to happen:

  • single_occurrence_date: no restriction, but UI may warn about this when duration >= target RPO
  • daily window: duration < 24 hours
  • weekly window:
    • days of week includes all seven days of a week: duration < 24 hours
    • all other weekly window: duration < 168 hours (i.e., 24 * 7 hours)

.google.protobuf.Duration duration = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DurationOrBuilder

getRecurrenceCase()

public ExclusionWindow.RecurrenceCase getRecurrenceCase()
Returns
Type Description
ExclusionWindow.RecurrenceCase

getSingleOccurrenceDate()

public Date getSingleOccurrenceDate()

No recurrence. The exclusion window occurs only once and on this date in UTC.

.google.type.Date single_occurrence_date = 3;

Returns
Type Description
com.google.type.Date

The singleOccurrenceDate.

getSingleOccurrenceDateBuilder()

public Date.Builder getSingleOccurrenceDateBuilder()

No recurrence. The exclusion window occurs only once and on this date in UTC.

.google.type.Date single_occurrence_date = 3;

Returns
Type Description
com.google.type.Date.Builder

getSingleOccurrenceDateOrBuilder()

public DateOrBuilder getSingleOccurrenceDateOrBuilder()

No recurrence. The exclusion window occurs only once and on this date in UTC.

.google.type.Date single_occurrence_date = 3;

Returns
Type Description
com.google.type.DateOrBuilder

getStartTime()

public TimeOfDay getStartTime()

Required. Specifies the start time of the window using time of the day in UTC.

.google.type.TimeOfDay start_time = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.type.TimeOfDay

The startTime.

getStartTimeBuilder()

public TimeOfDay.Builder getStartTimeBuilder()

Required. Specifies the start time of the window using time of the day in UTC.

.google.type.TimeOfDay start_time = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.type.TimeOfDay.Builder

getStartTimeOrBuilder()

public TimeOfDayOrBuilder getStartTimeOrBuilder()

Required. Specifies the start time of the window using time of the day in UTC.

.google.type.TimeOfDay start_time = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.type.TimeOfDayOrBuilder

hasDaily()

public boolean hasDaily()

The exclusion window occurs every day if set to "True". Specifying this field to "False" is an error.

bool daily = 4;

Returns
Type Description
boolean

Whether the daily field is set.

hasDaysOfWeek()

public boolean hasDaysOfWeek()

The exclusion window occurs on these days of each week in UTC.

.google.cloud.gkebackup.v1.ExclusionWindow.DayOfWeekList days_of_week = 5;

Returns
Type Description
boolean

Whether the daysOfWeek field is set.

hasDuration()

public boolean hasDuration()

Required. Specifies duration of the window. Duration must be >= 5 minutes and < (target RPO - 20 minutes). Additional restrictions based on the recurrence type to allow some time for backup to happen:

  • single_occurrence_date: no restriction, but UI may warn about this when duration >= target RPO
  • daily window: duration < 24 hours
  • weekly window:
    • days of week includes all seven days of a week: duration < 24 hours
    • all other weekly window: duration < 168 hours (i.e., 24 * 7 hours)

.google.protobuf.Duration duration = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the duration field is set.

hasSingleOccurrenceDate()

public boolean hasSingleOccurrenceDate()

No recurrence. The exclusion window occurs only once and on this date in UTC.

.google.type.Date single_occurrence_date = 3;

Returns
Type Description
boolean

Whether the singleOccurrenceDate field is set.

hasStartTime()

public boolean hasStartTime()

Required. Specifies the start time of the window using time of the day in UTC.

.google.type.TimeOfDay start_time = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the startTime field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDaysOfWeek(ExclusionWindow.DayOfWeekList value)

public ExclusionWindow.Builder mergeDaysOfWeek(ExclusionWindow.DayOfWeekList value)

The exclusion window occurs on these days of each week in UTC.

.google.cloud.gkebackup.v1.ExclusionWindow.DayOfWeekList days_of_week = 5;

Parameter
Name Description
value ExclusionWindow.DayOfWeekList
Returns
Type Description
ExclusionWindow.Builder

mergeDuration(Duration value)

public ExclusionWindow.Builder mergeDuration(Duration value)

Required. Specifies duration of the window. Duration must be >= 5 minutes and < (target RPO - 20 minutes). Additional restrictions based on the recurrence type to allow some time for backup to happen:

  • single_occurrence_date: no restriction, but UI may warn about this when duration >= target RPO
  • daily window: duration < 24 hours
  • weekly window:
    • days of week includes all seven days of a week: duration < 24 hours
    • all other weekly window: duration < 168 hours (i.e., 24 * 7 hours)

.google.protobuf.Duration duration = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Duration
Returns
Type Description
ExclusionWindow.Builder

mergeFrom(ExclusionWindow other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeSingleOccurrenceDate(Date value)

public ExclusionWindow.Builder mergeSingleOccurrenceDate(Date value)

No recurrence. The exclusion window occurs only once and on this date in UTC.

.google.type.Date single_occurrence_date = 3;

Parameter
Name Description
value com.google.type.Date
Returns
Type Description
ExclusionWindow.Builder

mergeStartTime(TimeOfDay value)

public ExclusionWindow.Builder mergeStartTime(TimeOfDay value)

Required. Specifies the start time of the window using time of the day in UTC.

.google.type.TimeOfDay start_time = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value com.google.type.TimeOfDay
Returns
Type Description
ExclusionWindow.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setDaily(boolean value)

public ExclusionWindow.Builder setDaily(boolean value)

The exclusion window occurs every day if set to "True". Specifying this field to "False" is an error.

bool daily = 4;

Parameter
Name Description
value boolean

The daily to set.

Returns
Type Description
ExclusionWindow.Builder

This builder for chaining.

setDaysOfWeek(ExclusionWindow.DayOfWeekList value)

public ExclusionWindow.Builder setDaysOfWeek(ExclusionWindow.DayOfWeekList value)

The exclusion window occurs on these days of each week in UTC.

.google.cloud.gkebackup.v1.ExclusionWindow.DayOfWeekList days_of_week = 5;

Parameter
Name Description
value ExclusionWindow.DayOfWeekList
Returns
Type Description
ExclusionWindow.Builder

setDaysOfWeek(ExclusionWindow.DayOfWeekList.Builder builderForValue)

public ExclusionWindow.Builder setDaysOfWeek(ExclusionWindow.DayOfWeekList.Builder builderForValue)

The exclusion window occurs on these days of each week in UTC.

.google.cloud.gkebackup.v1.ExclusionWindow.DayOfWeekList days_of_week = 5;

Parameter
Name Description
builderForValue ExclusionWindow.DayOfWeekList.Builder
Returns
Type Description
ExclusionWindow.Builder

setDuration(Duration value)

public ExclusionWindow.Builder setDuration(Duration value)

Required. Specifies duration of the window. Duration must be >= 5 minutes and < (target RPO - 20 minutes). Additional restrictions based on the recurrence type to allow some time for backup to happen:

  • single_occurrence_date: no restriction, but UI may warn about this when duration >= target RPO
  • daily window: duration < 24 hours
  • weekly window:
    • days of week includes all seven days of a week: duration < 24 hours
    • all other weekly window: duration < 168 hours (i.e., 24 * 7 hours)

.google.protobuf.Duration duration = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Duration
Returns
Type Description
ExclusionWindow.Builder

setDuration(Duration.Builder builderForValue)

public ExclusionWindow.Builder setDuration(Duration.Builder builderForValue)

Required. Specifies duration of the window. Duration must be >= 5 minutes and < (target RPO - 20 minutes). Additional restrictions based on the recurrence type to allow some time for backup to happen:

  • single_occurrence_date: no restriction, but UI may warn about this when duration >= target RPO
  • daily window: duration < 24 hours
  • weekly window:
    • days of week includes all seven days of a week: duration < 24 hours
    • all other weekly window: duration < 168 hours (i.e., 24 * 7 hours)

.google.protobuf.Duration duration = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ExclusionWindow.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setSingleOccurrenceDate(Date value)

public ExclusionWindow.Builder setSingleOccurrenceDate(Date value)

No recurrence. The exclusion window occurs only once and on this date in UTC.

.google.type.Date single_occurrence_date = 3;

Parameter
Name Description
value com.google.type.Date
Returns
Type Description
ExclusionWindow.Builder

setSingleOccurrenceDate(Date.Builder builderForValue)

public ExclusionWindow.Builder setSingleOccurrenceDate(Date.Builder builderForValue)

No recurrence. The exclusion window occurs only once and on this date in UTC.

.google.type.Date single_occurrence_date = 3;

Parameter
Name Description
builderForValue com.google.type.Date.Builder
Returns
Type Description
ExclusionWindow.Builder

setStartTime(TimeOfDay value)

public ExclusionWindow.Builder setStartTime(TimeOfDay value)

Required. Specifies the start time of the window using time of the day in UTC.

.google.type.TimeOfDay start_time = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value com.google.type.TimeOfDay
Returns
Type Description
ExclusionWindow.Builder

setStartTime(TimeOfDay.Builder builderForValue)

public ExclusionWindow.Builder setStartTime(TimeOfDay.Builder builderForValue)

Required. Specifies the start time of the window using time of the day in UTC.

.google.type.TimeOfDay start_time = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue com.google.type.TimeOfDay.Builder
Returns
Type Description
ExclusionWindow.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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