Class 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 at least an environment with the ID "default".

Inheritance
object
Environment
Implements
Inherited Members
Namespace: Google.Apis.CloudShell.v1.Data
Assembly: Google.Apis.CloudShell.v1.dll
Syntax
public class Environment : IDirectResponseSchema

Properties

DockerImage

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

Declaration
[JsonProperty("dockerImage")]
public virtual string DockerImage { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Id

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

Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type Description
string

Name

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.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

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 AddPublicKey and RemovePublicKey methods.

Declaration
[JsonProperty("publicKeys")]
public virtual IList<string> PublicKeys { get; set; }
Property Value
Type Description
IList<string>

SshHost

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

Declaration
[JsonProperty("sshHost")]
public virtual string SshHost { get; set; }
Property Value
Type Description
string

SshPort

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

Declaration
[JsonProperty("sshPort")]
public virtual int? SshPort { get; set; }
Property Value
Type Description
int?

SshUsername

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

Declaration
[JsonProperty("sshUsername")]
public virtual string SshUsername { get; set; }
Property Value
Type Description
string

State

Output only. Current execution state of this environment.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

WebHost

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

Declaration
[JsonProperty("webHost")]
public virtual string WebHost { get; set; }
Property Value
Type Description
string

Implements