Class: Google::Apis::CloudshellV1::Environment
- Inherits:
-
Object
- Object
- Google::Apis::CloudshellV1::Environment
- Defined in:
- generated/google/apis/cloudshell_v1/classes.rb,
generated/google/apis/cloudshell_v1/representations.rb,
generated/google/apis/cloudshell_v1/representations.rb
Overview
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".
Instance Attribute Summary collapse
-
#docker_image ⇒ String
Required.
-
#id ⇒ String
Output only.
-
#name ⇒ String
Output only.
-
#public_keys ⇒ Array<Google::Apis::CloudshellV1::PublicKey>
Output only.
-
#ssh_host ⇒ String
Output only.
-
#ssh_port ⇒ Fixnum
Output only.
-
#ssh_username ⇒ String
Output only.
-
#state ⇒ String
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Environment
constructor
A new instance of Environment.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Environment
Returns a new instance of Environment
116 117 118 |
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 116 def initialize(**args) update!(**args) end |
Instance Attribute Details
#docker_image ⇒ String
Required. Full path to the Docker image used to run this environment, e.g.
"gcr.io/dev-con/cloud-devshell:latest".
Corresponds to the JSON property dockerImage
68 69 70 |
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 68 def docker_image @docker_image end |
#id ⇒ String
Output only. The environment's identifier, which is always "default".
Corresponds to the JSON property id
73 74 75 |
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 73 def id @id end |
#name ⇒ String
Output only. Full name of this resource, in the format
users/
owner_email/environments/
environment_id.
owner_emailis 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.
Corresponds to the JSON property
name`
82 83 84 |
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 82 def name @name end |
#public_keys ⇒ Array<Google::Apis::CloudshellV1::PublicKey>
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.
Corresponds to the JSON property publicKeys
91 92 93 |
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 91 def public_keys @public_keys end |
#ssh_host ⇒ String
Output only. Host to which clients can connect to initiate SSH sessions
with the environment.
Corresponds to the JSON property sshHost
97 98 99 |
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 97 def ssh_host @ssh_host end |
#ssh_port ⇒ Fixnum
Output only. Port to which clients can connect to initiate SSH sessions
with the environment.
Corresponds to the JSON property sshPort
103 104 105 |
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 103 def ssh_port @ssh_port end |
#ssh_username ⇒ String
Output only. Username that clients should use when initiating SSH sessions
with the environment.
Corresponds to the JSON property sshUsername
109 110 111 |
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 109 def ssh_username @ssh_username end |
#state ⇒ String
Output only. Current execution state of this environment.
Corresponds to the JSON property state
114 115 116 |
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 114 def state @state end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
121 122 123 124 125 126 127 128 129 130 |
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 121 def update!(**args) @docker_image = args[:docker_image] if args.key?(:docker_image) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @public_keys = args[:public_keys] if args.key?(:public_keys) @ssh_host = args[:ssh_host] if args.key?(:ssh_host) @ssh_port = args[:ssh_port] if args.key?(:ssh_port) @ssh_username = args[:ssh_username] if args.key?(:ssh_username) @state = args[:state] if args.key?(:state) end |