GoogleCloudAiplatformV1NotebookExecutionJob

import type { GoogleCloudAiplatformV1NotebookExecutionJob } from "https://googleapis.deno.dev/v1/aiplatform:v1.ts";

NotebookExecutionJob represents an instance of a notebook execution.

interface GoogleCloudAiplatformV1NotebookExecutionJob {

readonly createTime?: Date;

customEnvironmentSpec?: GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec;

dataformRepositorySource?: GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource;

directNotebookSource?: GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource;

displayName?: string;

encryptionSpec?: GoogleCloudAiplatformV1EncryptionSpec;

executionTimeout?: number;

executionUser?: string;

gcsNotebookSource?: GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource;

gcsOutputUri?: string;

readonly 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";

kernelName?: string;

labels?: {

[key: string]: string;

};

readonly name?: string;

notebookRuntimeTemplateResourceName?: string;

scheduleResourceName?: string;

serviceAccount?: string;

readonly status?: GoogleRpcStatus;

readonly updateTime?: Date;

workbenchRuntime?: GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime;

}

§Properties

readonly createTime?: Date

[src]

Output only. Timestamp when this NotebookExecutionJob was created.

customEnvironmentSpec?: GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec

[src]

The custom compute configuration for an execution job.

dataformRepositorySource?: GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource

[src]

The Dataform Repository pointing to a single file notebook repository.

directNotebookSource?: GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource

[src]

The contents of an input notebook file.

displayName?: string

[src]

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

encryptionSpec?: GoogleCloudAiplatformV1EncryptionSpec

[src]

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

executionTimeout?: number

[src]

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

executionUser?: string

[src]

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

gcsNotebookSource?: GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource

[src]

The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb

gcsOutputUri?: string

[src]

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

[src]

Output only. The state of the NotebookExecutionJob.

kernelName?: string

[src]

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

labels?: {

[key: string]: string;

}

[src]

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.

readonly name?: string

[src]

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

notebookRuntimeTemplateResourceName?: string

[src]

The NotebookRuntimeTemplate to source compute configuration from.

scheduleResourceName?: string

[src]

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

serviceAccount?: string

[src]

The service account to run the execution as.

readonly status?: GoogleRpcStatus

[src]

Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.

readonly updateTime?: Date

[src]

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

workbenchRuntime?: GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime

[src]

The Workbench runtime configuration to use for the notebook execution.