Reference documentation and code samples for the Google Cloud Orchestration Airflow V1 Client class MaintenanceWindow.
The configuration settings for Cloud Composer maintenance window.
The following example:
{
"startTime":"2019-08-01T01:00:00Z"
"endTime":"2019-08-01T07:00:00Z"
"recurrence":"FREQ=WEEKLY;BYDAY=TU,WE"
}
would define a maintenance window between 01 and 07 hours UTC during each Tuesday and Wednesday.
Generated from protobuf message google.cloud.orchestration.airflow.service.v1.MaintenanceWindow
Namespace
Google \ Cloud \ Orchestration \ Airflow \ Service \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ start_time |
Google\Protobuf\Timestamp
Required. Start time of the first recurrence of the maintenance window. |
↳ end_time |
Google\Protobuf\Timestamp
Required. Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end-time must be in the future, relative to |
↳ recurrence |
string
Required. Maintenance window recurrence. Format is a subset of RFC-5545 |
getStartTime
Required. Start time of the first recurrence of the maintenance window.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasStartTime
clearStartTime
setStartTime
Required. Start time of the first recurrence of the maintenance window.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getEndTime
Required. Maintenance window end time. It is used only to calculate the
duration of the maintenance window. The value for end-time must be in the
future, relative to start_time
.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasEndTime
clearEndTime
setEndTime
Required. Maintenance window end time. It is used only to calculate the
duration of the maintenance window. The value for end-time must be in the
future, relative to start_time
.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getRecurrence
Required. Maintenance window recurrence. Format is a subset of
RFC-5545 RRULE
. The only allowed
values for FREQ
field are FREQ=DAILY
and FREQ=WEEKLY;BYDAY=...
Example values: FREQ=WEEKLY;BYDAY=TU,WE
, FREQ=DAILY
.
Returns | |
---|---|
Type | Description |
string |
setRecurrence
Required. Maintenance window recurrence. Format is a subset of
RFC-5545 RRULE
. The only allowed
values for FREQ
field are FREQ=DAILY
and FREQ=WEEKLY;BYDAY=...
Example values: FREQ=WEEKLY;BYDAY=TU,WE
, FREQ=DAILY
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |