Show / Hide Table of Contents

Class GceInstance

A runtime using a Compute Engine instance.

Inheritance
object
GceInstance
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudWorkstations.v1beta.Data
Assembly: Google.Apis.CloudWorkstations.v1beta.dll
Syntax
public class GceInstance : IDirectResponseSchema

Properties

Accelerators

Optional. A list of the type and count of accelerator cards attached to the instance.

Declaration
[JsonProperty("accelerators")]
public virtual IList<Accelerator> Accelerators { get; set; }
Property Value
Type Description
IList<Accelerator>

BoostConfigs

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.

Declaration
[JsonProperty("boostConfigs")]
public virtual IList<BoostConfig> BoostConfigs { get; set; }
Property Value
Type Description
IList<BoostConfig>

BootDiskSizeGb

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.

Declaration
[JsonProperty("bootDiskSizeGb")]
public virtual int? BootDiskSizeGb { get; set; }
Property Value
Type Description
int?

ConfidentialInstanceConfig

Optional. A set of Compute Engine Confidential VM instance options.

Declaration
[JsonProperty("confidentialInstanceConfig")]
public virtual GceConfidentialInstanceConfig ConfidentialInstanceConfig { get; set; }
Property Value
Type Description
GceConfidentialInstanceConfig

DisablePublicIpAddresses

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).

Declaration
[JsonProperty("disablePublicIpAddresses")]
public virtual bool? DisablePublicIpAddresses { get; set; }
Property Value
Type Description
bool?

DisableSsh

Optional. Whether to disable SSH access to the VM.

Declaration
[JsonProperty("disableSsh")]
public virtual bool? DisableSsh { get; set; }
Property Value
Type Description
bool?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EnableNestedVirtualization

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.
Declaration
[JsonProperty("enableNestedVirtualization")]
public virtual bool? EnableNestedVirtualization { get; set; }
Property Value
Type Description
bool?

MachineType

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.

Declaration
[JsonProperty("machineType")]
public virtual string MachineType { get; set; }
Property Value
Type Description
string

PoolSize

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.

Declaration
[JsonProperty("poolSize")]
public virtual int? PoolSize { get; set; }
Property Value
Type Description
int?

PooledInstances

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

Declaration
[JsonProperty("pooledInstances")]
public virtual int? PooledInstances { get; set; }
Property Value
Type Description
int?

ServiceAccount

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.

Declaration
[JsonProperty("serviceAccount")]
public virtual string ServiceAccount { get; set; }
Property Value
Type Description
string

ServiceAccountScopes

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.

Declaration
[JsonProperty("serviceAccountScopes")]
public virtual IList<string> ServiceAccountScopes { get; set; }
Property Value
Type Description
IList<string>

ShieldedInstanceConfig

Optional. A set of Compute Engine Shielded instance options.

Declaration
[JsonProperty("shieldedInstanceConfig")]
public virtual GceShieldedInstanceConfig ShieldedInstanceConfig { get; set; }
Property Value
Type Description
GceShieldedInstanceConfig

Tags

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.

Declaration
[JsonProperty("tags")]
public virtual IList<string> Tags { get; set; }
Property Value
Type Description
IList<string>

VmTags

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.

Declaration
[JsonProperty("vmTags")]
public virtual IDictionary<string, string> VmTags { get; set; }
Property Value
Type Description
IDictionary<string, string>

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX