notebook_execution_jobs

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

Overview

Name	notebook_execution_jobs
Type	Resource
Id	google.aiplatform.notebook_execution_jobs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}
createTime	string (google-datetime)	Output only. Timestamp when this NotebookExecutionJob was created.
customEnvironmentSpec	object	The custom compute configuration for an execution job. (id: GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec)
dataformRepositorySource	object	The Dataform Repository pointing to a single file notebook repository. (id: GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource)
directNotebookSource	object	The contents of an input notebook file. (id: GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource)
displayName	string	The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec	object	Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec. (id: GoogleCloudAiplatformV1EncryptionSpec)
executionTimeout	string (google-duration)	Max running time of the execution job in seconds (default 86400s / 24 hrs).
executionUser	string	The user email to run the execution as. Only supported by Colab runtimes.
gcsNotebookSource	object	The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb (id: GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource)
gcsOutputUri	string	The Cloud Storage location to upload the result to. Format: gs://bucket-name
jobState	string	Output only. The state of the NotebookExecutionJob. (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)
kernelName	string	The name of the kernel to use during notebook execution. If unset, the default kernel is used.
labels	object	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.
notebookRuntimeTemplateResourceName	string	The NotebookRuntimeTemplate to source compute configuration from.
scheduleResourceName	string	The Schedule resource name if this job is triggered by one. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}
serviceAccount	string	The service account to run the execution as.
status	object	The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. (id: GoogleRpcStatus)
updateTime	string (google-datetime)	Output only. Timestamp when this NotebookExecutionJob was most recently updated.
workbenchRuntime	object	The Workbench runtime configuration to use for the notebook execution. (id: GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime)

list

Name	Datatype	Description
name	string	Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}
createTime	string (google-datetime)	Output only. Timestamp when this NotebookExecutionJob was created.
customEnvironmentSpec	object	The custom compute configuration for an execution job. (id: GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec)
dataformRepositorySource	object	The Dataform Repository pointing to a single file notebook repository. (id: GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource)
directNotebookSource	object	The contents of an input notebook file. (id: GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource)
displayName	string	The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec	object	Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec. (id: GoogleCloudAiplatformV1EncryptionSpec)
executionTimeout	string (google-duration)	Max running time of the execution job in seconds (default 86400s / 24 hrs).
executionUser	string	The user email to run the execution as. Only supported by Colab runtimes.
gcsNotebookSource	object	The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb (id: GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource)
gcsOutputUri	string	The Cloud Storage location to upload the result to. Format: gs://bucket-name
jobState	string	Output only. The state of the NotebookExecutionJob. (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)
kernelName	string	The name of the kernel to use during notebook execution. If unset, the default kernel is used.
labels	object	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.
notebookRuntimeTemplateResourceName	string	The NotebookRuntimeTemplate to source compute configuration from.
scheduleResourceName	string	The Schedule resource name if this job is triggered by one. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}
serviceAccount	string	The service account to run the execution as.
status	object	The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. (id: GoogleRpcStatus)
updateTime	string (google-datetime)	Output only. Timestamp when this NotebookExecutionJob was most recently updated.
workbenchRuntime	object	The Workbench runtime configuration to use for the notebook execution. (id: GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, notebookExecutionJobsId	view	Gets a NotebookExecutionJob.
list	select	projectsId, locationsId	pageToken, orderBy, filter, pageSize, view	Lists NotebookExecutionJobs in a Location.
create	insert	projectsId, locationsId	notebookExecutionJobId	Creates a NotebookExecutionJob.
delete	delete	projectsId, locationsId, notebookExecutionJobsId		Deletes a NotebookExecutionJob.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
notebookExecutionJobsId	string
projectsId	string
filter	string
notebookExecutionJobId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
view	string

SELECT examples

get

Gets a NotebookExecutionJob.

SELECT
name,
createTime,
customEnvironmentSpec,
dataformRepositorySource,
directNotebookSource,
displayName,
encryptionSpec,
executionTimeout,
executionUser,
gcsNotebookSource,
gcsOutputUri,
jobState,
kernelName,
labels,
notebookRuntimeTemplateResourceName,
scheduleResourceName,
serviceAccount,
status,
updateTime,
workbenchRuntime
FROM google.aiplatform.notebook_execution_jobs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND notebookExecutionJobsId = '{{ notebookExecutionJobsId }}' -- required
AND view = '{{ view }}'
;

list

Lists NotebookExecutionJobs in a Location.

SELECT
name,
createTime,
customEnvironmentSpec,
dataformRepositorySource,
directNotebookSource,
displayName,
encryptionSpec,
executionTimeout,
executionUser,
gcsNotebookSource,
gcsOutputUri,
jobState,
kernelName,
labels,
notebookRuntimeTemplateResourceName,
scheduleResourceName,
serviceAccount,
status,
updateTime,
workbenchRuntime
FROM google.aiplatform.notebook_execution_jobs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND view = '{{ view }}'
;

INSERT examples

create

Creates a NotebookExecutionJob.

INSERT INTO google.aiplatform.notebook_execution_jobs (
data__notebookRuntimeTemplateResourceName,
data__directNotebookSource,
data__customEnvironmentSpec,
data__workbenchRuntime,
data__executionUser,
data__displayName,
data__encryptionSpec,
data__gcsOutputUri,
data__executionTimeout,
data__labels,
data__dataformRepositorySource,
data__kernelName,
data__scheduleResourceName,
data__gcsNotebookSource,
data__serviceAccount,
projectsId,
locationsId,
notebookExecutionJobId
)
SELECT 
'{{ notebookRuntimeTemplateResourceName }}',
'{{ directNotebookSource }}',
'{{ customEnvironmentSpec }}',
'{{ workbenchRuntime }}',
'{{ executionUser }}',
'{{ displayName }}',
'{{ encryptionSpec }}',
'{{ gcsOutputUri }}',
'{{ executionTimeout }}',
'{{ labels }}',
'{{ dataformRepositorySource }}',
'{{ kernelName }}',
'{{ scheduleResourceName }}',
'{{ gcsNotebookSource }}',
'{{ serviceAccount }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ notebookExecutionJobId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: notebook_execution_jobs
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the notebook_execution_jobs resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the notebook_execution_jobs resource.
  - name: notebookRuntimeTemplateResourceName
    value: "{{ notebookRuntimeTemplateResourceName }}"
    description: |
      The NotebookRuntimeTemplate to source compute configuration from.
  - name: directNotebookSource
    description: |
      The contents of an input notebook file.
    value:
      content: "{{ content }}"
  - name: customEnvironmentSpec
    description: |
      The custom compute configuration for an execution job.
    value:
      networkSpec:
        network: "{{ network }}"
        enableInternetAccess: {{ enableInternetAccess }}
        subnetwork: "{{ subnetwork }}"
      machineSpec:
        machineType: "{{ machineType }}"
        tpuTopology: "{{ tpuTopology }}"
        reservationAffinity:
          reservationAffinityType: "{{ reservationAffinityType }}"
          key: "{{ key }}"
          values:
            - "{{ values }}"
        acceleratorCount: {{ acceleratorCount }}
        acceleratorType: "{{ acceleratorType }}"
        gpuPartitionSize: "{{ gpuPartitionSize }}"
      persistentDiskSpec:
        diskType: "{{ diskType }}"
        diskSizeGb: "{{ diskSizeGb }}"
      shieldedInstanceConfig:
        enableVtpm: {{ enableVtpm }}
        enableIntegrityMonitoring: {{ enableIntegrityMonitoring }}
        enableSecureBoot: {{ enableSecureBoot }}
  - name: workbenchRuntime
    description: |
      The Workbench runtime configuration to use for the notebook execution.
    value:
      vmImage:
        family: "{{ family }}"
        project: "{{ project }}"
        name: "{{ name }}"
      customContainerImage:
        repository: "{{ repository }}"
        tag: "{{ tag }}"
  - name: executionUser
    value: "{{ executionUser }}"
    description: |
      The user email to run the execution as. Only supported by Colab runtimes.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
  - name: encryptionSpec
    description: |
      Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.
    value:
      kmsKeyName: "{{ kmsKeyName }}"
  - name: gcsOutputUri
    value: "{{ gcsOutputUri }}"
    description: |
      The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
  - name: executionTimeout
    value: "{{ executionTimeout }}"
    description: |
      Max running time of the execution job in seconds (default 86400s / 24 hrs).
  - name: labels
    value: "{{ labels }}"
    description: |
      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.
  - name: dataformRepositorySource
    description: |
      The Dataform Repository pointing to a single file notebook repository.
    value:
      dataformRepositoryResourceName: "{{ dataformRepositoryResourceName }}"
      commitSha: "{{ commitSha }}"
  - name: kernelName
    value: "{{ kernelName }}"
    description: |
      The name of the kernel to use during notebook execution. If unset, the default kernel is used.
  - name: scheduleResourceName
    value: "{{ scheduleResourceName }}"
    description: |
      The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
  - name: gcsNotebookSource
    description: |
      The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
    value:
      uri: "{{ uri }}"
      generation: "{{ generation }}"
  - name: serviceAccount
    value: "{{ serviceAccount }}"
    description: |
      The service account to run the execution as.
  - name: notebookExecutionJobId
    value: "{{ notebookExecutionJobId }}"

DELETE examples

delete

Deletes a NotebookExecutionJob.

DELETE FROM google.aiplatform.notebook_execution_jobs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND notebookExecutionJobsId = '{{ notebookExecutionJobsId }}' --required
;