Class ExclusionWindow (0.43.0)

public final class ExclusionWindow extends GeneratedMessageV3 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 Fields

DAILY_FIELD_NUMBER

public static final int DAILY_FIELD_NUMBER
Field Value
Type Description
int

DAYS_OF_WEEK_FIELD_NUMBER

public static final int DAYS_OF_WEEK_FIELD_NUMBER
Field Value
Type Description
int

DURATION_FIELD_NUMBER

public static final int DURATION_FIELD_NUMBER
Field Value
Type Description
int

SINGLE_OCCURRENCE_DATE_FIELD_NUMBER

public static final int SINGLE_OCCURRENCE_DATE_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExclusionWindow getDefaultInstance()
Returns
Type Description
ExclusionWindow

getDescriptor()

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

newBuilder()

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

newBuilder(ExclusionWindow prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

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

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.

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

getParserForType()

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

getRecurrenceCase()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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