schedules

Creates, updates, deletes, gets or lists a schedules resource.

Overview

Name	schedules
Type	Resource
Id	google.aiplatform.schedules

Fields

Name	Datatype	Description
name	string	Immutable. The resource name of the Schedule.
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.
createNotebookExecutionJobRequest	object	Request message for [NotebookService.CreateNotebookExecutionJob]
createPipelineJobRequest	object	Request message for PipelineService.CreatePipelineJob.
createTime	string	Output only. Timestamp when this Schedule was created.
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 * * *".
displayName	string	Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.
endTime	string	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.
lastPauseTime	string	Output only. Timestamp when this Schedule was last paused. Unset if never paused.
lastResumeTime	string	Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.
lastScheduledRunResponse	object	Status of a scheduled run.
maxConcurrentRunCount	string	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).
maxRunCount	string	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.
nextRunTime	string	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.
startTime	string	Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
startedRunCount	string	Output only. The number of runs started by this schedule.
state	string	Output only. The state of this Schedule.
updateTime	string	Output only. Timestamp when this Schedule was updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, projectsId, schedulesId	Gets a Schedule.
list	SELECT	locationsId, projectsId	Lists Schedules in a Location.
create	INSERT	locationsId, projectsId	Creates a Schedule.
delete	DELETE	locationsId, projectsId, schedulesId	Deletes a Schedule.
patch	UPDATE	locationsId, projectsId, 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.
pause	EXEC	locationsId, projectsId, schedulesId	Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.
resume	EXEC	locationsId, projectsId, schedulesId	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.

SELECT examples

Lists Schedules in a Location.

SELECT
name,
allowQueueing,
catchUp,
createNotebookExecutionJobRequest,
createPipelineJobRequest,
createTime,
cron,
displayName,
endTime,
lastPauseTime,
lastResumeTime,
lastScheduledRunResponse,
maxConcurrentRunCount,
maxRunCount,
nextRunTime,
startTime,
startedRunCount,
state,
updateTime
FROM google.aiplatform.schedules
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new schedules resource.

All Properties

/*+ create */
INSERT INTO google.aiplatform.schedules (
locationsId,
projectsId,
displayName,
allowQueueing,
cron,
endTime,
createNotebookExecutionJobRequest,
maxConcurrentRunCount,
maxRunCount,
startTime,
name,
createPipelineJobRequest
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ displayName }}',
{{ allowQueueing }},
'{{ cron }}',
'{{ endTime }}',
'{{ createNotebookExecutionJobRequest }}',
'{{ maxConcurrentRunCount }}',
'{{ maxRunCount }}',
'{{ startTime }}',
'{{ name }}',
'{{ createPipelineJobRequest }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: lastPauseTime
      value: string
    - name: displayName
      value: string
    - name: nextRunTime
      value: string
    - name: lastScheduledRunResponse
      value:
        - name: runResponse
          value: string
        - name: scheduledRunTime
          value: string
    - name: allowQueueing
      value: boolean
    - name: createTime
      value: string
    - name: startedRunCount
      value: string
    - name: lastResumeTime
      value: string
    - name: cron
      value: string
    - name: endTime
      value: string
    - name: createNotebookExecutionJobRequest
      value:
        - name: notebookExecutionJobId
          value: string
        - name: parent
          value: string
        - name: notebookExecutionJob
          value:
            - name: scheduleResourceName
              value: string
            - name: executionTimeout
              value: string
            - name: notebookRuntimeTemplateResourceName
              value: string
            - name: createTime
              value: string
            - name: labels
              value: object
            - name: directNotebookSource
              value:
                - name: content
                  value: string
            - name: name
              value: string
            - name: displayName
              value: string
            - name: updateTime
              value: string
            - name: serviceAccount
              value: string
            - name: status
              value:
                - name: code
                  value: integer
                - name: message
                  value: string
                - name: details
                  value:
                    - object
            - name: jobState
              value: string
            - name: gcsNotebookSource
              value:
                - name: uri
                  value: string
                - name: generation
                  value: string
            - name: executionUser
              value: string
            - name: gcsOutputUri
              value: string
            - name: encryptionSpec
              value:
                - name: kmsKeyName
                  value: string
            - name: dataformRepositorySource
              value:
                - name: commitSha
                  value: string
                - name: dataformRepositoryResourceName
                  value: string
    - name: catchUp
      value: boolean
    - name: maxConcurrentRunCount
      value: string
    - name: state
      value: string
    - name: maxRunCount
      value: string
    - name: startTime
      value: string
    - name: name
      value: string
    - name: createPipelineJobRequest
      value:
        - name: pipelineJobId
          value: string
        - name: parent
          value: string
        - name: pipelineJob
          value:
            - name: pipelineSpec
              value: object
            - name: displayName
              value: string
            - name: templateMetadata
              value:
                - name: version
                  value: string
            - name: network
              value: string
            - name: preflightValidations
              value: boolean
            - name: startTime
              value: string
            - name: labels
              value: object
            - name: createTime
              value: string
            - name: updateTime
              value: string
            - name: templateUri
              value: string
            - name: scheduleName
              value: string
            - name: name
              value: string
            - name: endTime
              value: string
            - name: state
              value: string
            - name: jobDetail
              value:
                - name: pipelineRunContext
                  value:
                    - name: parentContexts
                      value:
                        - string
                    - name: schemaVersion
                      value: string
                    - name: etag
                      value: string
                    - name: schemaTitle
                      value: string
                    - name: description
                      value: string
                    - name: updateTime
                      value: string
                    - name: name
                      value: string
                    - name: labels
                      value: object
                    - name: displayName
                      value: string
                    - name: metadata
                      value: object
                    - name: createTime
                      value: string
                - name: taskDetails
                  value:
                    - - name: executorDetail
                        value:
                          - name: containerDetail
                            value:
                              - name: failedPreCachingCheckJobs
                                value:
                                  - string
                              - name: mainJob
                                value: string
                              - name: preCachingCheckJob
                                value: string
                              - name: failedMainJobs
                                value:
                                  - string
                          - name: customJobDetail
                            value:
                              - name: failedJobs
                                value:
                                  - string
                              - name: job
                                value: string
                      - name: inputs
                        value: object
                      - name: execution
                        value:
                          - name: schemaVersion
                            value: string
                          - name: metadata
                            value: object
                          - name: createTime
                            value: string
                          - name: labels
                            value: object
                          - name: name
                            value: string
                          - name: updateTime
                            value: string
                          - name: displayName
                            value: string
                          - name: description
                            value: string
                          - name: state
                            value: string
                          - name: schemaTitle
                            value: string
                          - name: etag
                            value: string
                      - name: pipelineTaskStatus
                        value:
                          - - name: updateTime
                              value: string
                            - name: state
                              value: string
                      - name: taskName
                        value: string
                      - name: createTime
                        value: string
                      - name: outputs
                        value: object
                      - name: endTime
                        value: string
                      - name: parentTaskId
                        value: string
                      - name: state
                        value: string
                      - name: startTime
                        value: string
                      - name: taskId
                        value: string
            - name: serviceAccount
              value: string
            - name: reservedIpRanges
              value:
                - string
            - name: runtimeConfig
              value:
                - name: failurePolicy
                  value: string
                - name: inputArtifacts
                  value: object
                - name: parameters
                  value: object
                - name: parameterValues
                  value: object
                - name: gcsOutputDirectory
                  value: string
    - name: updateTime
      value: string

UPDATE example

Updates a schedules resource.

/*+ update */
UPDATE google.aiplatform.schedules
SET 
displayName = '{{ displayName }}',
allowQueueing = true|false,
cron = '{{ cron }}',
endTime = '{{ endTime }}',
createNotebookExecutionJobRequest = '{{ createNotebookExecutionJobRequest }}',
maxConcurrentRunCount = '{{ maxConcurrentRunCount }}',
maxRunCount = '{{ maxRunCount }}',
startTime = '{{ startTime }}',
name = '{{ name }}',
createPipelineJobRequest = '{{ createPipelineJobRequest }}'
WHERE 
locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND schedulesId = '{{ schedulesId }}';

DELETE example

Deletes the specified schedules resource.

/*+ delete */
DELETE FROM google.aiplatform.schedules
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND schedulesId = '{{ schedulesId }}';