public final class VirtualMachine extends GeneratedMessageV3 implements VirtualMachineOrBuilder
Carries information about a Compute Engine VM resource.
Protobuf type google.cloud.lifesciences.v2beta.VirtualMachine
Static Fields
ACCELERATORS_FIELD_NUMBER
public static final int ACCELERATORS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
BOOT_DISK_SIZE_GB_FIELD_NUMBER
public static final int BOOT_DISK_SIZE_GB_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
BOOT_IMAGE_FIELD_NUMBER
public static final int BOOT_IMAGE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int CPU_PLATFORM_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISKS_FIELD_NUMBER
public static final int DISKS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DOCKER_CACHE_IMAGES_FIELD_NUMBER
public static final int DOCKER_CACHE_IMAGES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ENABLE_STACKDRIVER_MONITORING_FIELD_NUMBER
public static final int ENABLE_STACKDRIVER_MONITORING_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MACHINE_TYPE_FIELD_NUMBER
public static final int MACHINE_TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NVIDIA_DRIVER_VERSION_FIELD_NUMBER
public static final int NVIDIA_DRIVER_VERSION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PREEMPTIBLE_FIELD_NUMBER
public static final int PREEMPTIBLE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RESERVATION_FIELD_NUMBER
public static final int RESERVATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
VOLUMES_FIELD_NUMBER
public static final int VOLUMES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static VirtualMachine getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static VirtualMachine.Builder newBuilder()
newBuilder(VirtualMachine prototype)
public static VirtualMachine.Builder newBuilder(VirtualMachine prototype)
public static VirtualMachine parseDelimitedFrom(InputStream input)
public static VirtualMachine parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static VirtualMachine parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static VirtualMachine parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static VirtualMachine parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static VirtualMachine parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static VirtualMachine parseFrom(CodedInputStream input)
public static VirtualMachine parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static VirtualMachine parseFrom(InputStream input)
public static VirtualMachine parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static VirtualMachine parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static VirtualMachine parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<VirtualMachine> parser()
Methods
containsLabels(String key)
public 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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAccelerators(int index)
public 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
|
getAcceleratorsCount()
public 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 List<Accelerator> getAcceleratorsList()
The list of accelerators to attach to the VM.
repeated .google.cloud.lifesciences.v2beta.Accelerator accelerators = 6;
getAcceleratorsOrBuilder(int index)
public 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
|
getAcceleratorsOrBuilderList()
public 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 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 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 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.
|
public 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.
|
public 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.
|
getDefaultInstanceForType()
public VirtualMachine getDefaultInstanceForType()
getDisks(int index)
public 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 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 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;
getDisksOrBuilder(int index)
public 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
|
getDisksOrBuilderList()
public 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 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 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 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 ProtocolStringList 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;
getEnableStackdriverMonitoring()
public boolean getEnableStackdriverMonitoring()
Whether Stackdriver monitoring should be enabled on the VM.
bool enable_stackdriver_monitoring = 12;
| Returns |
|---|
| Type | Description |
boolean | The enableStackdriverMonitoring.
|
getLabels()
public Map<String,String> getLabels()
getLabelsCount()
public 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 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;
getLabelsOrDefault(String key, String defaultValue)
public 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;
getLabelsOrThrow(String key)
public 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
|
getMachineType()
public 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 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 Network getNetwork()
The VM network configuration.
.google.cloud.lifesciences.v2beta.Network network = 5;
| Returns |
|---|
| Type | Description |
Network | The network.
|
getNetworkOrBuilder()
public NetworkOrBuilder getNetworkOrBuilder()
The VM network configuration.
.google.cloud.lifesciences.v2beta.Network network = 5;
getNvidiaDriverVersion() (deprecated)
public 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 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.
|
getParserForType()
public Parser<VirtualMachine> getParserForType()
Overrides
getPreemptible()
public boolean getPreemptible()
If true, allocate a preemptible VM.
bool preemptible = 2;
| Returns |
|---|
| Type | Description |
boolean | The preemptible.
|
getReservation()
public 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 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getServiceAccount()
public 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;
getServiceAccountOrBuilder()
public 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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getVolumes(int index)
public 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
|
getVolumesCount()
public 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 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;
getVolumesOrBuilder(int index)
public 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
|
getVolumesOrBuilderList()
public 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 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 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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public VirtualMachine.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected VirtualMachine.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public VirtualMachine.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
