REST Resource: projects.locations.notebookExecutionJobs

Resource: NotebookExecutionJob

NotebookExecutionJob represents an instance of a notebook execution.

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

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.

kernelName string

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

encryptionSpec object (EncryptionSpec)

Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.

notebook_source Union type
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

directNotebookSource object (DirectNotebookSource)

The contents of an input notebook file.

environment_spec Union type
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.

customEnvironmentSpec object (CustomEnvironmentSpec)

The custom compute configuration for an execution job.

execution_sink Union type
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 Union type
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.

runtime_environment Union type
Runtime environment for the notebook execution job. If unspecified, the default runtime of Colab is used. runtime_environment can be only one of the following:
workbenchRuntime object (WorkbenchRuntime)

The Workbench runtime configuration to use for the notebook execution.

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

  // notebook_source
  "dataformRepositorySource": {
    object (DataformRepositorySource)
  },
  "gcsNotebookSource": {
    object (GcsNotebookSource)
  },
  "directNotebookSource": {
    object (DirectNotebookSource)
  }
  // Union type

  // environment_spec
  "notebookRuntimeTemplateResourceName": string,
  "customEnvironmentSpec": {
    object (CustomEnvironmentSpec)
  }
  // Union type

  // execution_sink
  "gcsOutputUri": string
  // Union type

  // execution_identity
  "executionUser": string,
  "serviceAccount": string
  // Union type

  // runtime_environment
  "workbenchRuntime": {
    object (WorkbenchRuntime)
  }
  // Union type
}

DataformRepositorySource

The Dataform Repository containing the input notebook.

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.

JSON representation 
{
  "dataformRepositoryResourceName": string,
  "commitSha": string
}

GcsNotebookSource

The Cloud Storage uri for the input notebook.

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.

JSON representation 
{
  "uri": string,
  "generation": string
}

DirectNotebookSource

The content of the input notebook in ipynb format.

Fields
content string (bytes format)

The base64-encoded contents of the input notebook file.

A base64-encoded string.

JSON representation 
{
  "content": string
}

CustomEnvironmentSpec

Compute configuration to use for an execution job.

Fields
machineSpec object (MachineSpec)

The specification of a single machine for the execution job.

persistentDiskSpec object (PersistentDiskSpec)

The specification of a persistent disk to attach for the execution job.

networkSpec object (NetworkSpec)

The network configuration to use for the execution job.

JSON representation 
{
  "machineSpec": {
    object (MachineSpec)
  },
  "persistentDiskSpec": {
    object (PersistentDiskSpec)
  },
  "networkSpec": {
    object (NetworkSpec)
  }
}

WorkbenchRuntime

This type has no fields.

Configuration for a Workbench Instances-based environment.

Methods

create

 Creates a NotebookExecutionJob.

delete

 Deletes a NotebookExecutionJob.

get

 Gets a NotebookExecutionJob.

list

 Lists NotebookExecutionJobs in a Location.