Metadata

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

JSON representation
{
  "pipeline": {
    object (Pipeline)
  },
  "labels": {
    string: string,
    ...
  },
  "events": [
    {
      object (Event)
    }
  ],
  "createTime": string,
  "startTime": string,
  "endTime": string
}
Fields
pipeline

object (Pipeline)

The pipeline this operation represents.

labels

map (key: string, value: string)

The user-defined labels associated with this operation.

events[]

object (Event)

The list of events that have happened so far during the execution of this operation.

createTime

string (Timestamp format)

The time at which the operation was created by the API.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

startTime

string (Timestamp format)

The first time at which resources were allocated to execute the pipeline.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

The time at which execution was completed and resources were cleaned up.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

Pipeline

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

JSON representation
{
  "actions": [
    {
      object (Action)
    }
  ],
  "resources": {
    object (Resources)
  },
  "environment": {
    string: string,
    ...
  },
  "timeout": string
}
Fields
actions[]

object (Action)

The list of actions to execute, in the order they are specified.

resources

object (Resources)

The resources required for execution.

environment

map (key: string, value: string)

The environment to pass into every action. Each action can also specify additional environment variables but cannot delete an entry from this map (though they can overwrite it with a different value).

timeout

string (Duration format)

The maximum amount of time to give the pipeline to complete. This includes the time spent waiting for a worker to be allocated. If the pipeline fails to complete before the timeout, it will be cancelled and the error code will be set to DEADLINE_EXCEEDED.

If unspecified, it will default to 7 days.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

Resources

The system resources for the pipeline run.

At least one zone or region must be specified or the pipeline run will fail.

JSON representation
{
  "projectId": string,
  "regions": [
    string
  ],
  "zones": [
    string
  ],
  "virtualMachine": {
    object (VirtualMachine)
  }
}
Fields
projectId

string

The project ID to allocate resources in.

regions[]

string

The list of regions allowed for VM allocation. If set, the zones field must not be set.

zones[]

string

The list of zones allowed for VM allocation. If set, the regions field must not be set.

virtualMachine

object (VirtualMachine)

The virtual machine specification.

VirtualMachine

Carries information about a Compute Engine VM resource.

JSON representation
{
  "machineType": string,
  "preemptible": boolean,
  "labels": {
    string: string,
    ...
  },
  "disks": [
    {
      object (Disk)
    }
  ],
  "network": {
    object (Network)
  },
  "accelerators": [
    {
      object (Accelerator)
    }
  ],
  "serviceAccount": {
    object (ServiceAccount)
  },
  "bootDiskSizeGb": number,
  "cpuPlatform": string,
  "bootImage": string,
  "nvidiaDriverVersion": string,
  "enableStackdriverMonitoring": boolean
}
Fields
machineType

string

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.

preemptible

boolean

If true, allocate a preemptible VM.

labels

map (key: string, value: 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 applied at creation time to the VM. Applied on a best-effort basis to attached disk resources shortly after VM creation.

disks[]

object (Disk)

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

network

object (Network)

The VM network configuration.

accelerators[]

object (Accelerator)

The list of accelerators to attach to the VM.

serviceAccount

object (ServiceAccount)

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

bootDiskSizeGb

number

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.

cpuPlatform

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.

bootImage

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.

nvidiaDriverVersion

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.

enableStackdriverMonitoring

boolean

Whether Stackdriver monitoring should be enabled on the VM.

Network

VM networking options.

JSON representation
{
  "name": string,
  "usePrivateAddress": boolean,
  "subnetwork": string
}
Fields
name

string

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.

usePrivateAddress

boolean

If set to true, do not attach a public IP address to the VM. Note that without a public IP address, additional configuration is required to allow the VM to access Google services.

See https://cloud.google.com/vpc/docs/configure-private-google-access for more information.

subnetwork

string

If the specified network is configured for custom subnet creation, the name of the subnetwork to attach the instance to must be specified here.

The value is prefixed with regions/*/subnetworks/ unless it contains a /, in which case it is assumed to be a fully specified subnetwork resource URL.

If the * character appears in the value, it is replaced with the region that the virtual machine has been allocated in.

ServiceAccount

Carries information about a Google Cloud service account.

JSON representation
{
  "email": string,
  "scopes": [
    string
  ]
}
Fields
email

string

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

scopes[]

string

List of scopes to be enabled for this service account on the VM, in addition to the Cloud Genomics API scope.

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Genomics