Package types (0.2.3)

API documentation for lifesciences_v2beta.types package.

Classes

Accelerator

Carries information about an accelerator that can be attached to a VM.

Action

Specifies a single action that runs a Docker container. .. attribute:: container_name

An optional name for the container. The container hostname will be set to this name, making it useful for inter-container communication. The name must contain only upper and lowercase alphanumeric characters and hyphens and cannot start with a hyphen.

:type: str

ContainerKilledEvent

An event generated when a container is forcibly terminated by the worker. Currently, this only occurs when the container outlives the timeout specified by the user.

ContainerStartedEvent

An event generated when a container starts. .. attribute:: action_id

The numeric ID of the action that started this container.

:type: int

ContainerStoppedEvent

An event generated when a container exits. .. attribute:: action_id

The numeric ID of the action that started this container.

:type: int

DelayedEvent

An event generated whenever a resource limitation or transient error delays execution of a pipeline that was otherwise ready to run.

Disk

Carries information about a disk that can be attached to a VM.

See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations.

Specify either [Volume][google.cloud.lifesciences.v2beta.Volume] or [Disk][google.cloud.lifesciences.v2beta.Disk], but not both.

Event

Carries information about events that occur during pipeline execution.

ExistingDisk

Configuration for an existing disk to be attached to the VM. .. attribute:: disk

If disk contains slashes, the Cloud Life Sciences API assumes that it is a complete URL for the disk. If disk does not contain slashes, the Cloud Life Sciences API assumes that the disk is a zonal disk and a URL will be generated of the form zones/<zone>/disks/<disk>, where <zone> is the zone in which the instance is allocated. The disk must be ext4 formatted.

If all Mount references to this disk have the read_only flag set to true, the disk will be attached in read-only mode and can be shared with other instances. Otherwise, the disk will be available for writing but cannot be shared.

:type: str

FailedEvent

An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event.

Metadata

Carries information about the pipeline execution that is returned in the long running operation's metadata field.

Mount

Carries information about a particular disk mount inside a container.

NFSMount

Configuration for an NFSMount to be attached to the VM. .. attribute:: target

A target NFS mount. The target must be specified as `address:/mount".

:type: str

Network

VM networking options. .. attribute:: network

The network name to attach the VM's network interface to. The value will be prefixed with global/networks/ unless it contains a /, in which case it is assumed to be a fully specified network resource URL.

If unspecified, the global default network is used.

:type: str

PersistentDisk

Configuration for a persistent disk to be attached to the VM. See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations.

Pipeline

Specifies a series of actions to execute, expressed as Docker containers.

PullStartedEvent

An event generated when the worker starts pulling an image. .. attribute:: image_uri

The URI of the image that was pulled.

:type: str

PullStoppedEvent

An event generated when the worker stops pulling an image. .. attribute:: image_uri

The URI of the image that was pulled.

:type: str

Resources

The system resources for the pipeline run. At least one zone or region must be specified or the pipeline run will fail.

RunPipelineRequest

The arguments to the RunPipeline method. The requesting user must have the iam.serviceAccounts.actAs permission for the Cloud Life Sciences service account or the request will fail.

RunPipelineResponse

The response to the RunPipeline method, returned in the operation's result field on success.

Secret

Holds encrypted information that is only decrypted and stored in RAM by the worker VM when running the pipeline.

ServiceAccount

Carries information about a Google Cloud service account. .. attribute:: email

Email address of the service account. If not specified, the default Compute Engine service account for the project will be used.

:type: str

UnexpectedExitStatusEvent

An event generated when the execution of a container results in a non-zero exit status that was not otherwise ignored. Execution will continue, but only actions that are flagged as ALWAYS_RUN will be executed. Other actions will be skipped.

VirtualMachine

Carries information about a Compute Engine VM resource. .. attribute:: machine_type

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.

:type: str

Volume

Carries information about storage that can be attached to a VM.

Specify either [Volume][google.cloud.lifesciences.v2beta.Volume] or [Disk][google.cloud.lifesciences.v2beta.Disk], but not both.

WorkerAssignedEvent

An event generated after a worker VM has been assigned to run the pipeline.

WorkerReleasedEvent

An event generated when the worker VM that was assigned to the pipeline has been released (deleted).