public static final class WorkstationConfig.Host.GceInstance.Builder extends GeneratedMessageV3.Builder<WorkstationConfig.Host.GceInstance.Builder> implements WorkstationConfig.Host.GceInstanceOrBuilderA runtime using a Compute Engine instance.
Protobuf type google.cloud.workstations.v1.WorkstationConfig.Host.GceInstance
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > WorkstationConfig.Host.GceInstance.BuilderImplements
WorkstationConfig.Host.GceInstanceOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllServiceAccountScopes(Iterable<String> values)
public WorkstationConfig.Host.GceInstance.Builder addAllServiceAccountScopes(Iterable<String> values) Optional. Scopes to grant to the
service_account.
Various scopes are automatically added based on feature usage. 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. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public WorkstationConfig.Host.GceInstance.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder | |
addServiceAccountScopes(String value)
public WorkstationConfig.Host.GceInstance.Builder addServiceAccountScopes(String value) Optional. Scopes to grant to the
service_account.
Various scopes are automatically added based on feature usage. 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.
Various scopes are automatically added based on feature usage. 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 | |
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.v1.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. |
clearEnableNestedVirtualization()
public WorkstationConfig.Host.GceInstance.Builder clearEnableNestedVirtualization()Optional. Whether to enable nested virtualization on Cloud Workstations VMs created under this workstation configuration.
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.
- GPUs: nested virtualization may not be enabled on workstation configurations with accelerators.
- Operating System: Because Container-Optimized OS does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an Ubuntu LTS image.
bool enable_nested_virtualization = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public WorkstationConfig.Host.GceInstance.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| 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. |
clearOneof(Descriptors.OneofDescriptor oneof)
public WorkstationConfig.Host.GceInstance.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder | |
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. |
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 logginglogEntries.create permission
on the project so it can write logs out to Cloud Logging. If using a
custom container image, the service account must have permissions 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.
Various scopes are automatically added based on feature usage. 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.v1.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig shielded_instance_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder | |
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. |
clone()
public WorkstationConfig.Host.GceInstance.Builder clone()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder | |
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.v1.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.v1.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.v1.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. |
getEnableNestedVirtualization()
public boolean getEnableNestedVirtualization()Optional. Whether to enable nested virtualization on Cloud Workstations VMs created under this workstation configuration.
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.
- GPUs: nested virtualization may not be enabled on workstation configurations with accelerators.
- Operating System: Because Container-Optimized OS does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an Ubuntu LTS image.
bool enable_nested_virtualization = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | The enableNestedVirtualization. |
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. |
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. |
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 logginglogEntries.create permission
on the project so it can write logs out to Cloud Logging. If using a
custom container image, the service account must have permissions 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 logginglogEntries.create permission
on the project so it can write logs out to Cloud Logging. If using a
custom container image, the service account must have permissions 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.
Various scopes are automatically added based on feature usage. 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.
Various scopes are automatically added based on feature usage. 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.
Various scopes are automatically added based on feature usage. 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.
Various scopes are automatically added based on feature usage. 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.v1.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.v1.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.v1.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig shielded_instance_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfigOrBuilder | |
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. |
hasConfidentialInstanceConfig()
public boolean hasConfidentialInstanceConfig()Optional. A set of Compute Engine Confidential VM instance options.
.google.cloud.workstations.v1.WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig confidential_instance_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the confidentialInstanceConfig field is set. |
hasShieldedInstanceConfig()
public boolean hasShieldedInstanceConfig()Optional. A set of Compute Engine Shielded instance options.
.google.cloud.workstations.v1.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 GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
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.v1.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 | |
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.v1.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 | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final WorkstationConfig.Host.GceInstance.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| 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.v1.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.v1.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. |
setEnableNestedVirtualization(boolean value)
public WorkstationConfig.Host.GceInstance.Builder setEnableNestedVirtualization(boolean value)Optional. Whether to enable nested virtualization on Cloud Workstations VMs created under this workstation configuration.
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.
- GPUs: nested virtualization may not be enabled on workstation configurations with accelerators.
- Operating System: Because Container-Optimized OS does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an Ubuntu LTS image.
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. |
setField(Descriptors.FieldDescriptor field, Object value)
public WorkstationConfig.Host.GceInstance.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder | |
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. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public WorkstationConfig.Host.GceInstance.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| 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 logginglogEntries.create permission
on the project so it can write logs out to Cloud Logging. If using a
custom container image, the service account must have permissions 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 logginglogEntries.create permission
on the project so it can write logs out to Cloud Logging. If using a
custom container image, the service account must have permissions 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.
Various scopes are automatically added based on feature usage. 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.v1.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.v1.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 | |
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. |
setUnknownFields(UnknownFieldSet unknownFields)
public final WorkstationConfig.Host.GceInstance.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.Host.GceInstance.Builder | |