Class: Google::Cloud::LifeSciences::V2beta::VirtualMachine

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/lifesciences/v2beta/workflows.rb

Overview

Carries information about a Compute Engine VM resource.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#accelerators ⇒ ::Array<::Google::Cloud::LifeSciences::V2beta::Accelerator>

Returns The list of accelerators to attach to the VM.

Returns:



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/lifesciences/v2beta/workflows.rb', line 428

class VirtualMachine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#boot_disk_size_gb ⇒ ::Integer

Returns 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:

  • (::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.



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/lifesciences/v2beta/workflows.rb', line 428

class VirtualMachine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#boot_image ⇒ ::String

Returns 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:

  • (::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.



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/lifesciences/v2beta/workflows.rb', line 428

class VirtualMachine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#cpu_platform ⇒ ::String

Returns 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:

  • (::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.



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/lifesciences/v2beta/workflows.rb', line 428

class VirtualMachine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#disks ⇒ ::Array<::Google::Cloud::LifeSciences::V2beta::Disk>

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

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

Returns:



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/lifesciences/v2beta/workflows.rb', line 428

class VirtualMachine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#docker_cache_images ⇒ ::Array<::String>

Returns 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:

  • (::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 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.



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/lifesciences/v2beta/workflows.rb', line 428

class VirtualMachine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#enable_stackdriver_monitoring ⇒ ::Boolean

Returns Whether Stackdriver monitoring should be enabled on the VM.

Returns:

  • (::Boolean) —

    Whether Stackdriver monitoring should be enabled on the VM.



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/lifesciences/v2beta/workflows.rb', line 428

class VirtualMachine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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:

  • (::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.



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/lifesciences/v2beta/workflows.rb', line 428

class VirtualMachine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#machine_type ⇒ ::String

Returns 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:

  • (::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.



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/lifesciences/v2beta/workflows.rb', line 428

class VirtualMachine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#network ⇒ ::Google::Cloud::LifeSciences::V2beta::Network

Returns The VM network configuration.

Returns:



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/lifesciences/v2beta/workflows.rb', line 428

class VirtualMachine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#nvidia_driver_version ⇒ ::String

Returns 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:

  • (::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.



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/lifesciences/v2beta/workflows.rb', line 428

class VirtualMachine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#preemptible ⇒ ::Boolean

Returns If true, allocate a preemptible VM.

Returns:

  • (::Boolean) —

    If true, allocate a preemptible VM.



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/lifesciences/v2beta/workflows.rb', line 428

class VirtualMachine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#service_account ⇒ ::Google::Cloud::LifeSciences::V2beta::ServiceAccount

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

Returns:



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/lifesciences/v2beta/workflows.rb', line 428

class VirtualMachine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#volumes ⇒ ::Array<::Google::Cloud::LifeSciences::V2beta::Volume>

Returns 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:



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/lifesciences/v2beta/workflows.rb', line 428

class VirtualMachine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end