Optional. timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Optional. timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either endTime is reached or when scheduled_run_count >= maxRunCount. 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.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either startedRunCount >= maxRunCount or when endTime 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.
Output only. timestamp when this Schedule was created.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Output only. timestamp when this Schedule was updated.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Output only. timestamp when this Schedule should schedule the next run. Having a nextRunTime in the past means the runs are being started behind schedule.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Output only. timestamp when this Schedule was last paused. Unset if never paused.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Output only. timestamp when this Schedule was last resumed. Unset if never resumed from pause.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
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).
allowQueueing
boolean
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.
catchUp
boolean
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.
Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.
time_specification
Union type
Required. The time specification to launch scheduled runs. time_specification can be only one of the following:
cron
string
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 * * * *".
request
Union type
Required. The API request template to launch the scheduled runs. User-specified ID is not supported in the request template. request can be only one of the following:
The id to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an id will be automatically generated.
This value should be less than 128 characters, and valid characters are /[a-z][0-9]-/.
The Schedule is active. Runs are being scheduled on the user-specified timespec.
PAUSED
The schedule is paused. No new runs will be created until the schedule is resumed. Already started runs will be allowed to complete.
COMPLETED
The Schedule is completed. No new runs will be scheduled. Already started runs will be allowed to complete. Schedules in completed state cannot be paused or resumed.
The scheduled run time based on the user-specified schedule.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[],[],null,["# REST Resource: projects.locations.schedules\n\nResource: Schedule\n------------------\n\nAn instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.\nFields `name` `string` \nImmutable. The resource name of the Schedule.\n`displayName` `string` \nRequired. user provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.\n`startTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOptional. timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`endTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOptional. timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either endTime is reached or when scheduled_run_count \\\u003e= maxRunCount. 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.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`maxRunCount` `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` \nOptional. Maximum run count of the schedule. If specified, The schedule will be completed when either startedRunCount \\\u003e= maxRunCount or when endTime 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.\n`startedRunCount` `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` \nOutput only. The number of runs started by this schedule.\n`state` `enum (`[State](/vertex-ai/docs/reference/rest/v1/projects.locations.schedules#State)`)` \nOutput only. The state of this Schedule.\n`createTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. timestamp when this Schedule was created.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`updateTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. timestamp when this Schedule was updated.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`nextRunTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. timestamp when this Schedule should schedule the next run. Having a nextRunTime in the past means the runs are being started behind schedule.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`lastPauseTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. timestamp when this Schedule was last paused. Unset if never paused.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`lastResumeTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. timestamp when this Schedule was last resumed. Unset if never resumed from pause.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`maxConcurrentRunCount` `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` \nRequired. 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).\n`allowQueueing` `boolean` \nOptional. 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.\n`catchUp` `boolean` \nOutput 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.\n`lastScheduledRunResponse` `object (`[RunResponse](/vertex-ai/docs/reference/rest/v1/projects.locations.schedules#RunResponse)`)` \nOutput only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet. \n`time_specification` `Union type` \nRequired. The time specification to launch scheduled runs. `time_specification` can be only one of the following:\n`cron` `string` \nCron schedule (\u003chttps://en.wikipedia.org/wiki/Cron\u003e) 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 \\* \\* \\* \\*\". \n`request` `Union type` \nRequired. The API request template to launch the scheduled runs. User-specified ID is not supported in the request template. `request` can be only one of the following:\n`createPipelineJobRequest` `object (`[CreatePipelineJobRequest](/vertex-ai/docs/reference/rest/v1/projects.locations.schedules#CreatePipelineJobRequest)`)` \nRequest for [PipelineService.CreatePipelineJob](/vertex-ai/docs/reference/rest/v1/projects.locations.pipelineJobs/create#google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob). CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).\n`createNotebookExecutionJobRequest` `object (`[CreateNotebookExecutionJobRequest](/vertex-ai/docs/reference/rest/v1/projects.locations.schedules#CreateNotebookExecutionJobRequest)`)` \nRequest for [NotebookService.CreateNotebookExecutionJob](/vertex-ai/docs/reference/rest/v1/projects.locations.notebookExecutionJobs/create#google.cloud.aiplatform.v1.NotebookService.CreateNotebookExecutionJob). \n\nCreatePipelineJobRequest\n------------------------\n\nRequest message for [PipelineService.CreatePipelineJob](/vertex-ai/docs/reference/rest/v1/projects.locations.pipelineJobs/create#google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob).\nFields `parent` `string` \nRequired. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`\n`pipelineJob` `object (`[PipelineJob](/vertex-ai/docs/reference/rest/v1/projects.locations.pipelineJobs#PipelineJob)`)` \nRequired. The PipelineJob to create.\n`pipelineJobId` `string` \nThe id to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an id will be automatically generated.\n\nThis value should be less than 128 characters, and valid characters are `/[a-z][0-9]-/`. \n\nCreateNotebookExecutionJobRequest\n---------------------------------\n\nRequest message for \\[NotebookService.CreateNotebookExecutionJob\\]\nFields `parent` `string` \nRequired. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`\n`notebookExecutionJob` `object (`[NotebookExecutionJob](/vertex-ai/docs/reference/rest/v1/projects.locations.notebookExecutionJobs#NotebookExecutionJob)`)` \nRequired. The NotebookExecutionJob to create.\n`notebookExecutionJobId` `string` \nOptional. user specified id for the NotebookExecutionJob. \n\nState\n-----\n\nPossible state of the schedule.\n\nRunResponse\n-----------\n\nstatus of a scheduled run.\nFields `scheduledRunTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nThe scheduled run time based on the user-specified schedule.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`runResponse` `string` \nThe response of the scheduled run."]]
