Namespace Google.Apis.Genomics.v1alpha2.Data
Classes
CancelOperationRequest
The request message for Operations.CancelOperation.
ComputeEngine
Describes a Compute Engine resource that is being managed by a running pipeline.
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.
ContainerStoppedEvent
An event generated when a container exits.
ControllerConfig
Stores the information that the controller will fetch from the server in order to run. Should only be used by VMs created by the Pipelines Service and not by end users.
DelayedEvent
An event generated whenever a resource limitation or transient error delays execution of a pipeline that was otherwise ready to run.
Disk
A Google Compute Engine disk resource specification.
DockerExecutor
The Docker execuctor specification.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical
example is to use it as the request or the response type of an API method. For instance: service Foo { rpc
Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty
is empty JSON
object {}
.
Event
Carries information about events that occur during pipeline execution.
FailedEvent
An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event.
ListOperationsResponse
The response message for Operations.ListOperations.
ListPipelinesResponse
The response of ListPipelines. Contains at most pageSize
pipelines. If it contains pageSize
pipelines, and
more pipelines exist, then nextPageToken
will be populated and should be used as the pageToken
argument to a
subsequent ListPipelines request.
LocalCopy
LocalCopy defines how a remote file should be copied to and from the VM.
LoggingOptions
The logging options for the pipeline run.
Operation
This resource represents a long-running operation that is the result of a network API call.
OperationEvent
An event that occurred during an Operation.
OperationMetadata
Metadata describing an Operation.
Pipeline
The pipeline object. Represents a transformation from a set of input parameters to a set of output parameters.
The transformation is defined as a docker image and command to run within that image. Each pipeline is run on a
Google Compute Engine VM. A pipeline can be created with the create
method and then later run with the run
method, or a pipeline can be defined and run all at once with the run
method.
PipelineParameter
Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at
create time, with optional defaults, and can be overridden at run time. If localCopy
is unset, then the
parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable
with the given name. A default value can be optionally specified at create time. The default can be overridden
at run time using the inputs map. If no default is given, a value must be supplied at runtime. If localCopy
is
defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker
container where the pipeline computation is run. The service account associated with the Pipeline (by default
the project's Compute Engine service account) must have access to the Google Cloud Storage paths. At run time,
the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set
otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated
data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were
provided to gsutil cp
. For example: Given the following PipelineParameter
, specified in the
inputParameters
list: {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}}
where disk
is
defined in the PipelineResources
object as: {name: "pd1", mountPoint: "/mnt/disk/"}
We create a disk
named pd1
, mount it on the host VM, and map /mnt/pd1
to /mnt/disk
in the docker container. At runtime, an
entry for input_file
would be required in the inputs map, such as: inputs["input_file"] =
"gs://my-bucket/bar.txt"
This would generate the following gsutil call: gsutil cp gs://my-bucket/bar.txt
/mnt/pd1/file.txt
The file /mnt/pd1/file.txt
maps to /mnt/disk/file.txt
in the Docker container.
Acceptable paths are: Google Cloud storage pathLocal path file file glob directory For outputs, the direction of
the copy is reversed: gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt
Acceptable paths are: Local
pathGoogle Cloud Storage path file file file directory - directory must already exist glob directory - directory
will be created if it doesn't exist One restriction due to docker limitations, is that for outputs that are
found on the boot disk, the local path cannot be a glob and must be a file.
PipelineResources
The system resources for the pipeline run.
PullStartedEvent
An event generated when the worker starts pulling an image.
PullStoppedEvent
An event generated when the worker stops pulling an image.
RepeatedString
RunPipelineArgs
The pipeline run arguments.
RunPipelineRequest
The request to run a pipeline. If pipelineId
is specified, it refers to a saved pipeline created with
CreatePipeline and set as the pipelineId
of the returned Pipeline object. If ephemeralPipeline
is specified,
that pipeline is run once with the given args and not saved. It is an error to specify both pipelineId
and
ephemeralPipeline
. pipelineArgs
must be specified.
RunPipelineResponse
The response to the RunPipeline method, returned in the operation's result field on success.
RuntimeMetadata
Runtime metadata that will be populated in the runtimeMetadata field of the Operation associated with a RunPipeline execution.
ServiceAccount
A Google Cloud Service Account.
SetOperationStatusRequest
Request to set operation status. Should only be used by VMs created by the Pipelines Service and not by end users.
Status
The Status
type defines a logical error model that is suitable for different programming environments,
including REST APIs and RPC APIs. It is used by gRPC. Each Status
message contains
three pieces of data: error code, error message, and error details. You can find out more about this error model
and how to work with it in the API Design Guide.
TimestampEvent
Stores the list of events and times they occured for major events in job execution.
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.
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).