Output only. timestamp when this NotebookExecutionJob was created.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Output only. timestamp when this NotebookExecutionJob was most recently updated.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
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.
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:
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:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-21 UTC."],[],[],null,["# REST Resource: projects.locations.notebookExecutionJobs\n\nResource: NotebookExecutionJob\n------------------------------\n\nNotebookExecutionJob represents an instance of a notebook execution.\nFields `name` `string` \nOutput only. The resource name of this NotebookExecutionJob. Format: `projects/{projectId}/locations/{location}/notebookExecutionJobs/{job_id}`\n`displayName` `string` \nThe display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.\n`executionTimeout` `string (`[Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration)` format)` \nMax running time of the execution job in seconds (default 86400s / 24 hrs).\n\nA duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `\"3.5s\"`.\n`scheduleResourceName` `string` \nThe Schedule resource name if this job is triggered by one. Format: `projects/{projectId}/locations/{location}/schedules/{schedule_id}`\n`jobState` `enum (`[JobState](/vertex-ai/docs/reference/rest/v1/JobState)`)` \nOutput only. The state of the NotebookExecutionJob.\n`status` `object (`[Status](/vertex-ai/docs/reference/rest/Shared.Types/ListOperationsResponse#Status)`)` \nOutput only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.\n`createTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. timestamp when this NotebookExecutionJob was created.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`updateTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. timestamp when this NotebookExecutionJob was most recently updated.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`labels` `map (key: string, value: string)` \nThe labels with user-defined metadata to organize NotebookExecutionJobs.\n\nlabel 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.\n\nSee \u003chttps://goo.gl/xmQnxf\u003e for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable.\n`kernelName` `string` \nThe name of the kernel to use during notebook execution. If unset, the default kernel is used.\n`encryptionSpec` `object (`[EncryptionSpec](/vertex-ai/docs/reference/rest/v1/EncryptionSpec)`)` \nCustomer-managed encryption key spec for the notebook execution job. This field is auto-populated if the [NotebookRuntimeTemplate](/vertex-ai/docs/reference/rest/v1/projects.locations.notebookRuntimeTemplates#NotebookRuntimeTemplate) has an encryption spec. \n`notebook_source` `Union type` \nThe input notebook. `notebook_source` can be only one of the following:\n`dataformRepositorySource` `object (`[DataformRepositorySource](/vertex-ai/docs/reference/rest/v1/projects.locations.notebookExecutionJobs#NotebookExecutionJob.DataformRepositorySource)`)` \nThe Dataform Repository pointing to a single file notebook repository.\n`gcsNotebookSource` `object (`[GcsNotebookSource](/vertex-ai/docs/reference/rest/v1/projects.locations.notebookExecutionJobs#NotebookExecutionJob.GcsNotebookSource)`)` \nThe Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebookFile.ipynb`\n`directNotebookSource` `object (`[DirectNotebookSource](/vertex-ai/docs/reference/rest/v1/projects.locations.notebookExecutionJobs#NotebookExecutionJob.DirectNotebookSource)`)` \nThe contents of an input notebook file. \n`environment_spec` `Union type` \nThe compute config to use for an execution job. `environment_spec` can be only one of the following:\n`notebookRuntimeTemplateResourceName` `string` \nThe NotebookRuntimeTemplate to source compute configuration from.\n`customEnvironmentSpec` `object (`[CustomEnvironmentSpec](/vertex-ai/docs/reference/rest/v1/projects.locations.notebookExecutionJobs#NotebookExecutionJob.CustomEnvironmentSpec)`)` \nThe custom compute configuration for an execution job. \n`execution_sink` `Union type` \nThe location to store the notebook execution result. `execution_sink` can be only one of the following:\n`gcsOutputUri` `string` \nThe Cloud Storage location to upload the result to. Format: `gs://bucket-name` \n`execution_identity` `Union type` \nThe identity to run the execution as. `execution_identity` can be only one of the following:\n`executionUser` `string` \nThe user email to run the execution as. Only supported by Colab runtimes.\n`serviceAccount` `string` \nThe service account to run the execution as. \n`runtime_environment` `Union type` \nRuntime environment for the notebook execution job. If unspecified, the default runtime of Colab is used. `runtime_environment` can be only one of the following:\n`workbenchRuntime` `object (`[WorkbenchRuntime](/vertex-ai/docs/reference/rest/v1/projects.locations.notebookExecutionJobs#NotebookExecutionJob.WorkbenchRuntime)`)` \nThe Workbench runtime configuration to use for the notebook execution. \n\n### DataformRepositorySource\n\nThe Dataform Repository containing the input notebook.\nFields `dataformRepositoryResourceName` `string` \nThe resource name of the Dataform Repository. Format: `projects/{projectId}/locations/{location}/repositories/{repository_id}`\n`commitSha` `string` \nThe commit SHA to read repository with. If unset, the file will be read at HEAD. \n\n### GcsNotebookSource\n\nThe Cloud Storage uri for the input notebook.\nFields `uri` `string` \nThe Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebookFile.ipynb`\n`generation` `string` \nThe version of the Cloud Storage object to read. If unset, the current version of the object is read. See \u003chttps://cloud.google.com/storage/docs/metadata#generation-number\u003e. \n\n### DirectNotebookSource\n\nThe content of the input notebook in ipynb format.\nFields `content` `string (`[bytes](https://developers.google.com/discovery/v1/type-format)` format)` \nThe base64-encoded contents of the input notebook file.\n\nA base64-encoded string. \n\n### CustomEnvironmentSpec\n\nCompute configuration to use for an execution job.\nFields `machineSpec` `object (`[MachineSpec](/vertex-ai/docs/reference/rest/v1/MachineSpec)`)` \nThe specification of a single machine for the execution job.\n`persistentDiskSpec` `object (`[PersistentDiskSpec](/vertex-ai/docs/reference/rest/v1/PersistentDiskSpec)`)` \nThe specification of a persistent disk to attach for the execution job.\n`networkSpec` `object (`[NetworkSpec](/vertex-ai/docs/reference/rest/v1/NetworkSpec)`)` \nThe network configuration to use for the execution job. \n\n### WorkbenchRuntime\n\nThis type has no fields. \nConfiguration for a Workbench Instances-based environment."]]
