Cloud Workstations V1BETA API - Class Google::Cloud::Workstations::V1beta::WorkstationConfig::Host::GceInstance (v0.1.2)

Reference documentation and code samples for the Cloud Workstations V1BETA API class Google::Cloud::Workstations::V1beta::WorkstationConfig::Host::GceInstance.

A runtime using a Compute Engine instance.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#accelerators

def accelerators() -> ::Array<::Google::Cloud::Workstations::V1beta::WorkstationConfig::Host::GceInstance::Accelerator>
Returns

#accelerators=

def accelerators=(value) -> ::Array<::Google::Cloud::Workstations::V1beta::WorkstationConfig::Host::GceInstance::Accelerator>
Parameter
Returns

#boot_disk_size_gb

def boot_disk_size_gb() -> ::Integer
Returns
  • (::Integer) — 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.

#boot_disk_size_gb=

def boot_disk_size_gb=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#confidential_instance_config

def confidential_instance_config() -> ::Google::Cloud::Workstations::V1beta::WorkstationConfig::Host::GceInstance::GceConfidentialInstanceConfig
Returns

#confidential_instance_config=

def confidential_instance_config=(value) -> ::Google::Cloud::Workstations::V1beta::WorkstationConfig::Host::GceInstance::GceConfidentialInstanceConfig
Parameter
Returns

#disable_public_ip_addresses

def disable_public_ip_addresses() -> ::Boolean
Returns
  • (::Boolean) — 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).

#disable_public_ip_addresses=

def disable_public_ip_addresses=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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).
Returns
  • (::Boolean) — 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).

#enable_nested_virtualization

def enable_nested_virtualization() -> ::Boolean
Returns
  • (::Boolean) —

    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.

#enable_nested_virtualization=

def enable_nested_virtualization=(value) -> ::Boolean
Parameter
  • value (::Boolean) —

    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.
Returns
  • (::Boolean) —

    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.

#machine_type

def machine_type() -> ::String
Returns
  • (::String) — 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.

#machine_type=

def machine_type=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#pool_size

def pool_size() -> ::Integer
Returns
  • (::Integer) — 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.

#pool_size=

def pool_size=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#pooled_instances

def pooled_instances() -> ::Integer
Returns
  • (::Integer) — Output only. Number of instances currently available in the pool for faster workstation startup.

#service_account

def service_account() -> ::String
Returns
  • (::String) — 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.

#service_account=

def service_account=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#service_account_scopes

def service_account_scopes() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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.

#service_account_scopes=

def service_account_scopes=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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.
Returns
  • (::Array<::String>) — 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.

#shielded_instance_config

def shielded_instance_config() -> ::Google::Cloud::Workstations::V1beta::WorkstationConfig::Host::GceInstance::GceShieldedInstanceConfig
Returns

#shielded_instance_config=

def shielded_instance_config=(value) -> ::Google::Cloud::Workstations::V1beta::WorkstationConfig::Host::GceInstance::GceShieldedInstanceConfig
Parameter
Returns

#tags

def tags() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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.

#tags=

def tags=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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.
Returns
  • (::Array<::String>) — 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.