Resource: NotebookExecutionJob
NotebookExecutionJob represents an instance of a notebook execution.
name
string
Output only. The resource name of this NotebookExecutionJob. Format: projects/{projectId}/locations/{location}/notebookExecutionJobs/{job_id}
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.
Max running time of the execution job in seconds (default 86400s / 24 hrs).
A duration in seconds with up to nine fractional digits, ending with 's
'. Example: "3.5s"
.
scheduleResourceName
string
Output only. The Schedule resource name if this job is triggered by one. Format: projects/{projectId}/locations/{location}/schedules/{schedule_id}
Output only. The state of the NotebookExecutionJob.
Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
Output only. timestamp when this NotebookExecutionJob was created.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z"
and "2014-10-02T15:01:23.045123456Z"
.
Output only. timestamp when this NotebookExecutionJob was most recently updated.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z"
and "2014-10-02T15:01:23.045123456Z"
.
labels
map (key: string, value: string)
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.
Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the [NotebookService.NotebookRuntimeTemplate][] has an encryption spec.
notebook_source
. The input notebook. notebook_source
can be only one of the following:The Dataform Repository pointing to a single file notebook repository.
The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb
The contents of an input notebook file.
environment_spec
. The compute config to use for an execution job. environment_spec
can be only one of the following:notebookRuntimeTemplateResourceName
string
The NotebookRuntimeTemplate to source compute configuration from.
execution_sink
. The location to store the notebook execution result. execution_sink
can be only one of the following:gcsOutputUri
string
The Cloud Storage location to upload the result to. Format: gs://bucket-name
execution_identity
. The identity to run the execution as. execution_identity
can be only one of the following:executionUser
string
The user email to run the execution as. Only supported by Colab runtimes.
serviceAccount
string
The service account to run the execution as.
JSON representation |
---|
{ "name": string, "displayName": string, "executionTimeout": string, "scheduleResourceName": string, "jobState": enum ( |
DataformRepositorySource
The Dataform Repository containing the input notebook.
dataformRepositoryResourceName
string
The resource name of the Dataform Repository. Format: projects/{projectId}/locations/{location}/repositories/{repository_id}
commitSha
string
The commit SHA to read repository with. If unset, the file will be read at HEAD.
JSON representation |
---|
{ "dataformRepositoryResourceName": string, "commitSha": string } |
GcsNotebookSource
The Cloud Storage uri for the input notebook.
uri
string
The Cloud Storage uri pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb
generation
string
The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
JSON representation |
---|
{ "uri": string, "generation": string } |
DirectNotebookSource
The content of the input notebook in ipynb format.
The base64-encoded contents of the input notebook file.
A base64-encoded string.
JSON representation |
---|
{ "content": string } |
Methods |
|
---|---|
|
Creates a NotebookExecutionJob. |
|
Deletes a NotebookExecutionJob. |
|
Gets a NotebookExecutionJob. |
|
Lists NotebookExecutionJobs in a Location. |