Resource: Environment
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 a single environment with the ID "default".
JSON representation | |
---|---|
{ "name": string, "id": string, "dockerImage": string, "state": enum( |
Fields | |
---|---|
name |
Output only. Full name of this resource, in the format |
id |
Output only. The environment's identifier, which is always "default". |
dockerImage |
Required. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest". |
state |
Output only. Current execution state of this environment. |
sshUsername |
Output only. Username that clients should use when initiating SSH sessions with the environment. |
sshHost |
Output only. Host to which clients can connect to initiate SSH sessions with the environment. |
sshPort |
Output only. Port to which clients can connect to initiate SSH sessions with the environment. |
publicKeys[] |
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 publicKeys.create and publicKeys.delete methods. |
Methods |
|
---|---|
|
Sends OAuth credentials to a running environment on behalf of a user. |
|
Gets an environment. |
|
Updates an existing environment. |
|
Starts an existing environment, allowing clients to connect to it. |