Reference documentation and code samples for the Cloud Life Sciences V2beta API class Google::Cloud::LifeSciences::V2beta::VirtualMachine.
Carries information about a Compute Engine VM resource.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#accelerators
def accelerators() -> ::Array<::Google::Cloud::LifeSciences::V2beta::Accelerator>
- (::Array<::Google::Cloud::LifeSciences::V2beta::Accelerator>) — The list of accelerators to attach to the VM.
#accelerators=
def accelerators=(value) -> ::Array<::Google::Cloud::LifeSciences::V2beta::Accelerator>
- value (::Array<::Google::Cloud::LifeSciences::V2beta::Accelerator>) — The list of accelerators to attach to the VM.
- (::Array<::Google::Cloud::LifeSciences::V2beta::Accelerator>) — The list of accelerators to attach to the VM.
#boot_disk_size_gb
def boot_disk_size_gb() -> ::Integer
- (::Integer) — 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.
#boot_disk_size_gb=
def boot_disk_size_gb=(value) -> ::Integer
- value (::Integer) — 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.
- (::Integer) — 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.
#boot_image
def boot_image() -> ::String
-
(::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
.
#boot_image=
def boot_image=(value) -> ::String
-
value (::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
.
-
(::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
.
#cpu_platform
def cpu_platform() -> ::String
-
(::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.
#cpu_platform=
def cpu_platform=(value) -> ::String
-
value (::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.
-
(::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.
#disks
def disks() -> ::Array<::Google::Cloud::LifeSciences::V2beta::Disk>
-
(::Array<::Google::Cloud::LifeSciences::V2beta::Disk>) — The list of disks to create and attach to the VM.
Specify either the
volumes[]
field or thedisks[]
field, but not both.
#disks=
def disks=(value) -> ::Array<::Google::Cloud::LifeSciences::V2beta::Disk>
-
value (::Array<::Google::Cloud::LifeSciences::V2beta::Disk>) — The list of disks to create and attach to the VM.
Specify either the
volumes[]
field or thedisks[]
field, but not both.
-
(::Array<::Google::Cloud::LifeSciences::V2beta::Disk>) — The list of disks to create and attach to the VM.
Specify either the
volumes[]
field or thedisks[]
field, but not both.
#docker_cache_images
def docker_cache_images() -> ::Array<::String>
-
(::Array<::String>) — 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
andoverlay2
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.
#docker_cache_images=
def docker_cache_images=(value) -> ::Array<::String>
-
value (::Array<::String>) — 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
andoverlay2
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.
-
(::Array<::String>) — 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
andoverlay2
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.
#enable_stackdriver_monitoring
def enable_stackdriver_monitoring() -> ::Boolean
- (::Boolean) — Whether Stackdriver monitoring should be enabled on the VM.
#enable_stackdriver_monitoring=
def enable_stackdriver_monitoring=(value) -> ::Boolean
- value (::Boolean) — Whether Stackdriver monitoring should be enabled on the VM.
- (::Boolean) — Whether Stackdriver monitoring should be enabled on the VM.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
-
(::Google::Protobuf::Map{::String => ::String}) — 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.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::Map{::String => ::String}) — 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.
-
(::Google::Protobuf::Map{::String => ::String}) — 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.
#machine_type
def machine_type() -> ::String
- (::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.
#machine_type=
def machine_type=(value) -> ::String
- value (::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.
- (::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.
#network
def network() -> ::Google::Cloud::LifeSciences::V2beta::Network
- (::Google::Cloud::LifeSciences::V2beta::Network) — The VM network configuration.
#network=
def network=(value) -> ::Google::Cloud::LifeSciences::V2beta::Network
- value (::Google::Cloud::LifeSciences::V2beta::Network) — The VM network configuration.
- (::Google::Cloud::LifeSciences::V2beta::Network) — The VM network configuration.
#nvidia_driver_version
def nvidia_driver_version() -> ::String
-
(::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.
#nvidia_driver_version=
def nvidia_driver_version=(value) -> ::String
-
value (::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.
-
(::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.
#preemptible
def preemptible() -> ::Boolean
- (::Boolean) — If true, allocate a preemptible VM.
#preemptible=
def preemptible=(value) -> ::Boolean
- value (::Boolean) — If true, allocate a preemptible VM.
- (::Boolean) — If true, allocate a preemptible VM.
#reservation
def reservation() -> ::String
- (::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.
#reservation=
def reservation=(value) -> ::String
- value (::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.
- (::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.
#service_account
def service_account() -> ::Google::Cloud::LifeSciences::V2beta::ServiceAccount
- (::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.
#service_account=
def service_account=(value) -> ::Google::Cloud::LifeSciences::V2beta::ServiceAccount
- value (::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.
- (::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.
#volumes
def volumes() -> ::Array<::Google::Cloud::LifeSciences::V2beta::Volume>
-
(::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 thedisks[]
field, but not both.
#volumes=
def volumes=(value) -> ::Array<::Google::Cloud::LifeSciences::V2beta::Volume>
-
value (::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 thedisks[]
field, but not both.
-
(::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 thedisks[]
field, but not both.