Class WorkstationConfig.Host.GceInstance.BoostConfig (0.81.0) 

public static final class WorkstationConfig.Host.GceInstance.BoostConfig extends GeneratedMessage 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > WorkstationConfig.Host.GceInstance.BoostConfig

Static Fields

ACCELERATORS_FIELD_NUMBER

public static final int ACCELERATORS_FIELD_NUMBER
Field Value
Type Description
int

BOOT_DISK_SIZE_GB_FIELD_NUMBER

public static final int BOOT_DISK_SIZE_GB_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_NESTED_VIRTUALIZATION_FIELD_NUMBER

public static final int ENABLE_NESTED_VIRTUALIZATION_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

MACHINE_TYPE_FIELD_NUMBER

public static final int MACHINE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

POOL_SIZE_FIELD_NUMBER

public static final int POOL_SIZE_FIELD_NUMBER
Field Value
Type Description
int

RESERVATION_AFFINITY_FIELD_NUMBER

public static final int RESERVATION_AFFINITY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static WorkstationConfig.Host.GceInstance.BoostConfig getDefaultInstance()
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig

getDescriptor()

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

newBuilder()

public static WorkstationConfig.Host.GceInstance.BoostConfig.Builder newBuilder()
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

newBuilder(WorkstationConfig.Host.GceInstance.BoostConfig prototype)

public static WorkstationConfig.Host.GceInstance.BoostConfig.Builder newBuilder(WorkstationConfig.Host.GceInstance.BoostConfig prototype)
Parameter
Name Description
prototype WorkstationConfig.Host.GceInstance.BoostConfig
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder

parseDelimitedFrom(InputStream input)

public static WorkstationConfig.Host.GceInstance.BoostConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkstationConfig.Host.GceInstance.BoostConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static WorkstationConfig.Host.GceInstance.BoostConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WorkstationConfig.Host.GceInstance.BoostConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static WorkstationConfig.Host.GceInstance.BoostConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WorkstationConfig.Host.GceInstance.BoostConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static WorkstationConfig.Host.GceInstance.BoostConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static WorkstationConfig.Host.GceInstance.BoostConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WorkstationConfig.Host.GceInstance.BoostConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static WorkstationConfig.Host.GceInstance.BoostConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WorkstationConfig.Host.GceInstance.BoostConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<WorkstationConfig.Host.GceInstance.BoostConfig> parser()
Returns
Type Description
Parser<BoostConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

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

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.

getParserForType()

public Parser<WorkstationConfig.Host.GceInstance.BoostConfig> getParserForType()
Returns
Type Description
Parser<BoostConfig>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected WorkstationConfig.Host.GceInstance.BoostConfig.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
WorkstationConfig.Host.GceInstance.BoostConfig.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException