Class: Google::Apis::CloudshellV1alpha1::Environment

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudshell_v1alpha1/classes.rb,
generated/google/apis/cloudshell_v1alpha1/representations.rb,
generated/google/apis/cloudshell_v1alpha1/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

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Environment

Returns a new instance of Environment



160
161
162
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 160

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

Returns:

  • (String) 


106
107
108
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 106

def docker_image
  @docker_image
end

#id ⇒ String

Output only. The environment's identifier, which is always "default". Corresponds to the JSON property id

Returns:

  • (String) 


111
112
113
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 111

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 propertyname`

Returns:

  • (String) 


120
121
122
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 120

def name
  @name
end

#public_keys ⇒ Array<Google::Apis::CloudshellV1alpha1::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

Returns:



129
130
131
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 129

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) 


135
136
137
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 135

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) 


141
142
143
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 141

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) 


147
148
149
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 147

def ssh_username
  @ssh_username
end

#state ⇒ String

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

Returns:

  • (String) 


152
153
154
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 152

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) 


158
159
160
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 158

def web_host
  @web_host
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



165
166
167
168
169
170
171
172
173
174
175
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 165

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