google_api_cloud_shell v0.16.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
(type:String.t
, default:nil
) - Required. 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
) - Output only. Full name of this resource, in the formatusers/{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(GoogleApi.CloudShell.V1.Model.PublicKey.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 CreatePublicKey and DeletePublicKey methods.size
(type:String.t
, default:nil
) - Indicates the size of the backing VM running the environment. If set to something other than DEFAULT, it will be reverted to the default VM size after vm_size_expire_time.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.vmSizeExpireTime
(type:DateTime.t
, default:nil
) - Output only. The time when the Environment will expire back to the default VM size.webHost
(type:String.t
, default:nil
) - Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment.webPorts
(type:list(integer())
, default:nil
) - Output only. Ports to which clients can connect to initiate HTTPS or WSS connections with the environment.
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 Sourcet() :: %GoogleApi.CloudShell.V1.Model.Environment{ dockerImage: String.t(), id: String.t(), name: String.t(), publicKeys: [GoogleApi.CloudShell.V1.Model.PublicKey.t()], size: String.t(), sshHost: String.t(), sshPort: integer(), sshUsername: String.t(), state: String.t(), vmSizeExpireTime: DateTime.t(), webHost: String.t(), webPorts: [integer()] }
Link to this section Functions
Unwrap a decoded JSON object into its complex fields.