GoogleCloudAiplatformV1NotebookRuntime

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

A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.

interface GoogleCloudAiplatformV1NotebookRuntime {

readonly createTime?: Date;

description?: string;

displayName?: string;

readonly expirationTime?: Date;

readonly healthState?: "HEALTH_STATE_UNSPECIFIED" | "HEALTHY" | "UNHEALTHY";

readonly isUpgradable?: boolean;

labels?: {

[key: string]: string;

};

readonly name?: string;

networkTags?: string[];

readonly notebookRuntimeTemplateRef?: GoogleCloudAiplatformV1NotebookRuntimeTemplateRef;

readonly notebookRuntimeType?: "NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED" | "USER_DEFINED" | "ONE_CLICK";

readonly proxyUri?: string;

readonly reservationAffinity?: GoogleCloudAiplatformV1NotebookReservationAffinity;

readonly runtimeState?:

| "RUNTIME_STATE_UNSPECIFIED"

| "RUNNING"

| "BEING_STARTED"

| "BEING_STOPPED"

| "STOPPED"

| "BEING_UPGRADED"

| "ERROR"

| "INVALID";

runtimeUser?: string;

readonly satisfiesPzi?: boolean;

readonly satisfiesPzs?: boolean;

readonly serviceAccount?: string;

readonly updateTime?: Date;

readonly version?: string;

}

§Properties

readonly createTime?: Date

[src]

Output only. Timestamp when this NotebookRuntime was created.

description?: string

[src]

The description of the NotebookRuntime.

displayName?: string

[src]

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

readonly expirationTime?: Date

[src]

Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.

readonly healthState?: "HEALTH_STATE_UNSPECIFIED" | "HEALTHY" | "UNHEALTHY"

[src]

Output only. The health state of the NotebookRuntime.

readonly isUpgradable?: boolean

[src]

Output only. Whether NotebookRuntime is upgradable.

labels?: {

[key: string]: string;

}

[src]

The labels with user-defined metadata to organize your NotebookRuntime. 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. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). 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. Following system labels exist for NotebookRuntime: * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex.

readonly name?: string

[src]

Output only. The resource name of the NotebookRuntime.

networkTags?: string[]

[src]

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

readonly notebookRuntimeTemplateRef?: GoogleCloudAiplatformV1NotebookRuntimeTemplateRef

[src]

Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.

readonly notebookRuntimeType?: "NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED" | "USER_DEFINED" | "ONE_CLICK"

[src]

Output only. The type of the notebook runtime.