projects

PATCH /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}

Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.

Request

Base URL
https://aiplatform.googleapis.com
Auth
OAuth 2 and OAuth 2
Implicit: https://accounts.google.com/o/oauth2/auth
Scopes: https://www.googleapis.com/auth/cloud-platform
Authorization code: https://accounts.google.com/o/oauth2/auth
Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required

locationsIdstring required

schedulesIdstring required

Query parameters

updateMaskstring google-fieldmask

Required. The update mask applies to the resource. See google.protobuf.FieldMask.

Request body

allowQueueingboolean

Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.

catchUpboolean

Output only. 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. Default to false.

createTimestring google-datetime

Output only. Timestamp when this Schedule was created.

cronstring

Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".

displayNamestring

Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.

endTimestring google-datetime

Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.

lastPauseTimestring google-datetime

Output only. Timestamp when this Schedule was last paused. Unset if never paused.

lastResumeTimestring google-datetime

Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.

maxConcurrentActiveRunCountstring int64

Optional. Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest.

maxConcurrentRunCountstring int64

Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).

maxRunCountstring int64

Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.

namestring

Immutable. The resource name of the Schedule.

nextRunTimestring google-datetime

Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.

startTimestring google-datetime

Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.

startedRunCountstring int64

Output only. The number of runs started by this schedule.

state'STATE_UNSPECIFIED' | 'ACTIVE' | 'PAUSED' | 'COMPLETED'

Output only. The state of this Schedule.

updateTimestring google-datetime

Output only. Timestamp when this Schedule was updated.

Response

Successful response