Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class ExclusionWindow.
Defines a time window during which no backup should happen. All time and date are in UTC.
Generated from protobuf message google.cloud.gkebackup.v1.ExclusionWindow
Namespace
Google \ Cloud \ GkeBackup \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ start_time |
Google\Type\TimeOfDay
Required. Specifies the start time of the window using time of the day in UTC. |
↳ duration |
Google\Protobuf\Duration
Required. Specifies duration of the window. Restrictions for duration 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) |
↳ single_occurrence_date |
Google\Type\Date
No recurrence. The exclusion window occurs only once and on this date in UTC. |
↳ daily |
bool
The exclusion window occurs every day if set to "True". Specifying this field to "False" is an error. |
↳ days_of_week |
Google\Cloud\GkeBackup\V1\ExclusionWindow\DayOfWeekList
The exclusion window occurs on these days of each week in UTC. |
getStartTime
Required. Specifies the start time of the window using time of the day in UTC.
| Returns | |
|---|---|
| Type | Description |
Google\Type\TimeOfDay|null |
|
hasStartTime
clearStartTime
setStartTime
Required. Specifies the start time of the window using time of the day in UTC.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\TimeOfDay
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDuration
Required. Specifies duration of the window. Restrictions for duration 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)
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasDuration
clearDuration
setDuration
Required. Specifies duration of the window. Restrictions for duration 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)
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSingleOccurrenceDate
No recurrence. The exclusion window occurs only once and on this date in UTC.
| Returns | |
|---|---|
| Type | Description |
Google\Type\Date|null |
|
hasSingleOccurrenceDate
setSingleOccurrenceDate
No recurrence. The exclusion window occurs only once and on this date in UTC.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\Date
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDaily
The exclusion window occurs every day if set to "True".
Specifying this field to "False" is an error.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasDaily
setDaily
The exclusion window occurs every day if set to "True".
Specifying this field to "False" is an error.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDaysOfWeek
The exclusion window occurs on these days of each week in UTC.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeBackup\V1\ExclusionWindow\DayOfWeekList|null |
|
hasDaysOfWeek
setDaysOfWeek
The exclusion window occurs on these days of each week in UTC.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeBackup\V1\ExclusionWindow\DayOfWeekList
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRecurrence
| Returns | |
|---|---|
| Type | Description |
string |
|