Environment

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

A Cloud Shell environment, which is defined as the combination of a Docker image specifying what is installed on the environment and a home directory containing the user's data that will remain across sessions. Each user has at least an environment with the ID "default".

interface Environment {

dockerImage?: string;

readonly id?: string;

name?: string;

readonly publicKeys?: string[];

readonly sshHost?: string;

readonly sshPort?: number;

readonly sshUsername?: string;

readonly state?:

| "STATE_UNSPECIFIED"

| "SUSPENDED"

| "PENDING"

| "RUNNING"

| "DELETING";

readonly webHost?: string;

}

§Properties

dockerImage?: string

[src]

Required. Immutable. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".

readonly id?: string

[src]

Output only. The environment's identifier, unique among the user's environments.

name?: string

[src]

Immutable. Full name of this resource, in the format users/{owner_email}/environments/{environment_id}. {owner_email} is the email address of the user to whom this environment belongs, and {environment_id} is the identifier of this environment. For example, users/someone@example.com/environments/default.

readonly publicKeys?: string[]

[src]

Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the AddPublicKey and RemovePublicKey methods.

readonly sshHost?: string

[src]

Output only. Host to which clients can connect to initiate SSH sessions with the environment.

readonly sshPort?: number

[src]

Output only. Port to which clients can connect to initiate SSH sessions with the environment.

readonly sshUsername?: string

[src]

Output only. Username that clients should use when initiating SSH sessions with the environment.

readonly state?: "STATE_UNSPECIFIED" | "SUSPENDED" | "PENDING" | "RUNNING" | "DELETING"

[src]

Output only. Current execution state of this environment.

readonly webHost?: string

[src]

Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment.