Instance

import type { Instance } from "https://googleapis.deno.dev/v1/notebooks:v2.ts";

The definition of a notebook instance.

interface Instance {

readonly createTime?: Date;

readonly creator?: string;

disableProxyAccess?: boolean;

enableDeletionProtection?: boolean;

enableThirdPartyIdentity?: boolean;

gceSetup?: GceSetup;

readonly healthInfo?: {

[key: string]: string;

};

readonly healthState?:

| "HEALTH_STATE_UNSPECIFIED"

| "HEALTHY"

| "UNHEALTHY"

| "AGENT_NOT_INSTALLED"

| "AGENT_NOT_RUNNING";

readonly id?: string;

instanceOwners?: string[];

labels?: {

[key: string]: string;

};

readonly name?: string;

readonly proxyUri?: string;

readonly satisfiesPzi?: boolean;

readonly satisfiesPzs?: boolean;

readonly state?:

| "STATE_UNSPECIFIED"

| "STARTING"

| "PROVISIONING"

| "ACTIVE"

| "STOPPING"

| "STOPPED"

| "DELETED"

| "UPGRADING"

| "INITIALIZING"

| "SUSPENDING"

| "SUSPENDED";

readonly thirdPartyProxyUrl?: string;

readonly updateTime?: Date;

readonly upgradeHistory?: UpgradeHistoryEntry[];

}

§Properties

readonly createTime?: Date

[src]

Output only. Instance creation time.

readonly creator?: string

[src]

Output only. Email address of entity that sent original CreateInstance request.

disableProxyAccess?: boolean

[src]

Optional. If true, the notebook instance will not register with the proxy.

enableDeletionProtection?: boolean

[src]

Optional. If true, deletion protection will be enabled for this Workbench Instance. If false, deletion protection will be disabled for this Workbench Instance.

enableThirdPartyIdentity?: boolean

[src]

Optional. Flag that specifies that a notebook can be accessed with third party identity provider.

gceSetup?: GceSetup

[src]

Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.

readonly healthInfo?: {

[key: string]: string;

}

[src]

Output only. Additional information about instance health. Example: healthInfo": { "docker_proxy_agent_status": "1", "docker_status": "1", "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated": "2020-10-18 09:40:03.573409" }

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

[src]

Output only. Instance health_state.

readonly id?: string

[src]

Output only. Unique ID of the resource.

instanceOwners?: string[]

[src]

Optional. The owner of this instance after creation. Format: alias@example.com Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

labels?: {

[key: string]: string;

}

[src]

Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.

readonly name?: string

[src]

Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

readonly proxyUri?: string

[src]

Output only. The proxy endpoint that is used to access the Jupyter notebook.

readonly satisfiesPzi?: boolean