google_api_cloud_shell v0.3.0 GoogleApi.CloudShell.V1.Model.Environment View Source

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

Attributes

  • dockerImage (String.t): Required. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest". Defaults to nil.
  • id (String.t): Output only. The environment's identifier, which is always "default". Defaults to nil.
  • name (String.t): Output only. 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. Defaults to nil.
  • publicKeys (list(GoogleApi.CloudShell.V1.Model.PublicKey.t)): 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 CreatePublicKey and DeletePublicKey methods. Defaults to nil.
  • sshHost (String.t): Output only. Host to which clients can connect to initiate SSH sessions with the environment. Defaults to nil.
  • sshPort (integer()): Output only. Port to which clients can connect to initiate SSH sessions with the environment. Defaults to nil.
  • sshUsername (String.t): Output only. Username that clients should use when initiating SSH sessions with the environment. Defaults to nil.
  • state (String.t): Output only. Current execution state of this environment. Defaults to nil.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t() View Source
t() :: %GoogleApi.CloudShell.V1.Model.Environment{
  dockerImage: String.t(),
  id: String.t(),
  name: String.t(),
  publicKeys: [GoogleApi.CloudShell.V1.Model.PublicKey.t()],
  sshHost: String.t(),
  sshPort: integer(),
  sshUsername: String.t(),
  state: String.t()
}

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.