GOgoogle
projects

GET /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}

Gets a NotebookExecutionJob.

Request

  • Base URL
    https://aiplatform.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/cloud-platform
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required
locationsIdstring required
notebookExecutionJobsIdstring required

Query parameters

view'NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED' | 'NOTEBOOK_EXECUTION_JOB_VIEW_BASIC' | 'NOTEBOOK_EXECUTION_JOB_VIEW_FULL'

Optional. The NotebookExecutionJob view. Defaults to BASIC.

Response

Successful response

createTimestring google-datetime

Output only. Timestamp when this NotebookExecutionJob was created.

displayNamestring

The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

executionTimeoutstring google-duration

Max running time of the execution job in seconds (default 86400s / 24 hrs).

executionUserstring

The user email to run the execution as. Only supported by Colab runtimes.

gcsOutputUristring

The Cloud Storage location to upload the result to. Format: gs://bucket-name

jobState'JOB_STATE_UNSPECIFIED' | 'JOB_STATE_QUEUED' | 'JOB_STATE_PENDING' | 'JOB_STATE_RUNNING' | 'JOB_STATE_SUCCEEDED' | 'JOB_STATE_FAILED' | 'JOB_STATE_CANCELLING' | 'JOB_STATE_CANCELLED' | 'JOB_STATE_PAUSED' | 'JOB_STATE_EXPIRED' | 'JOB_STATE_UPDATING' | 'JOB_STATE_PARTIALLY_SUCCEEDED'

Output only. The state of the NotebookExecutionJob.

kernelNamestring

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

labelsobject

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.

namestring

Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}

notebookRuntimeTemplateResourceNamestring

The NotebookRuntimeTemplate to source compute configuration from.

scheduleResourceNamestring

The Schedule resource name if this job is triggered by one. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

serviceAccountstring

The service account to run the execution as.

updateTimestring google-datetime

Output only. Timestamp when this NotebookExecutionJob was most recently updated.

Changes

No recorded changes to this operation across all 8 revisions of this API.