Cloud Life Sciences v2beta API - Class VirtualMachine (2.0.0-beta05)

public sealed class VirtualMachine : IMessage<VirtualMachine>, IEquatable<VirtualMachine>, IDeepCloneable<VirtualMachine>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Life Sciences v2beta API class VirtualMachine.

Carries information about a Compute Engine VM resource.

Inheritance

object > VirtualMachine

Namespace

Google.Cloud.LifeSciences.V2Beta

Assembly

Google.Cloud.LifeSciences.V2Beta.dll

Constructors

VirtualMachine()

public VirtualMachine()

VirtualMachine(VirtualMachine)

public VirtualMachine(VirtualMachine other)
Parameter
Name Description
other VirtualMachine

Properties

Accelerators

public RepeatedField<Accelerator> Accelerators { get; }

The list of accelerators to attach to the VM.

Property Value
Type Description
RepeatedFieldAccelerator

BootDiskSizeGb

public int BootDiskSizeGb { get; set; }

The size of the boot disk, in GB. The boot disk must be large enough to accommodate all of the Docker images from each action in the pipeline at the same time. If not specified, a small but reasonable default value is used.

Property Value
Type Description
int

BootImage

public string BootImage { get; set; }

The host operating system image to use.

Currently, only Container-Optimized OS images can be used.

The default value is projects/cos-cloud/global/images/family/cos-stable, which selects the latest stable release of Container-Optimized OS.

This option is provided to allow testing against the beta release of the operating system to ensure that the new version does not interact negatively with production pipelines.

To test a pipeline against the beta release of Container-Optimized OS, use the value projects/cos-cloud/global/images/family/cos-beta.

Property Value
Type Description
string

CpuPlatform

public string CpuPlatform { get; set; }

The CPU platform to request. An instance based on a newer platform can be allocated, but never one with fewer capabilities. The value of this parameter must be a valid Compute Engine CPU platform name (such as "Intel Skylake"). This parameter is only useful for carefully optimized work loads where the CPU platform has a significant impact.

For more information about the effect of this parameter, see https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.

Property Value
Type Description
string

Disks

public RepeatedField<Disk> Disks { get; }

The list of disks to create and attach to the VM.

Specify either the volumes[] field or the disks[] field, but not both.

Property Value
Type Description
RepeatedFieldDisk

DockerCacheImages

public RepeatedField<string> DockerCacheImages { get; }

The Compute Engine Disk Images to use as a Docker cache. The disks will be mounted into the Docker folder in a way that the images present in the cache will not need to be pulled. The digests of the cached images must match those of the tags used or the latest version will still be pulled. The root directory of the ext4 image must contain image and overlay2 directories copied from the Docker directory of a VM where the desired Docker images have already been pulled. Any images pulled that are not cached will be stored on the first cache disk instead of the boot disk. Only a single image is supported.

Property Value
Type Description
RepeatedFieldstring

EnableStackdriverMonitoring

public bool EnableStackdriverMonitoring { get; set; }

Whether Stackdriver monitoring should be enabled on the VM.

Property Value
Type Description
bool

Labels

public MapField<string, string> Labels { get; }

Optional set of labels to apply to the VM and any attached disk resources. These labels must adhere to the name and value restrictions on VM labels imposed by Compute Engine.

Labels keys with the prefix 'google-' are reserved for use by Google.

Labels applied at creation time to the VM. Applied on a best-effort basis to attached disk resources shortly after VM creation.

Property Value
Type Description
MapFieldstringstring

MachineType

public string MachineType { get; set; }

Required. The machine type of the virtual machine to create. Must be the short name of a standard machine type (such as "n1-standard-1") or a custom machine type (such as "custom-1-4096", where "1" indicates the number of vCPUs and "4096" indicates the memory in MB). See Creating an instance with a custom machine type for more specifications on creating a custom machine type.

Property Value
Type Description
string

Network

public Network Network { get; set; }

The VM network configuration.

Property Value
Type Description
Network

NvidiaDriverVersion

[Obsolete]
public string NvidiaDriverVersion { get; set; }

The NVIDIA driver version to use when attaching an NVIDIA GPU accelerator. The version specified here must be compatible with the GPU libraries contained in the container being executed, and must be one of the drivers hosted in the nvidia-drivers-us-public bucket on Google Cloud Storage.

Property Value
Type Description
string

Preemptible

public bool Preemptible { get; set; }

If true, allocate a preemptible VM.

Property Value
Type Description
bool

Reservation

public string Reservation { get; set; }

If specified, the VM will only be allocated inside the matching reservation. It will fail if the VM parameters don't match the reservation.

Property Value
Type Description
string

ServiceAccount

public ServiceAccount ServiceAccount { get; set; }

The service account to install on the VM. This account does not need any permissions other than those required by the pipeline.

Property Value
Type Description
ServiceAccount

Volumes

public RepeatedField<Volume> Volumes { get; }

The list of disks and other storage to create or attach to the VM.

Specify either the volumes[] field or the disks[] field, but not both.

Property Value
Type Description
RepeatedFieldVolume