Google Cloud Life Sciences V2beta Client - Class VirtualMachine (0.4.0)

Reference documentation and code samples for the Google Cloud Life Sciences V2beta Client class VirtualMachine.

Carries information about a Compute Engine VM resource.

Generated from protobuf message google.cloud.lifesciences.v2beta.VirtualMachine

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ machine_type string

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.

↳ preemptible bool

If true, allocate a preemptible VM.

↳ labels array|Google\Protobuf\Internal\MapField

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.

↳ disks array<Google\Cloud\LifeSciences\V2beta\Disk>

The list of disks to create and attach to the VM. Specify either the volumes[] field or the disks[] field, but not both.

↳ network Google\Cloud\LifeSciences\V2beta\Network

The VM network configuration.

↳ accelerators array<Google\Cloud\LifeSciences\V2beta\Accelerator>

The list of accelerators to attach to the VM.

↳ service_account Google\Cloud\LifeSciences\V2beta\ServiceAccount

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

↳ boot_disk_size_gb int

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.

↳ cpu_platform string

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.

↳ boot_image string

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.

↳ nvidia_driver_version string

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.

↳ enable_stackdriver_monitoring bool

Whether Stackdriver monitoring should be enabled on the VM.

↳ docker_cache_images array

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.

↳ volumes array<Google\Cloud\LifeSciences\V2beta\Volume>

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.

↳ reservation string

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

getMachineType

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.

Returns
TypeDescription
string

setMachineType

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPreemptible

If true, allocate a preemptible VM.

Returns
TypeDescription
bool

setPreemptible

If true, allocate a preemptible VM.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getLabels

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.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

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.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getDisks

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

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setDisks

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

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

Parameter
NameDescription
var array<Google\Cloud\LifeSciences\V2beta\Disk>
Returns
TypeDescription
$this

getNetwork

The VM network configuration.

Returns
TypeDescription
Google\Cloud\LifeSciences\V2beta\Network|null

hasNetwork

clearNetwork

setNetwork

The VM network configuration.

Parameter
NameDescription
var Google\Cloud\LifeSciences\V2beta\Network
Returns
TypeDescription
$this

getAccelerators

The list of accelerators to attach to the VM.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setAccelerators

The list of accelerators to attach to the VM.

Parameter
NameDescription
var array<Google\Cloud\LifeSciences\V2beta\Accelerator>
Returns
TypeDescription
$this

getServiceAccount

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

Returns
TypeDescription
Google\Cloud\LifeSciences\V2beta\ServiceAccount|null

hasServiceAccount

clearServiceAccount

setServiceAccount

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

Parameter
NameDescription
var Google\Cloud\LifeSciences\V2beta\ServiceAccount
Returns
TypeDescription
$this

getBootDiskSizeGb

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.

Returns
TypeDescription
int

setBootDiskSizeGb

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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCpuPlatform

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.

Returns
TypeDescription
string

setCpuPlatform

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getBootImage

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.

Returns
TypeDescription
string

setBootImage

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNvidiaDriverVersion

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.

Returns
TypeDescription
string

setNvidiaDriverVersion

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEnableStackdriverMonitoring

Whether Stackdriver monitoring should be enabled on the VM.

Returns
TypeDescription
bool

setEnableStackdriverMonitoring

Whether Stackdriver monitoring should be enabled on the VM.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getDockerCacheImages

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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setDockerCacheImages

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.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getVolumes

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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setVolumes

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.

Parameter
NameDescription
var array<Google\Cloud\LifeSciences\V2beta\Volume>
Returns
TypeDescription
$this

getReservation

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

Returns
TypeDescription
string

setReservation

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this