Class WorkstationConfig.Host.GceInstance (0.40.0) 

public static final class WorkstationConfig.Host.GceInstance extends GeneratedMessageV3 implements WorkstationConfig.Host.GceInstanceOrBuilder

A runtime using a Compute Engine instance.

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

Inheritance

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

Static Fields

ACCELERATORS_FIELD_NUMBER

public static final int ACCELERATORS_FIELD_NUMBER
Field Value
Type Description
int

BOOT_DISK_SIZE_GB_FIELD_NUMBER

public static final int BOOT_DISK_SIZE_GB_FIELD_NUMBER
Field Value
Type Description
int

CONFIDENTIAL_INSTANCE_CONFIG_FIELD_NUMBER

public static final int CONFIDENTIAL_INSTANCE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

DISABLE_PUBLIC_IP_ADDRESSES_FIELD_NUMBER

public static final int DISABLE_PUBLIC_IP_ADDRESSES_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_NESTED_VIRTUALIZATION_FIELD_NUMBER

public static final int ENABLE_NESTED_VIRTUALIZATION_FIELD_NUMBER
Field Value
Type Description
int

MACHINE_TYPE_FIELD_NUMBER

public static final int MACHINE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

POOLED_INSTANCES_FIELD_NUMBER

public static final int POOLED_INSTANCES_FIELD_NUMBER
Field Value
Type Description
int

POOL_SIZE_FIELD_NUMBER

public static final int POOL_SIZE_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_SCOPES_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_SCOPES_FIELD_NUMBER
Field Value
Type Description
int

SHIELDED_INSTANCE_CONFIG_FIELD_NUMBER

public static final int SHIELDED_INSTANCE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(WorkstationConfig.Host.GceInstance prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAccelerators(int index)

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

Optional. A list of the type and count of accelerator cards attached to the 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

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>

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.

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

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.

getParserForType()

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

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 int

The 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 int

The 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.v1beta.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig shielded_instance_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig

The shieldedInstanceConfig.

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

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 int

The 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 int

The 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.v1beta.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.v1beta.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig shielded_instance_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the shieldedInstanceConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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