Class WorkstationConfig.Host.GceInstance.BoostConfig.Builder (0.81.0)

public static final class WorkstationConfig.Host.GceInstance.BoostConfig.Builder extends GeneratedMessage.Builder<WorkstationConfig.Host.GceInstance.BoostConfig.Builder> implements WorkstationConfig.Host.GceInstance.BoostConfigOrBuilder

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.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAccelerators(WorkstationConfig.Host.GceInstance.Accelerator value)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder addAccelerators(WorkstationConfig.Host.GceInstance.Accelerator value)

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

repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value WorkstationConfig.Host.GceInstance.Accelerator
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

addAccelerators(WorkstationConfig.Host.GceInstance.Accelerator.Builder builderForValue)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder addAccelerators(WorkstationConfig.Host.GceInstance.Accelerator.Builder builderForValue)

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

repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue WorkstationConfig.Host.GceInstance.Accelerator.Builder
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

addAccelerators(int index, WorkstationConfig.Host.GceInstance.Accelerator value)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder addAccelerators(int index, WorkstationConfig.Host.GceInstance.Accelerator value)

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

repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value WorkstationConfig.Host.GceInstance.Accelerator
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

addAccelerators(int index, WorkstationConfig.Host.GceInstance.Accelerator.Builder builderForValue)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder addAccelerators(int index, WorkstationConfig.Host.GceInstance.Accelerator.Builder builderForValue)

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

repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue WorkstationConfig.Host.GceInstance.Accelerator.Builder
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

addAcceleratorsBuilder()

public WorkstationConfig.Host.GceInstance.Accelerator.Builder addAcceleratorsBuilder()

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

repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WorkstationConfig.Host.GceInstance.Accelerator.Builder

addAcceleratorsBuilder(int index)

public WorkstationConfig.Host.GceInstance.Accelerator.Builder addAcceleratorsBuilder(int index)

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

repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
WorkstationConfig.Host.GceInstance.Accelerator.Builder

addAllAccelerators(Iterable<? extends WorkstationConfig.Host.GceInstance.Accelerator> values)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder addAllAccelerators(Iterable<? extends WorkstationConfig.Host.GceInstance.Accelerator> values)

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

repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator>
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

build()

public WorkstationConfig.Host.GceInstance.BoostConfig build()
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig

buildPartial()

public WorkstationConfig.Host.GceInstance.BoostConfig buildPartial()
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig

clear()

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder clear()
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder
Overrides

clearAccelerators()

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder clearAccelerators()

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

repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

clearBootDiskSizeGb()

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder clearBootDiskSizeGb()

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.

int32 boot_disk_size_gb = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

This builder for chaining.

clearEnableNestedVirtualization()

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder clearEnableNestedVirtualization()

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.

bool enable_nested_virtualization = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

This builder for chaining.

clearId()

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder clearId()

Required. The ID to be used for the boost configuration.

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

This builder for chaining.

clearMachineType()

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder clearMachineType()

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.

string machine_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

This builder for chaining.

clearPoolSize()

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder clearPoolSize()

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

int32 pool_size = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

This builder for chaining.

clearReservationAffinity()

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder clearReservationAffinity()

Optional. ReservationAffinity specifies a reservation that can be consumed to create boost VM instances. If SPECIFIC_RESERVATION is specified, Cloud Workstations will only create VMs in the zone where the reservation is located. This would affect availability since the service will no longer be resilient to zonal outages. If ANY_RESERVATION is specified, creating reservations in both zones that the config creates VMs in will ensure higher availability. Important Considerations for Reservation Affinity:

  • This feature is intended for advanced users and requires familiarity with Google Compute Engine reservations.
  • Using reservations incurs charges, regardless of utilization.
  • The resources in the pool will consume the specified reservation. Take this into account when setting the pool size.

.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.ReservationAffinity reservation_affinity = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

getAccelerators(int index)

public WorkstationConfig.Host.GceInstance.Accelerator getAccelerators(int index)

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

repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
WorkstationConfig.Host.GceInstance.Accelerator

getAcceleratorsBuilder(int index)

public WorkstationConfig.Host.GceInstance.Accelerator.Builder getAcceleratorsBuilder(int index)

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

repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
WorkstationConfig.Host.GceInstance.Accelerator.Builder

getAcceleratorsBuilderList()

public List<WorkstationConfig.Host.GceInstance.Accelerator.Builder> getAcceleratorsBuilderList()

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

repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getAcceleratorsCount()

public int getAcceleratorsCount()

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

repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAcceleratorsList()

public List<WorkstationConfig.Host.GceInstance.Accelerator> getAcceleratorsList()

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

repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Accelerator>

getAcceleratorsOrBuilder(int index)

public WorkstationConfig.Host.GceInstance.AcceleratorOrBuilder getAcceleratorsOrBuilder(int index)

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

repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
WorkstationConfig.Host.GceInstance.AcceleratorOrBuilder

getAcceleratorsOrBuilderList()

public List<? extends WorkstationConfig.Host.GceInstance.AcceleratorOrBuilder> getAcceleratorsOrBuilderList()

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

repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.AcceleratorOrBuilder>

getBootDiskSizeGb()

public int getBootDiskSizeGb()

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.

int32 boot_disk_size_gb = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The bootDiskSizeGb.

getDefaultInstanceForType()

public WorkstationConfig.Host.GceInstance.BoostConfig getDefaultInstanceForType()
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnableNestedVirtualization()

public boolean getEnableNestedVirtualization()

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.

bool enable_nested_virtualization = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enableNestedVirtualization.

getId()

public String getId()

Required. The ID to be used for the boost configuration.

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

Required. The ID to be used for the boost configuration.

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for id.

getMachineType()

public String getMachineType()

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.

string machine_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The machineType.

getMachineTypeBytes()

public ByteString getMachineTypeBytes()

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.

string machine_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for machineType.

getPoolSize()

public int getPoolSize()

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

int32 pool_size = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The poolSize.

getReservationAffinity()

public WorkstationConfig.Host.GceInstance.ReservationAffinity getReservationAffinity()

Optional. ReservationAffinity specifies a reservation that can be consumed to create boost VM instances. If SPECIFIC_RESERVATION is specified, Cloud Workstations will only create VMs in the zone where the reservation is located. This would affect availability since the service will no longer be resilient to zonal outages. If ANY_RESERVATION is specified, creating reservations in both zones that the config creates VMs in will ensure higher availability. Important Considerations for Reservation Affinity:

  • This feature is intended for advanced users and requires familiarity with Google Compute Engine reservations.
  • Using reservations incurs charges, regardless of utilization.
  • The resources in the pool will consume the specified reservation. Take this into account when setting the pool size.

.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.ReservationAffinity reservation_affinity = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WorkstationConfig.Host.GceInstance.ReservationAffinity

The reservationAffinity.

getReservationAffinityBuilder()

public WorkstationConfig.Host.GceInstance.ReservationAffinity.Builder getReservationAffinityBuilder()

Optional. ReservationAffinity specifies a reservation that can be consumed to create boost VM instances. If SPECIFIC_RESERVATION is specified, Cloud Workstations will only create VMs in the zone where the reservation is located. This would affect availability since the service will no longer be resilient to zonal outages. If ANY_RESERVATION is specified, creating reservations in both zones that the config creates VMs in will ensure higher availability. Important Considerations for Reservation Affinity:

  • This feature is intended for advanced users and requires familiarity with Google Compute Engine reservations.
  • Using reservations incurs charges, regardless of utilization.
  • The resources in the pool will consume the specified reservation. Take this into account when setting the pool size.

.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.ReservationAffinity reservation_affinity = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WorkstationConfig.Host.GceInstance.ReservationAffinity.Builder

getReservationAffinityOrBuilder()

public WorkstationConfig.Host.GceInstance.ReservationAffinityOrBuilder getReservationAffinityOrBuilder()

Optional. ReservationAffinity specifies a reservation that can be consumed to create boost VM instances. If SPECIFIC_RESERVATION is specified, Cloud Workstations will only create VMs in the zone where the reservation is located. This would affect availability since the service will no longer be resilient to zonal outages. If ANY_RESERVATION is specified, creating reservations in both zones that the config creates VMs in will ensure higher availability. Important Considerations for Reservation Affinity:

  • This feature is intended for advanced users and requires familiarity with Google Compute Engine reservations.
  • Using reservations incurs charges, regardless of utilization.
  • The resources in the pool will consume the specified reservation. Take this into account when setting the pool size.

.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.ReservationAffinity reservation_affinity = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WorkstationConfig.Host.GceInstance.ReservationAffinityOrBuilder

hasReservationAffinity()

public boolean hasReservationAffinity()

Optional. ReservationAffinity specifies a reservation that can be consumed to create boost VM instances. If SPECIFIC_RESERVATION is specified, Cloud Workstations will only create VMs in the zone where the reservation is located. This would affect availability since the service will no longer be resilient to zonal outages. If ANY_RESERVATION is specified, creating reservations in both zones that the config creates VMs in will ensure higher availability. Important Considerations for Reservation Affinity:

  • This feature is intended for advanced users and requires familiarity with Google Compute Engine reservations.
  • Using reservations incurs charges, regardless of utilization.
  • The resources in the pool will consume the specified reservation. Take this into account when setting the pool size.

.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.ReservationAffinity reservation_affinity = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the reservationAffinity field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(WorkstationConfig.Host.GceInstance.BoostConfig other)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder mergeFrom(WorkstationConfig.Host.GceInstance.BoostConfig other)
Parameter
Name Description
other WorkstationConfig.Host.GceInstance.BoostConfig
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder
Overrides

mergeReservationAffinity(WorkstationConfig.Host.GceInstance.ReservationAffinity value)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder mergeReservationAffinity(WorkstationConfig.Host.GceInstance.ReservationAffinity value)

Optional. ReservationAffinity specifies a reservation that can be consumed to create boost VM instances. If SPECIFIC_RESERVATION is specified, Cloud Workstations will only create VMs in the zone where the reservation is located. This would affect availability since the service will no longer be resilient to zonal outages. If ANY_RESERVATION is specified, creating reservations in both zones that the config creates VMs in will ensure higher availability. Important Considerations for Reservation Affinity:

  • This feature is intended for advanced users and requires familiarity with Google Compute Engine reservations.
  • Using reservations incurs charges, regardless of utilization.
  • The resources in the pool will consume the specified reservation. Take this into account when setting the pool size.

.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.ReservationAffinity reservation_affinity = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value WorkstationConfig.Host.GceInstance.ReservationAffinity
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

removeAccelerators(int index)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder removeAccelerators(int index)

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

repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

setAccelerators(int index, WorkstationConfig.Host.GceInstance.Accelerator value)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder setAccelerators(int index, WorkstationConfig.Host.GceInstance.Accelerator value)

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

repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value WorkstationConfig.Host.GceInstance.Accelerator
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

setAccelerators(int index, WorkstationConfig.Host.GceInstance.Accelerator.Builder builderForValue)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder setAccelerators(int index, WorkstationConfig.Host.GceInstance.Accelerator.Builder builderForValue)

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

repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue WorkstationConfig.Host.GceInstance.Accelerator.Builder
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

setBootDiskSizeGb(int value)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder setBootDiskSizeGb(int value)

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.

int32 boot_disk_size_gb = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The bootDiskSizeGb to set.

Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

This builder for chaining.

setEnableNestedVirtualization(boolean value)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder setEnableNestedVirtualization(boolean value)

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.

bool enable_nested_virtualization = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The enableNestedVirtualization to set.

Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

This builder for chaining.

setId(String value)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder setId(String value)

Required. The ID to be used for the boost configuration.

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The id to set.

Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

This builder for chaining.

setIdBytes(ByteString value)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder setIdBytes(ByteString value)

Required. The ID to be used for the boost configuration.

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for id to set.

Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

This builder for chaining.

setMachineType(String value)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder setMachineType(String value)

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.

string machine_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The machineType to set.

Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

This builder for chaining.

setMachineTypeBytes(ByteString value)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder setMachineTypeBytes(ByteString value)

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.

string machine_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for machineType to set.

Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

This builder for chaining.

setPoolSize(int value)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder setPoolSize(int value)

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

int32 pool_size = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The poolSize to set.

Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

This builder for chaining.

setReservationAffinity(WorkstationConfig.Host.GceInstance.ReservationAffinity value)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder setReservationAffinity(WorkstationConfig.Host.GceInstance.ReservationAffinity value)

Optional. ReservationAffinity specifies a reservation that can be consumed to create boost VM instances. If SPECIFIC_RESERVATION is specified, Cloud Workstations will only create VMs in the zone where the reservation is located. This would affect availability since the service will no longer be resilient to zonal outages. If ANY_RESERVATION is specified, creating reservations in both zones that the config creates VMs in will ensure higher availability. Important Considerations for Reservation Affinity:

  • This feature is intended for advanced users and requires familiarity with Google Compute Engine reservations.
  • Using reservations incurs charges, regardless of utilization.
  • The resources in the pool will consume the specified reservation. Take this into account when setting the pool size.

.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.ReservationAffinity reservation_affinity = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value WorkstationConfig.Host.GceInstance.ReservationAffinity
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

setReservationAffinity(WorkstationConfig.Host.GceInstance.ReservationAffinity.Builder builderForValue)

public WorkstationConfig.Host.GceInstance.BoostConfig.Builder setReservationAffinity(WorkstationConfig.Host.GceInstance.ReservationAffinity.Builder builderForValue)

Optional. ReservationAffinity specifies a reservation that can be consumed to create boost VM instances. If SPECIFIC_RESERVATION is specified, Cloud Workstations will only create VMs in the zone where the reservation is located. This would affect availability since the service will no longer be resilient to zonal outages. If ANY_RESERVATION is specified, creating reservations in both zones that the config creates VMs in will ensure higher availability. Important Considerations for Reservation Affinity:

  • This feature is intended for advanced users and requires familiarity with Google Compute Engine reservations.
  • Using reservations incurs charges, regardless of utilization.
  • The resources in the pool will consume the specified reservation. Take this into account when setting the pool size.

.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.ReservationAffinity reservation_affinity = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue WorkstationConfig.Host.GceInstance.ReservationAffinity.Builder
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder