Package com.google.cloud.lifesciences.v2beta

Interface VirtualMachineOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    VirtualMachine, VirtualMachine.Builder
    public interface VirtualMachineOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getMachineType

        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](https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type#create)
 for more specifications on creating a custom machine type.
        string machine_type = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The machineType.

      • getMachineTypeBytes

        com.google.protobuf.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](https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type#create)
 for more specifications on creating a custom machine type.
        string machine_type = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for machineType.

      • getPreemptible

        boolean getPreemptible()
         If true, allocate a preemptible VM.
        bool preemptible = 2;
        Returns:
        The preemptible.

      • getLabelsCount

        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](https://cloud.google.com/compute/docs/labeling-resources) 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;

      • containsLabels

        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](https://cloud.google.com/compute/docs/labeling-resources) 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;

      • getLabelsMap

        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](https://cloud.google.com/compute/docs/labeling-resources) 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 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](https://cloud.google.com/compute/docs/labeling-resources) 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 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](https://cloud.google.com/compute/docs/labeling-resources) 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;

      • getDisksList

        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;

      • getDisks

        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;

      • getDisksCount

        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;

      • getDisksOrBuilderList

        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;

      • getDisksOrBuilder

        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;

      • hasNetwork

        boolean hasNetwork()
         The VM network configuration.
        .google.cloud.lifesciences.v2beta.Network network = 5;
        Returns:
        Whether the network field is set.

      • getNetwork

        Network getNetwork()
         The VM network configuration.
        .google.cloud.lifesciences.v2beta.Network network = 5;
        Returns:
        The network.

      • getNetworkOrBuilder

        NetworkOrBuilder getNetworkOrBuilder()
         The VM network configuration.
        .google.cloud.lifesciences.v2beta.Network network = 5;

      • getAcceleratorsList

        List<Accelerator> getAcceleratorsList()
         The list of accelerators to attach to the VM.
        repeated .google.cloud.lifesciences.v2beta.Accelerator accelerators = 6;

      • getAccelerators

        Accelerator getAccelerators​(int index)
         The list of accelerators to attach to the VM.
        repeated .google.cloud.lifesciences.v2beta.Accelerator accelerators = 6;

      • getAcceleratorsCount

        int getAcceleratorsCount()
         The list of accelerators to attach to the VM.
        repeated .google.cloud.lifesciences.v2beta.Accelerator accelerators = 6;

      • getAcceleratorsOrBuilderList

        List<? extends AcceleratorOrBuilder> getAcceleratorsOrBuilderList()
         The list of accelerators to attach to the VM.
        repeated .google.cloud.lifesciences.v2beta.Accelerator accelerators = 6;

      • getAcceleratorsOrBuilder

        AcceleratorOrBuilder getAcceleratorsOrBuilder​(int index)
         The list of accelerators to attach to the VM.
        repeated .google.cloud.lifesciences.v2beta.Accelerator accelerators = 6;

      • hasServiceAccount

        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:
        Whether the serviceAccount field is set.

      • getServiceAccount

        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:
        The serviceAccount.

      • getServiceAccountOrBuilder

        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;

      • getBootDiskSizeGb

        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:
        The bootDiskSizeGb.

      • getCpuPlatform

        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:
        The cpuPlatform.

      • getCpuPlatformBytes

        com.google.protobuf.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:
        The bytes for cpuPlatform.

      • getBootImage

        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:
        The bootImage.

      • getBootImageBytes

        com.google.protobuf.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:
        The bytes for bootImage.

      • getNvidiaDriverVersion

        @Deprecated
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:
        The nvidiaDriverVersion.

      • getNvidiaDriverVersionBytes

        @Deprecated
com.google.protobuf.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:
        The bytes for nvidiaDriverVersion.

      • getEnableStackdriverMonitoring

        boolean getEnableStackdriverMonitoring()
         Whether Stackdriver monitoring should be enabled on the VM.
        bool enable_stackdriver_monitoring = 12;
        Returns:
        The enableStackdriverMonitoring.

      • getDockerCacheImagesList

        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:
        A list containing the dockerCacheImages.

      • getDockerCacheImagesCount

        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:
        The count of dockerCacheImages.

      • getDockerCacheImages

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The dockerCacheImages at the given index.

      • getDockerCacheImagesBytes

        com.google.protobuf.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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the dockerCacheImages at the given index.

      • getVolumesList

        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;

      • getVolumes

        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;

      • getVolumesCount

        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;

      • getVolumesOrBuilderList

        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;

      • getVolumesOrBuilder

        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;

      • getReservation

        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:
        The reservation.

      • getReservationBytes

        com.google.protobuf.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:
        The bytes for reservation.