Interface WorkstationConfig.Host.GceInstanceOrBuilder (0.81.0)

Optional. Custom metadata to apply to Compute Engine instances.

map<string, string> instance_metadata = 27 [(.google.api.field_behavior) = OPTIONAL];

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];

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];

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];

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];

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];

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];

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];

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];

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];

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];

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];

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];

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];

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];

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];

Optional. Whether to disable SSH access to the VM.

bool disable_ssh = 13 [(.google.api.field_behavior) = OPTIONAL];

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];

Use #getInstanceMetadataMap() instead.

Optional. Custom metadata to apply to Compute Engine instances.

map<string, string> instance_metadata = 27 [(.google.api.field_behavior) = OPTIONAL];

Optional. Custom metadata to apply to Compute Engine instances.

map<string, string> instance_metadata = 27 [(.google.api.field_behavior) = OPTIONAL];

Optional. Custom metadata to apply to Compute Engine instances.

map<string, string> instance_metadata = 27 [(.google.api.field_behavior) = OPTIONAL];

Optional. Custom metadata to apply to Compute Engine instances.

map<string, string> instance_metadata = 27 [(.google.api.field_behavior) = OPTIONAL];

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];

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];

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];

Output only. Number of instances currently available in the pool for faster workstation startup.

int32 pooled_instances = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

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];

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];

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];

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];

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];

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];

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];

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];

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];

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];

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];

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];

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];

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];

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];

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];

Use #getVmTagsMap() instead.

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];

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];

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];

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];

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];

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];

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];