Class: Google::Apis::WorkstationsV1beta::BoostConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/workstations_v1beta/classes.rb,
lib/google/apis/workstations_v1beta/representations.rb,
lib/google/apis/workstations_v1beta/representations.rb

Overview

A boost configuration is a set of resources that a workstation can use to increase its performance. If you specify a boost configuration, upon startup, workstation users can choose to use a VM provisioned under the boost config by passing the boost config ID in the start request. If the workstation user does not provide a boost config ID in the start request, the system will choose a VM from the pool provisioned under the default config.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BoostConfig

Returns a new instance of BoostConfig.



287
288
289
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 287

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

Instance Attribute Details

#accelerators ⇒ Array<Google::Apis::WorkstationsV1beta::Accelerator>

Optional. A list of the type and count of accelerator cards attached to the boost instance. Defaults to none. Corresponds to the JSON property accelerators

Returns:



236
237
238
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 236

def accelerators
  @accelerators
end

#boot_disk_size_gb ⇒ Fixnum

Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is 30 GB. Defaults to 50 GB. Corresponds to the JSON property bootDiskSizeGb

Returns:

  • (Fixnum) 


242
243
244
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 242

def boot_disk_size_gb
  @boot_disk_size_gb
end

#enable_nested_virtualization ⇒ Boolean Also known as: enable_nested_virtualization?

Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the same restrictions as Compute Engine instances: * ** Organization policy*: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization* constraint is enforced in the organization policy. For more information, see the Compute Engine section, Checking whether nested virtualization is allowed. * ** Performance*: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type*: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. Corresponds to the JSON property enableNestedVirtualization

Returns:

  • (Boolean) 


264
265
266
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 264

def enable_nested_virtualization
  @enable_nested_virtualization
end

#id ⇒ String

Required. The ID to be used for the boost configuration. Corresponds to the JSON property id

Returns:

  • (String) 


270
271
272
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 270

def id
  @id
end

#machine_type ⇒ String

Optional. The type of machine that boosted VM instances will use—for example, e2-standard-4. For more information about machine types that Cloud Workstations supports, see the list of available machine types. Defaults to e2- standard-4. Corresponds to the JSON property machineType

Returns:

  • (String) 


279
280
281
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 279

def machine_type
  @machine_type
end

#pool_size ⇒ Fixnum

Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to 0. Corresponds to the JSON property poolSize

Returns:

  • (Fixnum) 


285
286
287
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 285

def pool_size
  @pool_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



292
293
294
295
296
297
298
299
 
# File 'lib/google/apis/workstations_v1beta/classes.rb', line 292

def update!(**args)
  @accelerators = args[:accelerators] if args.key?(:accelerators)
  @boot_disk_size_gb = args[:boot_disk_size_gb] if args.key?(:boot_disk_size_gb)
  @enable_nested_virtualization = args[:enable_nested_virtualization] if args.key?(:enable_nested_virtualization)
  @id = args[:id] if args.key?(:id)
  @machine_type = args[:machine_type] if args.key?(:machine_type)
  @pool_size = args[:pool_size] if args.key?(:pool_size)
end