Class: Google::Apis::CloudshellV1::Environment

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
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 at least an environment with the ID "default".

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Environment

Returns a new instance of Environment.



262
263
264
 
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 262

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#docker_image ⇒ String

Required. Immutable. 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

Returns:

  • (String) 


208
209
210
 
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 208

def docker_image
  @docker_image
end

#id ⇒ String

Output only. The environment's identifier, unique among the user's environments. Corresponds to the JSON property id

Returns:

  • (String) 


214
215
216
 
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 214

def id
  @id
end

#name ⇒ String

Immutable. 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, andenvironment_id`is the identifier of this environment. For example,users/someone@example.com/ environments/default. Corresponds to the JSON propertyname`

Returns:

  • (String) 


223
224
225
 
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 223

def name
  @name
end

#public_keys ⇒ Array<String>

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. Corresponds to the JSON property publicKeys

Returns:

  • (Array<String>) 


231
232
233
 
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 231

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

Returns:

  • (String) 


237
238
239
 
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 237

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

Returns:

  • (Fixnum) 


243
244
245
 
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 243

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

Returns:

  • (String) 


249
250
251
 
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 249

def ssh_username
  @ssh_username
end

#state ⇒ String

Output only. Current execution state of this environment. Corresponds to the JSON property state

Returns:

  • (String) 


254
255
256
 
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 254

def state
  @state
end

#web_host ⇒ String

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

Returns:

  • (String) 


260
261
262
 
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 260

def web_host
  @web_host
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



267
268
269
270
271
272
273
274
275
276
277
 
# File 'generated/google/apis/cloudshell_v1/classes.rb', line 267

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)
  @web_host = args[:web_host] if args.key?(:web_host)
end