View Source GoogleApi.CloudShell.V1.Model.Environment (google_api_cloud_shell v0.20.2)

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

  • dockerImage (type: String.t, default: nil) - Required. Immutable. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".
  • id (type: String.t, default: nil) - Output only. The environment's identifier, unique among the user's environments.
  • name (type: String.t, default: nil) - 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.
  • publicKeys (type: list(String.t), default: nil) - 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.
  • sshHost (type: String.t, default: nil) - Output only. Host to which clients can connect to initiate SSH sessions with the environment.
  • sshPort (type: integer(), default: nil) - Output only. Port to which clients can connect to initiate SSH sessions with the environment.
  • sshUsername (type: String.t, default: nil) - Output only. Username that clients should use when initiating SSH sessions with the environment.
  • state (type: String.t, default: nil) - Output only. Current execution state of this environment.
  • webHost (type: String.t, default: nil) - Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.CloudShell.V1.Model.Environment{
  dockerImage: String.t() | nil,
  id: String.t() | nil,
  name: String.t() | nil,
  publicKeys: [String.t()] | nil,
  sshHost: String.t() | nil,
  sshPort: integer() | nil,
  sshUsername: String.t() | nil,
  state: String.t() | nil,
  webHost: String.t() | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.