Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ResumeScheduleRequest.
Request message for ScheduleService.ResumeSchedule.
Generated from protobuf message google.cloud.aiplatform.v1.ResumeScheduleRequest
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The name of the Schedule resource to be resumed. Format: |
↳ catch_up |
bool
Optional. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. This will also update Schedule.catch_up field. Default to false. |
getName
Required. The name of the Schedule resource to be resumed.
Format:
projects/{project}/locations/{location}/schedules/{schedule}
Returns | |
---|---|
Type | Description |
string |
setName
Required. The name of the Schedule resource to be resumed.
Format:
projects/{project}/locations/{location}/schedules/{schedule}
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getCatchUp
Optional. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. This will also update Schedule.catch_up field.
Default to false.
Returns | |
---|---|
Type | Description |
bool |
setCatchUp
Optional. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. This will also update Schedule.catch_up field.
Default to false.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameter | |
---|---|
Name | Description |
name |
string
Required. The name of the Schedule resource to be resumed.
Format:
|
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\ResumeScheduleRequest |
static::buildFromNameCatchUp
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the Schedule resource to be resumed.
Format:
|
catchUp |
bool
Optional. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. This will also update Schedule.catch_up field. Default to false. |
Returns | |
---|---|
Type | Description |
Google\Cloud\AIPlatform\V1\ResumeScheduleRequest |