Interface VirtualMachineOrBuilder (0.56.0) 

public interface VirtualMachineOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

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.

map<string, string> labels = 3;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAccelerators(int index)

public abstract Accelerator getAccelerators(int index)

The list of accelerators to attach to the VM.

repeated .google.cloud.lifesciences.v2beta.Accelerator accelerators = 6;

Parameter
Name Description
index int
Returns
Type Description
Accelerator

getAcceleratorsCount()

public abstract int getAcceleratorsCount()

The list of accelerators to attach to the VM.

repeated .google.cloud.lifesciences.v2beta.Accelerator accelerators = 6;

Returns
Type Description
int

getAcceleratorsList()

public abstract List<Accelerator> getAcceleratorsList()

The list of accelerators to attach to the VM.

repeated .google.cloud.lifesciences.v2beta.Accelerator accelerators = 6;

Returns
Type Description
List<Accelerator>

getAcceleratorsOrBuilder(int index)

public abstract AcceleratorOrBuilder getAcceleratorsOrBuilder(int index)

The list of accelerators to attach to the VM.

repeated .google.cloud.lifesciences.v2beta.Accelerator accelerators = 6;

Parameter
Name Description
index int
Returns
Type Description
AcceleratorOrBuilder

getAcceleratorsOrBuilderList()

public abstract List<? extends AcceleratorOrBuilder> getAcceleratorsOrBuilderList()

The list of accelerators to attach to the VM.

repeated .google.cloud.lifesciences.v2beta.Accelerator accelerators = 6;

Returns
Type Description
List<? extends com.google.cloud.lifesciences.v2beta.AcceleratorOrBuilder>

getBootDiskSizeGb()

public abstract int 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.

int32 boot_disk_size_gb = 8;

Returns
Type Description
int

The bootDiskSizeGb.

getBootImage()

public abstract String 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.

string boot_image = 10;

Returns
Type Description
String

The bootImage.

getBootImageBytes()

public abstract ByteString getBootImageBytes()

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.

string boot_image = 10;

Returns
Type Description
ByteString

The bytes for bootImage.

getCpuPlatform()

public abstract String 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.

string cpu_platform = 9;

Returns
Type Description
String

The cpuPlatform.

getCpuPlatformBytes()

public abstract ByteString getCpuPlatformBytes()

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.

string cpu_platform = 9;

Returns
Type Description
ByteString

The bytes for cpuPlatform.

getDisks(int index)

public abstract Disk getDisks(int index)

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

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

repeated .google.cloud.lifesciences.v2beta.Disk disks = 4;

Parameter
Name Description
index int
Returns
Type Description
Disk

getDisksCount()

public abstract int getDisksCount()

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

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

repeated .google.cloud.lifesciences.v2beta.Disk disks = 4;

Returns
Type Description
int

getDisksList()

public abstract List<Disk> getDisksList()

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

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

repeated .google.cloud.lifesciences.v2beta.Disk disks = 4;

Returns
Type Description
List<Disk>

getDisksOrBuilder(int index)

public abstract DiskOrBuilder getDisksOrBuilder(int index)

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

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

repeated .google.cloud.lifesciences.v2beta.Disk disks = 4;

Parameter
Name Description
index int
Returns
Type Description
DiskOrBuilder

getDisksOrBuilderList()

public abstract List<? extends DiskOrBuilder> getDisksOrBuilderList()

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

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

repeated .google.cloud.lifesciences.v2beta.Disk disks = 4;

Returns
Type Description
List<? extends com.google.cloud.lifesciences.v2beta.DiskOrBuilder>

getDockerCacheImages(int index)

public abstract String getDockerCacheImages(int index)

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.

repeated string docker_cache_images = 13;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The dockerCacheImages at the given index.

getDockerCacheImagesBytes(int index)

public abstract ByteString getDockerCacheImagesBytes(int index)

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.

repeated string docker_cache_images = 13;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the dockerCacheImages at the given index.

getDockerCacheImagesCount()

public abstract int getDockerCacheImagesCount()

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.

repeated string docker_cache_images = 13;

Returns
Type Description
int

The count of dockerCacheImages.

getDockerCacheImagesList()

public abstract List<String> getDockerCacheImagesList()

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.

repeated string docker_cache_images = 13;

Returns
Type Description
List<String>

A list containing the dockerCacheImages.

getEnableStackdriverMonitoring()

public abstract boolean getEnableStackdriverMonitoring()

Whether Stackdriver monitoring should be enabled on the VM.

bool enable_stackdriver_monitoring = 12;

Returns
Type Description
boolean

The enableStackdriverMonitoring.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

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.

map<string, string> labels = 3;

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

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.

map<string, string> labels = 3;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

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.

map<string, string> labels = 3;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

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.

map<string, string> labels = 3;

Parameter
Name Description
key String
Returns
Type Description
String

getMachineType()

public abstract String 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.

string machine_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The machineType.

getMachineTypeBytes()

public abstract ByteString getMachineTypeBytes()

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.

string machine_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for machineType.

getNetwork()

public abstract Network getNetwork()

The VM network configuration.

.google.cloud.lifesciences.v2beta.Network network = 5;

Returns
Type Description
Network

The network.

getNetworkOrBuilder()

public abstract NetworkOrBuilder getNetworkOrBuilder()

The VM network configuration.

.google.cloud.lifesciences.v2beta.Network network = 5;

Returns
Type Description
NetworkOrBuilder

getNvidiaDriverVersion() (deprecated)

public abstract String getNvidiaDriverVersion()

Deprecated. google.cloud.lifesciences.v2beta.VirtualMachine.nvidia_driver_version is deprecated. See google/cloud/lifesciences/v2beta/workflows.proto;l=411

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.

string nvidia_driver_version = 11 [deprecated = true];

Returns
Type Description
String

The nvidiaDriverVersion.

getNvidiaDriverVersionBytes() (deprecated)

public abstract ByteString getNvidiaDriverVersionBytes()

Deprecated. google.cloud.lifesciences.v2beta.VirtualMachine.nvidia_driver_version is deprecated. See google/cloud/lifesciences/v2beta/workflows.proto;l=411

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.

string nvidia_driver_version = 11 [deprecated = true];

Returns
Type Description
ByteString

The bytes for nvidiaDriverVersion.

getPreemptible()

public abstract boolean getPreemptible()

If true, allocate a preemptible VM.

bool preemptible = 2;

Returns
Type Description
boolean

The preemptible.

getReservation()

public abstract String 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.

string reservation = 15;

Returns
Type Description
String

The reservation.

getReservationBytes()

public abstract ByteString getReservationBytes()

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

string reservation = 15;

Returns
Type Description
ByteString

The bytes for reservation.

getServiceAccount()

public abstract ServiceAccount getServiceAccount()

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

.google.cloud.lifesciences.v2beta.ServiceAccount service_account = 7;

Returns
Type Description
ServiceAccount

The serviceAccount.

getServiceAccountOrBuilder()

public abstract ServiceAccountOrBuilder getServiceAccountOrBuilder()

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

.google.cloud.lifesciences.v2beta.ServiceAccount service_account = 7;

Returns
Type Description
ServiceAccountOrBuilder

getVolumes(int index)

public abstract Volume getVolumes(int index)

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.

repeated .google.cloud.lifesciences.v2beta.Volume volumes = 14;

Parameter
Name Description
index int
Returns
Type Description
Volume

getVolumesCount()

public abstract int getVolumesCount()

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.

repeated .google.cloud.lifesciences.v2beta.Volume volumes = 14;

Returns
Type Description
int

getVolumesList()

public abstract List<Volume> getVolumesList()

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.

repeated .google.cloud.lifesciences.v2beta.Volume volumes = 14;

Returns
Type Description
List<Volume>

getVolumesOrBuilder(int index)

public abstract VolumeOrBuilder getVolumesOrBuilder(int index)

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.

repeated .google.cloud.lifesciences.v2beta.Volume volumes = 14;

Parameter
Name Description
index int
Returns
Type Description
VolumeOrBuilder

getVolumesOrBuilderList()

public abstract List<? extends VolumeOrBuilder> getVolumesOrBuilderList()

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.

repeated .google.cloud.lifesciences.v2beta.Volume volumes = 14;

Returns
Type Description
List<? extends com.google.cloud.lifesciences.v2beta.VolumeOrBuilder>

hasNetwork()

public abstract boolean hasNetwork()

The VM network configuration.

.google.cloud.lifesciences.v2beta.Network network = 5;

Returns
Type Description
boolean

Whether the network field is set.

hasServiceAccount()

public abstract boolean hasServiceAccount()

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

.google.cloud.lifesciences.v2beta.ServiceAccount service_account = 7;

Returns
Type Description
boolean

Whether the serviceAccount field is set.