## Resource: Execution

The definition of a single executed notebook.

| JSON representation |
|---|
| ``` { "executionTemplate": { object (`https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/reference/rest/v1/ExecutionTemplate`) }, "name": string, "displayName": string, "description": string, "createTime": string, "updateTime": string, "state": enum (`https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/reference/rest/v1/projects.locations.executions#Execution.State`), "outputNotebookFile": string, "jobUri": string } ``` |

| Fields ||
|---|---|
| `executionTemplate` | ``object (`https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/reference/rest/v1/ExecutionTemplate`)`` execute metadata including name, hardware spec, region, labels, etc. |
| `name` | `string` Output only. The resource name of the execute. Format: `projects/{projectId}/locations/{location}/executions/{executionId}` |
| `displayName` | `string` Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'. |
| `description` | `string` A brief description of this execution. |
| `createTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Time the Execution was instantiated. Uses RFC 3339, where generated output will always be Z-normalized and use 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"`. |
| `updateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Time the Execution was last updated. Uses RFC 3339, where generated output will always be Z-normalized and use 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"`. |
| `state` | ``enum (`https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/reference/rest/v1/projects.locations.executions#Execution.State`)`` Output only. State of the underlying AI Platform job. |
| `outputNotebookFile` | `string` Output notebook file generated by this execution |
| `jobUri` | `string` Output only. The URI of the external job used to execute the notebook. |

### State

Enum description of the state of the underlying AIP job.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The job state is unspecified. |
| `QUEUED` | The job has been just created and processing has not yet begun. |
| `PREPARING` | The service is preparing to execution the job. |
| `RUNNING` | The job is in progress. |
| `SUCCEEDED` | The job completed successfully. |
| `FAILED` | The job failed. `errorMessage` should contain the details of the failure. |
| `CANCELLING` | The job is being cancelled. `errorMessage` should describe the reason for the cancellation. |
| `CANCELLED` | The job has been cancelled. `errorMessage` should describe the reason for the cancellation. |
| `EXPIRED` | The job has become expired (relevant to Vertex AI jobs) |
| `INITIALIZING` | The Execution is being created. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/reference/rest/v1/projects.locations.executions/create` | Creates a new Execution in a given project and location. |
| ### `https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/reference/rest/v1/projects.locations.executions/delete` | Deletes execution |
| ### `https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/reference/rest/v1/projects.locations.executions/get` | Gets details of executions |
| ### `https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/reference/rest/v1/projects.locations.executions/list` | Lists executions in a given project and location |