REST Resource: projects.locations.executions

Resource: Execution

The definition of a single executed notebook.

JSON representation 
{
  "executionTemplate": {
    object (ExecutionTemplate)
  },
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "outputNotebookFile": string,
  "jobUri": string
}
Fields
executionTemplate

object (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 (Timestamp format)

Output only. Time the Execution was instantiated.

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. Time the Execution was last 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".
state

enum (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) https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState
INITIALIZING The Execution is being created.

Methods

create

 Creates a new Execution in a given project and location.

delete

 Deletes execution

get

 Gets details of executions

list

 Lists executions in a given project and location