Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state
to 'ACTIVE'. Only paused Schedule can be resumed.
When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If [Schedule.catchUp][] is set up true, all missed runs will be scheduled for backfill first.
HTTP request
POST https://{service-endpoint}/v1/{name}:resume
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
Parameters | |
---|---|
name |
Required. The name of the Schedule resource to be resumed. Format: |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "catchUp": boolean } |
Fields | |
---|---|
catchUp |
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 |
Response body
If successful, the response body is empty.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the name
resource:
aiplatform.schedules.update
For more information, see the IAM documentation.