Cloud Workstations V1 API - Class Google::Cloud::Workstations::V1::WorkstationConfig::Host::GceInstance::BoostConfig (v1.5.0)

Reference documentation and code samples for the Cloud Workstations V1 API class Google::Cloud::Workstations::V1::WorkstationConfig::Host::GceInstance::BoostConfig.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#accelerators

def accelerators() -> ::Array<::Google::Cloud::Workstations::V1::WorkstationConfig::Host::GceInstance::Accelerator>
Returns

#accelerators=

def accelerators=(value) -> ::Array<::Google::Cloud::Workstations::V1::WorkstationConfig::Host::GceInstance::Accelerator>
Parameter
Returns

#boot_disk_size_gb

def boot_disk_size_gb() -> ::Integer
Returns
  • (::Integer) — 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.

#boot_disk_size_gb=

def boot_disk_size_gb=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#enable_nested_virtualization

def enable_nested_virtualization() -> ::Boolean
Returns
  • (::Boolean) —

    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.

#enable_nested_virtualization=

def enable_nested_virtualization=(value) -> ::Boolean
Parameter
  • value (::Boolean) —

    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.
Returns
  • (::Boolean) —

    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.

#id

def id() -> ::String
Returns
  • (::String) — Required. The ID to be used for the boost configuration.

#id=

def id=(value) -> ::String
Parameter
  • value (::String) — Required. The ID to be used for the boost configuration.
Returns
  • (::String) — Required. The ID to be used for the boost configuration.

#machine_type

def machine_type() -> ::String
Returns
  • (::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.

#machine_type=

def machine_type=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#pool_size

def pool_size() -> ::Integer
Returns
  • (::Integer) — Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to 0.

#pool_size=

def pool_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to 0.
Returns
  • (::Integer) — Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to 0.