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.



180
181
182
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 180

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, unique among the user's environments. Corresponds to the JSON property id

Returns:

  • (String) 


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

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) 


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

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:



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

def public_keys
  @public_keys
end

#size ⇒ String

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

Returns:

  • (String) 


137
138
139
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 137

def size
  @size
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) 


143
144
145
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 143

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) 


149
150
151
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 149

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) 


155
156
157
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 155

def ssh_username
  @ssh_username
end

#state ⇒ String

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

Returns:

  • (String) 


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

def state
  @state
end

#vm_size_expire_time ⇒ String

Output only. The time when the Environment will expire back to the default VM size. Corresponds to the JSON property vmSizeExpireTime

Returns:

  • (String) 


166
167
168
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 166

def vm_size_expire_time
  @vm_size_expire_time
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) 


172
173
174
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 172

def web_host
  @web_host
end

#web_ports ⇒ Array<Fixnum>

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

Returns:

  • (Array<Fixnum>) 


178
179
180
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 178

def web_ports
  @web_ports
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'generated/google/apis/cloudshell_v1alpha1/classes.rb', line 185

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