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
Name | Datatype | Description |
---|---|---|
name | string | Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id} |
createTime | string | Output only. Timestamp when this NotebookExecutionJob was created. |
dataformRepositorySource | object | The Dataform Repository containing the input notebook. |
directNotebookSource | object | The content of the input notebook in ipynb format. |
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 | Represents a customer-managed encryption key spec that can be applied to a top-level resource. |
executionTimeout | string | 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 uri for the input notebook. |
gcsOutputUri | string | The Cloud Storage location to upload the result to. Format: gs://bucket-name |
jobState | string | Output only. The state of the NotebookExecutionJob. |
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 | Output only. 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. |
updateTime | string | Output only. Timestamp when this NotebookExecutionJob was most recently updated. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | locationsId, notebookExecutionJobsId, projectsId | Gets a NotebookExecutionJob. |
list | SELECT | locationsId, projectsId | Lists NotebookExecutionJobs in a Location. |
create | INSERT | locationsId, projectsId | Creates a NotebookExecutionJob. |
delete | DELETE | locationsId, notebookExecutionJobsId, projectsId | Deletes a NotebookExecutionJob. |
SELECT
examples
Lists NotebookExecutionJobs in a Location.
SELECT
name,
createTime,
dataformRepositorySource,
directNotebookSource,
displayName,
encryptionSpec,
executionTimeout,
executionUser,
gcsNotebookSource,
gcsOutputUri,
jobState,
labels,
notebookRuntimeTemplateResourceName,
scheduleResourceName,
serviceAccount,
status,
updateTime
FROM google.aiplatform.notebook_execution_jobs
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';
INSERT
example
Use the following StackQL query and manifest file to create a new notebook_execution_jobs
resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO google.aiplatform.notebook_execution_jobs (
locationsId,
projectsId,
notebookRuntimeTemplateResourceName,
executionTimeout,
gcsOutputUri,
serviceAccount,
encryptionSpec,
displayName,
dataformRepositorySource,
executionUser,
gcsNotebookSource,
labels,
directNotebookSource
)
SELECT
'{{ locationsId }}',
'{{ projectsId }}',
'{{ notebookRuntimeTemplateResourceName }}',
'{{ executionTimeout }}',
'{{ gcsOutputUri }}',
'{{ serviceAccount }}',
'{{ encryptionSpec }}',
'{{ displayName }}',
'{{ dataformRepositorySource }}',
'{{ executionUser }}',
'{{ gcsNotebookSource }}',
'{{ labels }}',
'{{ directNotebookSource }}'
;
updateTime: string
createTime: string
notebookRuntimeTemplateResourceName: string
executionTimeout: string
gcsOutputUri: string
serviceAccount: string
encryptionSpec:
kmsKeyName: string
displayName: string
dataformRepositorySource:
commitSha: string
dataformRepositoryResourceName: string
executionUser: string
scheduleResourceName: string
name: string
gcsNotebookSource:
generation: string
uri: string
labels: object
directNotebookSource:
content: string
status:
message: string
code: integer
details:
- additionalProperties: any
type: string
jobState: string
DELETE
example
Deletes the specified notebook_execution_jobs
resource.
/*+ delete */
DELETE FROM google.aiplatform.notebook_execution_jobs
WHERE locationsId = '{{ locationsId }}'
AND notebookExecutionJobsId = '{{ notebookExecutionJobsId }}'
AND projectsId = '{{ projectsId }}';