Class Environment (1.8.0)

Environment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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".

Attributes

NameDescription
name str
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.
id str
Output only. The environment's identifier, unique among the user's environments.
docker_image str
Required. Immutable. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".
state google.cloud.shell_v1.types.Environment.State
Output only. Current execution state of this environment.
web_host str
Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment.
ssh_username str
Output only. Username that clients should use when initiating SSH sessions with the environment.
ssh_host str
Output only. Host to which clients can connect to initiate SSH sessions with the environment.
ssh_port int
Output only. Port to which clients can connect to initiate SSH sessions with the environment.
public_keys MutableSequence[str]
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.

Classes

State

State(value)

Possible execution states for an environment.

Values: STATE_UNSPECIFIED (0): The environment's states is unknown. SUSPENDED (1): The environment is not running and can't be connected to. Starting the environment will transition it to the PENDING state. PENDING (2): The environment is being started but is not yet ready to accept connections. RUNNING (3): The environment is running and ready to accept connections. It will automatically transition back to DISABLED after a period of inactivity or if another environment is started. DELETING (4): The environment is being deleted and can't be connected to.