REST Resource: projects.locations.notebookExecutionJobs

Resource: NotebookExecutionJob

NotebookExecutionJob represents an instance of a notebook execution.

JSON representation 
{
  "name": string,
  "displayName": string,
  "executionTimeout": string,
  "scheduleResourceName": string,
  "jobState": enum (JobState),
  "status": {
    object (Status)
  },
  "createTime": string,
  "updateTime": string,

  // Union field notebook_source can be only one of the following:
  "dataformRepositorySource": {
    object (DataformRepositorySource)
  },
  "gcsNotebookSource": {
    object (GcsNotebookSource)
  }
  // End of list of possible types for union field notebook_source.

  // Union field environment_spec can be only one of the following:
  "notebookRuntimeTemplateResourceName": string
  // End of list of possible types for union field environment_spec.

  // Union field execution_sink can be only one of the following:
  "gcsOutputUri": string
  // End of list of possible types for union field execution_sink.

  // Union field execution_identity can be only one of the following:
  "executionUser": string,
  "serviceAccount": string
  // End of list of possible types for union field execution_identity.
}
Fields
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.
executionTimeout

string (Duration format)

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}
jobState

enum (JobState)

Output only. The state of the NotebookExecutionJob.
status

object (Status)

Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
createTime

string (Timestamp format)

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".
updateTime

string (Timestamp format)

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".
Union field notebook_source. The input notebook. notebook_source can be only one of the following:
dataformRepositorySource

object (DataformRepositorySource)

The Dataform Repository pointing to a single file notebook repository.
gcsNotebookSource

object (GcsNotebookSource)

The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb
Union field 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.
Union field 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
Union field 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.

DataformRepositorySource

The Dataform Repository containing the input notebook.

JSON representation 
{
  "dataformRepositoryResourceName": string,
  "commitSha": string
}
Fields
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.

GcsNotebookSource

The Cloud Storage uri for the input notebook.

JSON representation 
{
  "uri": string,
  "generation": string
}
Fields
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.

Methods

delete

 Deletes a NotebookExecutionJob.

get

 Gets a NotebookExecutionJob.

list

 Lists NotebookExecutionJobs in a Location.