Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132661,4471.5 MB
projects

Creates a NotebookExecutionJob.

post/v1/{+parent}/notebookExecutionJobs

Path parameters

parentstring required

Required. The resource name of the Location to create the NotebookExecutionJob. Format: projects/{project}/locations/{location}

Query parameters

notebookExecutionJobIdstring

Optional. User specified ID for the NotebookExecutionJob.

Request body

executionTimeoutstring google-duration

Max running time of the execution job in seconds (default 86400s / 24 hrs).

executionUserstring

The user email to run the execution as. Only supported by Colab runtimes.

notebookRuntimeTemplateResourceNamestring

The NotebookRuntimeTemplate to source compute configuration from.

gcsOutputUristring

The Cloud Storage location to upload the result to. Format: gs://bucket-name

displayNamestring

The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

namestring

Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}

serviceAccountstring

The service account to run the execution as.

updateTimestring google-datetime

Output only. Timestamp when this NotebookExecutionJob was most recently updated.

labelsobject

The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

jobState'JOB_STATE_UNSPECIFIED' | 'JOB_STATE_QUEUED' | 'JOB_STATE_PENDING' | 'JOB_STATE_RUNNING' | 'JOB_STATE_SUCCEEDED' | 'JOB_STATE_FAILED' | 'JOB_STATE_CANCELLING' | 'JOB_STATE_CANCELLED' | 'JOB_STATE_PAUSED' | 'JOB_STATE_EXPIRED' | 'JOB_STATE_UPDATING' | 'JOB_STATE_PARTIALLY_SUCCEEDED'

Output only. The state of the NotebookExecutionJob.

createTimestring google-datetime

Output only. Timestamp when this NotebookExecutionJob was created.

kernelNamestring

The name of the kernel to use during notebook execution. If unset, the default kernel is used.

scheduleResourceNamestring

The Schedule resource name if this job is triggered by one. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

workbenchRuntimeGoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime

Configuration for a Workbench Instances-based environment.

Response

Successful response