Interface WorkstationConfig.Host.GceInstanceOrBuilder (0.37.0)

public static interface WorkstationConfig.Host.GceInstanceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBootDiskSizeGb()

public abstract 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 abstract 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.

getConfidentialInstanceConfigOrBuilder()

public abstract 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`

getDisablePublicIpAddresses()

public abstract 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 abstract 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 abstract 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 abstract ByteString getMachineTypeBytes()

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

Returns
Type	Description
`ByteString`	The bytes for machineType.

getPoolSize()

public abstract 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 abstract 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 abstract 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 abstract ByteString getServiceAccountBytes()

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 abstract 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`	`int` The index of the element to return.

Returns
Type	Description
`String`	The serviceAccountScopes at the given index.

getServiceAccountScopesBytes(int index)

public abstract ByteString getServiceAccountScopesBytes(int index)

repeated string service_account_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the serviceAccountScopes at the given index.

getServiceAccountScopesCount()

public abstract int getServiceAccountScopesCount()

repeated string service_account_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The count of serviceAccountScopes.

getServiceAccountScopesList()

public abstract List<String> getServiceAccountScopesList()

repeated string service_account_scopes = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<String>`	A list containing the serviceAccountScopes.

getShieldedInstanceConfig()

public abstract 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.

getShieldedInstanceConfigOrBuilder()

public abstract 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 abstract 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`	`int` The index of the element to return.

Returns
Type	Description
`String`	The tags at the given index.

getTagsBytes(int index)

public abstract ByteString getTagsBytes(int index)

repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the tags at the given index.

getTagsCount()

public abstract int getTagsCount()

repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The count of tags.

getTagsList()

public abstract List<String> getTagsList()

repeated string tags = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<String>`	A list containing the tags.

hasConfidentialInstanceConfig()

public abstract 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 abstract 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.