public static final class WorkstationConfig.Host.GceInstance.Builder extends GeneratedMessage.Builder<WorkstationConfig.Host.GceInstance.Builder> implements WorkstationConfig.Host.GceInstanceOrBuilderA runtime using a Compute Engine instance.
Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > WorkstationConfig.Host.GceInstance.BuilderImplements
WorkstationConfig.Host.GceInstanceOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAccelerators(WorkstationConfig.Host.GceInstance.Accelerator value)
public WorkstationConfig.Host.GceInstance.Builder addAccelerators(WorkstationConfig.Host.GceInstance.Accelerator value)Optional. A list of the type and count of accelerator cards attached to the instance.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WorkstationConfig.Host.GceInstance.Accelerator |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
addAccelerators(WorkstationConfig.Host.GceInstance.Accelerator.Builder builderForValue)
public WorkstationConfig.Host.GceInstance.Builder addAccelerators(WorkstationConfig.Host.GceInstance.Accelerator.Builder builderForValue)Optional. A list of the type and count of accelerator cards attached to the instance.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
WorkstationConfig.Host.GceInstance.Accelerator.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
addAccelerators(int index, WorkstationConfig.Host.GceInstance.Accelerator value)
public WorkstationConfig.Host.GceInstance.Builder addAccelerators(int index, WorkstationConfig.Host.GceInstance.Accelerator value)Optional. A list of the type and count of accelerator cards attached to the instance.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
WorkstationConfig.Host.GceInstance.Accelerator |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
addAccelerators(int index, WorkstationConfig.Host.GceInstance.Accelerator.Builder builderForValue)
public WorkstationConfig.Host.GceInstance.Builder addAccelerators(int index, WorkstationConfig.Host.GceInstance.Accelerator.Builder builderForValue)Optional. A list of the type and count of accelerator cards attached to the instance.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
WorkstationConfig.Host.GceInstance.Accelerator.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
addAcceleratorsBuilder()
public WorkstationConfig.Host.GceInstance.Accelerator.Builder addAcceleratorsBuilder()Optional. A list of the type and count of accelerator cards attached to the instance.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 11 [(.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 instance.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 11 [(.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.Builder addAllAccelerators(Iterable<? extends WorkstationConfig.Host.GceInstance.Accelerator> values)Optional. A list of the type and count of accelerator cards attached to the instance.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 11 [(.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.Builder |
|
addAllBoostConfigs(Iterable<? extends WorkstationConfig.Host.GceInstance.BoostConfig> values)
public WorkstationConfig.Host.GceInstance.Builder addAllBoostConfigs(Iterable<? extends WorkstationConfig.Host.GceInstance.BoostConfig> values)Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig boost_configs = 25 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig> |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
addAllServiceAccountScopes(Iterable<String> values)
public WorkstationConfig.Host.GceInstance.Builder addAllServiceAccountScopes(Iterable<String> values) Optional. Scopes to grant to the
service_account.
When specified, users of workstations under this configuration must
have iam.serviceAccounts.actAs on the service account.
repeated string service_account_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The serviceAccountScopes to add. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
addAllTags(Iterable<String> values)
public WorkstationConfig.Host.GceInstance.Builder addAllTags(Iterable<String> values)Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies network tags to VMs created with this configuration. These network tags enable the creation of firewall rules.
repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The tags to add. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
addBoostConfigs(WorkstationConfig.Host.GceInstance.BoostConfig value)
public WorkstationConfig.Host.GceInstance.Builder addBoostConfigs(WorkstationConfig.Host.GceInstance.BoostConfig value)Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig boost_configs = 25 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WorkstationConfig.Host.GceInstance.BoostConfig |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
addBoostConfigs(WorkstationConfig.Host.GceInstance.BoostConfig.Builder builderForValue)
public WorkstationConfig.Host.GceInstance.Builder addBoostConfigs(WorkstationConfig.Host.GceInstance.BoostConfig.Builder builderForValue)Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig boost_configs = 25 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
WorkstationConfig.Host.GceInstance.BoostConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
addBoostConfigs(int index, WorkstationConfig.Host.GceInstance.BoostConfig value)
public WorkstationConfig.Host.GceInstance.Builder addBoostConfigs(int index, WorkstationConfig.Host.GceInstance.BoostConfig value)Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig boost_configs = 25 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
WorkstationConfig.Host.GceInstance.BoostConfig |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
addBoostConfigs(int index, WorkstationConfig.Host.GceInstance.BoostConfig.Builder builderForValue)
public WorkstationConfig.Host.GceInstance.Builder addBoostConfigs(int index, WorkstationConfig.Host.GceInstance.BoostConfig.Builder builderForValue)Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig boost_configs = 25 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
WorkstationConfig.Host.GceInstance.BoostConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
addBoostConfigsBuilder()
public WorkstationConfig.Host.GceInstance.BoostConfig.Builder addBoostConfigsBuilder()Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig boost_configs = 25 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.BoostConfig.Builder |
|
addBoostConfigsBuilder(int index)
public WorkstationConfig.Host.GceInstance.BoostConfig.Builder addBoostConfigsBuilder(int index)Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig boost_configs = 25 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.BoostConfig.Builder |
|
addServiceAccountScopes(String value)
public WorkstationConfig.Host.GceInstance.Builder addServiceAccountScopes(String value) Optional. Scopes to grant to the
service_account.
When specified, users of workstations under this configuration must
have iam.serviceAccounts.actAs on the service account.
repeated string service_account_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe serviceAccountScopes to add. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
addServiceAccountScopesBytes(ByteString value)
public WorkstationConfig.Host.GceInstance.Builder addServiceAccountScopesBytes(ByteString value) Optional. Scopes to grant to the
service_account.
When specified, users of workstations under this configuration must
have iam.serviceAccounts.actAs on the service account.
repeated string service_account_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the serviceAccountScopes to add. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
addTags(String value)
public WorkstationConfig.Host.GceInstance.Builder addTags(String value)Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies network tags to VMs created with this configuration. These network tags enable the creation of firewall rules.
repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe tags to add. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
addTagsBytes(ByteString value)
public WorkstationConfig.Host.GceInstance.Builder addTagsBytes(ByteString value)Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies network tags to VMs created with this configuration. These network tags enable the creation of firewall rules.
repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the tags to add. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
build()
public WorkstationConfig.Host.GceInstance build()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance |
|
buildPartial()
public WorkstationConfig.Host.GceInstance buildPartial()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance |
|
clear()
public WorkstationConfig.Host.GceInstance.Builder clear()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
clearAccelerators()
public WorkstationConfig.Host.GceInstance.Builder clearAccelerators()Optional. A list of the type and count of accelerator cards attached to the instance.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
clearBoostConfigs()
public WorkstationConfig.Host.GceInstance.Builder clearBoostConfigs()Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig boost_configs = 25 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
clearBootDiskSizeGb()
public WorkstationConfig.Host.GceInstance.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 = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
clearConfidentialInstanceConfig()
public WorkstationConfig.Host.GceInstance.Builder clearConfidentialInstanceConfig()Optional. A set of Compute Engine Confidential VM instance options.
.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig confidential_instance_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
clearDisablePublicIpAddresses()
public WorkstationConfig.Host.GceInstance.Builder clearDisablePublicIpAddresses() Optional. When set to true, disables public IP addresses for VMs. If
you disable public IP addresses, you must set up Private Google Access
or Cloud NAT on your network. If you use Private Google Access and you
use private.googleapis.com or restricted.googleapis.com for
Container Registry and Artifact Registry, make sure that you set
up DNS records for domains .gcr.io and .pkg.dev.
Defaults to false (VMs have public IP addresses).
bool disable_public_ip_addresses = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
clearDisableSsh()
public WorkstationConfig.Host.GceInstance.Builder clearDisableSsh()Optional. Whether to disable SSH access to the VM.
bool disable_ssh = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
clearEnableNestedVirtualization()
public WorkstationConfig.Host.GceInstance.Builder clearEnableNestedVirtualization()Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation 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 workstation 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.Builder |
This builder for chaining. |
clearInstanceMetadata()
public WorkstationConfig.Host.GceInstance.Builder clearInstanceMetadata()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
clearMachineType()
public WorkstationConfig.Host.GceInstance.Builder clearMachineType() Optional. The type of machine to use for VM instances—for example,
"e2-standard-4". For more information about machine types that
Cloud Workstations supports, see the list of
available machine
types.
string machine_type = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
clearPoolSize()
public WorkstationConfig.Host.GceInstance.Builder clearPoolSize() Optional. The number of VMs that the system should keep idle so that
new workstations can be started quickly for new users. Defaults to 0
in the API.
int32 pool_size = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
clearPooledInstances()
public WorkstationConfig.Host.GceInstance.Builder clearPooledInstances()Output only. Number of instances currently available in the pool for faster workstation startup.
int32 pooled_instances = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
clearReservationAffinity()
public WorkstationConfig.Host.GceInstance.Builder clearReservationAffinity()Optional. ReservationAffinity specifies a reservation that can be consumed to create 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 = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
clearServiceAccount()
public WorkstationConfig.Host.GceInstance.Builder clearServiceAccount() Optional. The email address of the service account for Cloud
Workstations VMs created with this configuration. When specified, be
sure that the service account has logging.logEntries.create and
monitoring.timeSeries.create permissions on the project so it can
write logs out to Cloud Logging. If using a custom container image, the
service account must have Artifact Registry
Reader
permission to pull the specified image.
If you as the administrator want to be able to ssh into the
underlying VM, you need to set this value to a service account
for which you have the iam.serviceAccounts.actAs permission.
Conversely, if you don't want anyone to be able to ssh into the
underlying VM, use a service account where no one has that
permission.
If not set, VMs run with a service account provided by the Cloud Workstations service, and the image must be publicly accessible.
string service_account = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
clearServiceAccountScopes()
public WorkstationConfig.Host.GceInstance.Builder clearServiceAccountScopes() Optional. Scopes to grant to the
service_account.
When specified, users of workstations under this configuration must
have iam.serviceAccounts.actAs on the service account.
repeated string service_account_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
clearShieldedInstanceConfig()
public WorkstationConfig.Host.GceInstance.Builder clearShieldedInstanceConfig()Optional. A set of Compute Engine Shielded instance options.
.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig shielded_instance_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
clearStartupScriptUri()
public WorkstationConfig.Host.GceInstance.Builder clearStartupScriptUri()Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have Permission to access the bucket and script file in Cloud Storage. Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version of the host VM, and it is the responsibility of the user to ensure the script stays compatible with the OS version.
string startup_script_uri = 26 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
clearTags()
public WorkstationConfig.Host.GceInstance.Builder clearTags()Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies network tags to VMs created with this configuration. These network tags enable the creation of firewall rules.
repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
clearVmTags()
public WorkstationConfig.Host.GceInstance.Builder clearVmTags()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
containsInstanceMetadata(String key)
public boolean containsInstanceMetadata(String key)Optional. Custom metadata to apply to Compute Engine instances.
map<string, string> instance_metadata = 27 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
containsVmTags(String key)
public boolean containsVmTags(String key) Optional. Resource manager tags to be bound to this instance.
Tag keys and values have the same definition as resource manager
tags.
Keys must be in the format tagKeys/{tag_key_id}, and
values are in the format tagValues/456.
map<string, string> vm_tags = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 instance.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 11 [(.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 instance.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 11 [(.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 instance.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 11 [(.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 instance.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 11 [(.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 instance.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 11 [(.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 instance.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 11 [(.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 instance.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.AcceleratorOrBuilder> |
|
getBoostConfigs(int index)
public WorkstationConfig.Host.GceInstance.BoostConfig getBoostConfigs(int index)Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig boost_configs = 25 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.BoostConfig |
|
getBoostConfigsBuilder(int index)
public WorkstationConfig.Host.GceInstance.BoostConfig.Builder getBoostConfigsBuilder(int index)Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig boost_configs = 25 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.BoostConfig.Builder |
|
getBoostConfigsBuilderList()
public List<WorkstationConfig.Host.GceInstance.BoostConfig.Builder> getBoostConfigsBuilderList()Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig boost_configs = 25 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getBoostConfigsCount()
public int getBoostConfigsCount()Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig boost_configs = 25 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getBoostConfigsList()
public List<WorkstationConfig.Host.GceInstance.BoostConfig> getBoostConfigsList()Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig boost_configs = 25 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<BoostConfig> |
|
getBoostConfigsOrBuilder(int index)
public WorkstationConfig.Host.GceInstance.BoostConfigOrBuilder getBoostConfigsOrBuilder(int index)Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig boost_configs = 25 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.BoostConfigOrBuilder |
|
getBoostConfigsOrBuilderList()
public List<? extends WorkstationConfig.Host.GceInstance.BoostConfigOrBuilder> getBoostConfigsOrBuilderList()Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig boost_configs = 25 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfigOrBuilder> |
|
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 = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The bootDiskSizeGb. |
getConfidentialInstanceConfig()
public WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig getConfidentialInstanceConfig()Optional. A set of Compute Engine Confidential VM instance options.
.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig confidential_instance_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig |
The confidentialInstanceConfig. |
getConfidentialInstanceConfigBuilder()
public WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig.Builder getConfidentialInstanceConfigBuilder()Optional. A set of Compute Engine Confidential VM instance options.
.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig confidential_instance_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig.Builder |
|
getConfidentialInstanceConfigOrBuilder()
public WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfigOrBuilder getConfidentialInstanceConfigOrBuilder()Optional. A set of Compute Engine Confidential VM instance options.
.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig confidential_instance_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfigOrBuilder |
|
getDefaultInstanceForType()
public WorkstationConfig.Host.GceInstance getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisablePublicIpAddresses()
public boolean getDisablePublicIpAddresses() Optional. When set to true, disables public IP addresses for VMs. If
you disable public IP addresses, you must set up Private Google Access
or Cloud NAT on your network. If you use Private Google Access and you
use private.googleapis.com or restricted.googleapis.com for
Container Registry and Artifact Registry, make sure that you set
up DNS records for domains .gcr.io and .pkg.dev.
Defaults to false (VMs have public IP addresses).
bool disable_public_ip_addresses = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The disablePublicIpAddresses. |
getDisableSsh()
public boolean getDisableSsh()Optional. Whether to disable SSH access to the VM.
bool disable_ssh = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The disableSsh. |
getEnableNestedVirtualization()
public boolean getEnableNestedVirtualization()Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation 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 workstation 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. |
getInstanceMetadata() (deprecated)
public Map<String,String> getInstanceMetadata()Use #getInstanceMetadataMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getInstanceMetadataCount()
public int getInstanceMetadataCount()Optional. Custom metadata to apply to Compute Engine instances.
map<string, string> instance_metadata = 27 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getInstanceMetadataMap()
public Map<String,String> getInstanceMetadataMap()Optional. Custom metadata to apply to Compute Engine instances.
map<string, string> instance_metadata = 27 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getInstanceMetadataOrDefault(String key, String defaultValue)
public String getInstanceMetadataOrDefault(String key, String defaultValue)Optional. Custom metadata to apply to Compute Engine instances.
map<string, string> instance_metadata = 27 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getInstanceMetadataOrThrow(String key)
public String getInstanceMetadataOrThrow(String key)Optional. Custom metadata to apply to Compute Engine instances.
map<string, string> instance_metadata = 27 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getMachineType()
public String getMachineType() Optional. The type of machine to use for VM instances—for example,
"e2-standard-4". For more information about machine types that
Cloud Workstations supports, see the list of
available machine
types.
string machine_type = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The machineType. |
getMachineTypeBytes()
public ByteString getMachineTypeBytes() Optional. The type of machine to use for VM instances—for example,
"e2-standard-4". For more information about machine types that
Cloud Workstations supports, see the list of
available machine
types.
string machine_type = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for machineType. |
getMutableInstanceMetadata() (deprecated)
public Map<String,String> getMutableInstanceMetadata()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getMutableVmTags() (deprecated)
public Map<String,String> getMutableVmTags()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getPoolSize()
public int getPoolSize() Optional. The number of VMs that the system should keep idle so that
new workstations can be started quickly for new users. Defaults to 0
in the API.
int32 pool_size = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The poolSize. |
getPooledInstances()
public int getPooledInstances()Output only. Number of instances currently available in the pool for faster workstation startup.
int32 pooled_instances = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The pooledInstances. |
getReservationAffinity()
public WorkstationConfig.Host.GceInstance.ReservationAffinity getReservationAffinity()Optional. ReservationAffinity specifies a reservation that can be consumed to create 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 = 15 [(.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 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 = 15 [(.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 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 = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.ReservationAffinityOrBuilder |
|
getServiceAccount()
public String getServiceAccount() Optional. The email address of the service account for Cloud
Workstations VMs created with this configuration. When specified, be
sure that the service account has logging.logEntries.create and
monitoring.timeSeries.create permissions on the project so it can
write logs out to Cloud Logging. If using a custom container image, the
service account must have Artifact Registry
Reader
permission to pull the specified image.
If you as the administrator want to be able to ssh into the
underlying VM, you need to set this value to a service account
for which you have the iam.serviceAccounts.actAs permission.
Conversely, if you don't want anyone to be able to ssh into the
underlying VM, use a service account where no one has that
permission.
If not set, VMs run with a service account provided by the Cloud Workstations service, and the image must be publicly accessible.
string service_account = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The serviceAccount. |
getServiceAccountBytes()
public ByteString getServiceAccountBytes() Optional. The email address of the service account for Cloud
Workstations VMs created with this configuration. When specified, be
sure that the service account has logging.logEntries.create and
monitoring.timeSeries.create permissions on the project so it can
write logs out to Cloud Logging. If using a custom container image, the
service account must have Artifact Registry
Reader
permission to pull the specified image.
If you as the administrator want to be able to ssh into the
underlying VM, you need to set this value to a service account
for which you have the iam.serviceAccounts.actAs permission.
Conversely, if you don't want anyone to be able to ssh into the
underlying VM, use a service account where no one has that
permission.
If not set, VMs run with a service account provided by the Cloud Workstations service, and the image must be publicly accessible.
string service_account = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for serviceAccount. |
getServiceAccountScopes(int index)
public String getServiceAccountScopes(int index) Optional. Scopes to grant to the
service_account.
When specified, users of workstations under this configuration must
have iam.serviceAccounts.actAs on the service account.
repeated string service_account_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The serviceAccountScopes at the given index. |
getServiceAccountScopesBytes(int index)
public ByteString getServiceAccountScopesBytes(int index) Optional. Scopes to grant to the
service_account.
When specified, users of workstations under this configuration must
have iam.serviceAccounts.actAs on the service account.
repeated string service_account_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the serviceAccountScopes at the given index. |
getServiceAccountScopesCount()
public int getServiceAccountScopesCount() Optional. Scopes to grant to the
service_account.
When specified, users of workstations under this configuration must
have iam.serviceAccounts.actAs on the service account.
repeated string service_account_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of serviceAccountScopes. |
getServiceAccountScopesList()
public ProtocolStringList getServiceAccountScopesList() Optional. Scopes to grant to the
service_account.
When specified, users of workstations under this configuration must
have iam.serviceAccounts.actAs on the service account.
repeated string service_account_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the serviceAccountScopes. |
getShieldedInstanceConfig()
public WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig getShieldedInstanceConfig()Optional. A set of Compute Engine Shielded instance options.
.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig shielded_instance_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig |
The shieldedInstanceConfig. |
getShieldedInstanceConfigBuilder()
public WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig.Builder getShieldedInstanceConfigBuilder()Optional. A set of Compute Engine Shielded instance options.
.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig shielded_instance_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig.Builder |
|
getShieldedInstanceConfigOrBuilder()
public WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()Optional. A set of Compute Engine Shielded instance options.
.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig shielded_instance_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfigOrBuilder |
|
getStartupScriptUri()
public String getStartupScriptUri()Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have Permission to access the bucket and script file in Cloud Storage. Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version of the host VM, and it is the responsibility of the user to ensure the script stays compatible with the OS version.
string startup_script_uri = 26 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The startupScriptUri. |
getStartupScriptUriBytes()
public ByteString getStartupScriptUriBytes()Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have Permission to access the bucket and script file in Cloud Storage. Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version of the host VM, and it is the responsibility of the user to ensure the script stays compatible with the OS version.
string startup_script_uri = 26 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for startupScriptUri. |
getTags(int index)
public String getTags(int index)Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies network tags to VMs created with this configuration. These network tags enable the creation of firewall rules.
repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The tags at the given index. |
getTagsBytes(int index)
public ByteString getTagsBytes(int index)Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies network tags to VMs created with this configuration. These network tags enable the creation of firewall rules.
repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the tags at the given index. |
getTagsCount()
public int getTagsCount()Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies network tags to VMs created with this configuration. These network tags enable the creation of firewall rules.
repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of tags. |
getTagsList()
public ProtocolStringList getTagsList()Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies network tags to VMs created with this configuration. These network tags enable the creation of firewall rules.
repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the tags. |
getVmTags() (deprecated)
public Map<String,String> getVmTags()Use #getVmTagsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getVmTagsCount()
public int getVmTagsCount() Optional. Resource manager tags to be bound to this instance.
Tag keys and values have the same definition as resource manager
tags.
Keys must be in the format tagKeys/{tag_key_id}, and
values are in the format tagValues/456.
map<string, string> vm_tags = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getVmTagsMap()
public Map<String,String> getVmTagsMap() Optional. Resource manager tags to be bound to this instance.
Tag keys and values have the same definition as resource manager
tags.
Keys must be in the format tagKeys/{tag_key_id}, and
values are in the format tagValues/456.
map<string, string> vm_tags = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getVmTagsOrDefault(String key, String defaultValue)
public String getVmTagsOrDefault(String key, String defaultValue) Optional. Resource manager tags to be bound to this instance.
Tag keys and values have the same definition as resource manager
tags.
Keys must be in the format tagKeys/{tag_key_id}, and
values are in the format tagValues/456.
map<string, string> vm_tags = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getVmTagsOrThrow(String key)
public String getVmTagsOrThrow(String key) Optional. Resource manager tags to be bound to this instance.
Tag keys and values have the same definition as resource manager
tags.
Keys must be in the format tagKeys/{tag_key_id}, and
values are in the format tagValues/456.
map<string, string> vm_tags = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
hasConfidentialInstanceConfig()
public boolean hasConfidentialInstanceConfig()Optional. A set of Compute Engine Confidential VM instance options.
.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig confidential_instance_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the confidentialInstanceConfig field is set. |
hasReservationAffinity()
public boolean hasReservationAffinity()Optional. ReservationAffinity specifies a reservation that can be consumed to create 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 = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the reservationAffinity field is set. |
hasShieldedInstanceConfig()
public boolean hasShieldedInstanceConfig()Optional. A set of Compute Engine Shielded instance options.
.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig shielded_instance_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the shieldedInstanceConfig field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeConfidentialInstanceConfig(WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig value)
public WorkstationConfig.Host.GceInstance.Builder mergeConfidentialInstanceConfig(WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig value)Optional. A set of Compute Engine Confidential VM instance options.
.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig confidential_instance_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
mergeFrom(WorkstationConfig.Host.GceInstance other)
public WorkstationConfig.Host.GceInstance.Builder mergeFrom(WorkstationConfig.Host.GceInstance other)| Parameter | |
|---|---|
| Name | Description |
other |
WorkstationConfig.Host.GceInstance |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public WorkstationConfig.Host.GceInstance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public WorkstationConfig.Host.GceInstance.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
mergeReservationAffinity(WorkstationConfig.Host.GceInstance.ReservationAffinity value)
public WorkstationConfig.Host.GceInstance.Builder mergeReservationAffinity(WorkstationConfig.Host.GceInstance.ReservationAffinity value)Optional. ReservationAffinity specifies a reservation that can be consumed to create 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 = 15 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WorkstationConfig.Host.GceInstance.ReservationAffinity |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
mergeShieldedInstanceConfig(WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig value)
public WorkstationConfig.Host.GceInstance.Builder mergeShieldedInstanceConfig(WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig value)Optional. A set of Compute Engine Shielded instance options.
.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig shielded_instance_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
putAllInstanceMetadata(Map<String,String> values)
public WorkstationConfig.Host.GceInstance.Builder putAllInstanceMetadata(Map<String,String> values)Optional. Custom metadata to apply to Compute Engine instances.
map<string, string> instance_metadata = 27 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
putAllVmTags(Map<String,String> values)
public WorkstationConfig.Host.GceInstance.Builder putAllVmTags(Map<String,String> values) Optional. Resource manager tags to be bound to this instance.
Tag keys and values have the same definition as resource manager
tags.
Keys must be in the format tagKeys/{tag_key_id}, and
values are in the format tagValues/456.
map<string, string> vm_tags = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
putInstanceMetadata(String key, String value)
public WorkstationConfig.Host.GceInstance.Builder putInstanceMetadata(String key, String value)Optional. Custom metadata to apply to Compute Engine instances.
map<string, string> instance_metadata = 27 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
putVmTags(String key, String value)
public WorkstationConfig.Host.GceInstance.Builder putVmTags(String key, String value) Optional. Resource manager tags to be bound to this instance.
Tag keys and values have the same definition as resource manager
tags.
Keys must be in the format tagKeys/{tag_key_id}, and
values are in the format tagValues/456.
map<string, string> vm_tags = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
removeAccelerators(int index)
public WorkstationConfig.Host.GceInstance.Builder removeAccelerators(int index)Optional. A list of the type and count of accelerator cards attached to the instance.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
removeBoostConfigs(int index)
public WorkstationConfig.Host.GceInstance.Builder removeBoostConfigs(int index)Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig boost_configs = 25 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
removeInstanceMetadata(String key)
public WorkstationConfig.Host.GceInstance.Builder removeInstanceMetadata(String key)Optional. Custom metadata to apply to Compute Engine instances.
map<string, string> instance_metadata = 27 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
removeVmTags(String key)
public WorkstationConfig.Host.GceInstance.Builder removeVmTags(String key) Optional. Resource manager tags to be bound to this instance.
Tag keys and values have the same definition as resource manager
tags.
Keys must be in the format tagKeys/{tag_key_id}, and
values are in the format tagValues/456.
map<string, string> vm_tags = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
setAccelerators(int index, WorkstationConfig.Host.GceInstance.Accelerator value)
public WorkstationConfig.Host.GceInstance.Builder setAccelerators(int index, WorkstationConfig.Host.GceInstance.Accelerator value)Optional. A list of the type and count of accelerator cards attached to the instance.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
WorkstationConfig.Host.GceInstance.Accelerator |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
setAccelerators(int index, WorkstationConfig.Host.GceInstance.Accelerator.Builder builderForValue)
public WorkstationConfig.Host.GceInstance.Builder setAccelerators(int index, WorkstationConfig.Host.GceInstance.Accelerator.Builder builderForValue)Optional. A list of the type and count of accelerator cards attached to the instance.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.Accelerator accelerators = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
WorkstationConfig.Host.GceInstance.Accelerator.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
setBoostConfigs(int index, WorkstationConfig.Host.GceInstance.BoostConfig value)
public WorkstationConfig.Host.GceInstance.Builder setBoostConfigs(int index, WorkstationConfig.Host.GceInstance.BoostConfig value)Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig boost_configs = 25 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
WorkstationConfig.Host.GceInstance.BoostConfig |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
setBoostConfigs(int index, WorkstationConfig.Host.GceInstance.BoostConfig.Builder builderForValue)
public WorkstationConfig.Host.GceInstance.Builder setBoostConfigs(int index, WorkstationConfig.Host.GceInstance.BoostConfig.Builder builderForValue)Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.BoostConfig boost_configs = 25 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
WorkstationConfig.Host.GceInstance.BoostConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
setBootDiskSizeGb(int value)
public WorkstationConfig.Host.GceInstance.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 = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe bootDiskSizeGb to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
setConfidentialInstanceConfig(WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig value)
public WorkstationConfig.Host.GceInstance.Builder setConfidentialInstanceConfig(WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig value)Optional. A set of Compute Engine Confidential VM instance options.
.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig confidential_instance_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
setConfidentialInstanceConfig(WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig.Builder builderForValue)
public WorkstationConfig.Host.GceInstance.Builder setConfidentialInstanceConfig(WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig.Builder builderForValue)Optional. A set of Compute Engine Confidential VM instance options.
.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig confidential_instance_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
setDisablePublicIpAddresses(boolean value)
public WorkstationConfig.Host.GceInstance.Builder setDisablePublicIpAddresses(boolean value) Optional. When set to true, disables public IP addresses for VMs. If
you disable public IP addresses, you must set up Private Google Access
or Cloud NAT on your network. If you use Private Google Access and you
use private.googleapis.com or restricted.googleapis.com for
Container Registry and Artifact Registry, make sure that you set
up DNS records for domains .gcr.io and .pkg.dev.
Defaults to false (VMs have public IP addresses).
bool disable_public_ip_addresses = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe disablePublicIpAddresses to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
setDisableSsh(boolean value)
public WorkstationConfig.Host.GceInstance.Builder setDisableSsh(boolean value)Optional. Whether to disable SSH access to the VM.
bool disable_ssh = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe disableSsh to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
setEnableNestedVirtualization(boolean value)
public WorkstationConfig.Host.GceInstance.Builder setEnableNestedVirtualization(boolean value)Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation 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 workstation 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 |
booleanThe enableNestedVirtualization to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
setMachineType(String value)
public WorkstationConfig.Host.GceInstance.Builder setMachineType(String value) Optional. The type of machine to use for VM instances—for example,
"e2-standard-4". For more information about machine types that
Cloud Workstations supports, see the list of
available machine
types.
string machine_type = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe machineType to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
setMachineTypeBytes(ByteString value)
public WorkstationConfig.Host.GceInstance.Builder setMachineTypeBytes(ByteString value) Optional. The type of machine to use for VM instances—for example,
"e2-standard-4". For more information about machine types that
Cloud Workstations supports, see the list of
available machine
types.
string machine_type = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for machineType to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
setPoolSize(int value)
public WorkstationConfig.Host.GceInstance.Builder setPoolSize(int value) Optional. The number of VMs that the system should keep idle so that
new workstations can be started quickly for new users. Defaults to 0
in the API.
int32 pool_size = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe poolSize to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
setPooledInstances(int value)
public WorkstationConfig.Host.GceInstance.Builder setPooledInstances(int value)Output only. Number of instances currently available in the pool for faster workstation startup.
int32 pooled_instances = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pooledInstances to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
setReservationAffinity(WorkstationConfig.Host.GceInstance.ReservationAffinity value)
public WorkstationConfig.Host.GceInstance.Builder setReservationAffinity(WorkstationConfig.Host.GceInstance.ReservationAffinity value)Optional. ReservationAffinity specifies a reservation that can be consumed to create 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 = 15 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WorkstationConfig.Host.GceInstance.ReservationAffinity |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
setReservationAffinity(WorkstationConfig.Host.GceInstance.ReservationAffinity.Builder builderForValue)
public WorkstationConfig.Host.GceInstance.Builder setReservationAffinity(WorkstationConfig.Host.GceInstance.ReservationAffinity.Builder builderForValue)Optional. ReservationAffinity specifies a reservation that can be consumed to create 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 = 15 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
WorkstationConfig.Host.GceInstance.ReservationAffinity.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
setServiceAccount(String value)
public WorkstationConfig.Host.GceInstance.Builder setServiceAccount(String value) Optional. The email address of the service account for Cloud
Workstations VMs created with this configuration. When specified, be
sure that the service account has logging.logEntries.create and
monitoring.timeSeries.create permissions on the project so it can
write logs out to Cloud Logging. If using a custom container image, the
service account must have Artifact Registry
Reader
permission to pull the specified image.
If you as the administrator want to be able to ssh into the
underlying VM, you need to set this value to a service account
for which you have the iam.serviceAccounts.actAs permission.
Conversely, if you don't want anyone to be able to ssh into the
underlying VM, use a service account where no one has that
permission.
If not set, VMs run with a service account provided by the Cloud Workstations service, and the image must be publicly accessible.
string service_account = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe serviceAccount to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
setServiceAccountBytes(ByteString value)
public WorkstationConfig.Host.GceInstance.Builder setServiceAccountBytes(ByteString value) Optional. The email address of the service account for Cloud
Workstations VMs created with this configuration. When specified, be
sure that the service account has logging.logEntries.create and
monitoring.timeSeries.create permissions on the project so it can
write logs out to Cloud Logging. If using a custom container image, the
service account must have Artifact Registry
Reader
permission to pull the specified image.
If you as the administrator want to be able to ssh into the
underlying VM, you need to set this value to a service account
for which you have the iam.serviceAccounts.actAs permission.
Conversely, if you don't want anyone to be able to ssh into the
underlying VM, use a service account where no one has that
permission.
If not set, VMs run with a service account provided by the Cloud Workstations service, and the image must be publicly accessible.
string service_account = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for serviceAccount to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
setServiceAccountScopes(int index, String value)
public WorkstationConfig.Host.GceInstance.Builder setServiceAccountScopes(int index, String value) Optional. Scopes to grant to the
service_account.
When specified, users of workstations under this configuration must
have iam.serviceAccounts.actAs on the service account.
repeated string service_account_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe serviceAccountScopes to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
setShieldedInstanceConfig(WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig value)
public WorkstationConfig.Host.GceInstance.Builder setShieldedInstanceConfig(WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig value)Optional. A set of Compute Engine Shielded instance options.
.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig shielded_instance_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
setShieldedInstanceConfig(WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig.Builder builderForValue)
public WorkstationConfig.Host.GceInstance.Builder setShieldedInstanceConfig(WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig.Builder builderForValue)Optional. A set of Compute Engine Shielded instance options.
.google.cloud.workstations.v1beta.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig shielded_instance_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
|
setStartupScriptUri(String value)
public WorkstationConfig.Host.GceInstance.Builder setStartupScriptUri(String value)Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have Permission to access the bucket and script file in Cloud Storage. Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version of the host VM, and it is the responsibility of the user to ensure the script stays compatible with the OS version.
string startup_script_uri = 26 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe startupScriptUri to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
setStartupScriptUriBytes(ByteString value)
public WorkstationConfig.Host.GceInstance.Builder setStartupScriptUriBytes(ByteString value)Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have Permission to access the bucket and script file in Cloud Storage. Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version of the host VM, and it is the responsibility of the user to ensure the script stays compatible with the OS version.
string startup_script_uri = 26 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for startupScriptUri to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |
setTags(int index, String value)
public WorkstationConfig.Host.GceInstance.Builder setTags(int index, String value)Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies network tags to VMs created with this configuration. These network tags enable the creation of firewall rules.
repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe tags to set. |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder |
This builder for chaining. |