Class PipelinesResource
The "pipelines" collection of methods.
Inheritance
Inherited Members
Namespace: Google.Apis.Genomics.v1alpha2
Assembly: Google.Apis.Genomics.v1alpha2.dll
Syntax
public class PipelinesResource
Constructors
PipelinesResource(IClientService)
Constructs a new resource.
Declaration
public PipelinesResource(IClientService service)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service |
Methods
Create(Pipeline)
Creates a pipeline that can be run later. Create takes a Pipeline that has all fields other than
pipelineId
populated, and then returns the same pipeline with pipelineId
populated. This id can be used
to run the pipeline. Caller must have WRITE permission to the project.
Declaration
public virtual PipelinesResource.CreateRequest Create(Pipeline body)
Parameters
Type | Name | Description |
---|---|---|
Pipeline | body | The body of the request. |
Returns
Type | Description |
---|---|
PipelinesResource.CreateRequest |
Delete(String)
Deletes a pipeline based on ID. Caller must have WRITE permission to the project.
Declaration
public virtual PipelinesResource.DeleteRequest Delete(string pipelineId)
Parameters
Type | Name | Description |
---|---|---|
System.String | pipelineId | Caller must have WRITE access to the project in which this pipeline is defined. |
Returns
Type | Description |
---|---|
PipelinesResource.DeleteRequest |
Get(String)
Retrieves a pipeline based on ID. Caller must have READ permission to the project.
Declaration
public virtual PipelinesResource.GetRequest Get(string pipelineId)
Parameters
Type | Name | Description |
---|---|---|
System.String | pipelineId | Caller must have READ access to the project in which this pipeline is defined. |
Returns
Type | Description |
---|---|
PipelinesResource.GetRequest |
GetControllerConfig()
Gets controller configuration information. Should only be called by VMs created by the Pipelines Service and not by end users.
Declaration
public virtual PipelinesResource.GetControllerConfigRequest GetControllerConfig()
Returns
Type | Description |
---|---|
PipelinesResource.GetControllerConfigRequest |
List()
Lists pipelines. Caller must have READ permission to the project.
Declaration
public virtual PipelinesResource.ListRequest List()
Returns
Type | Description |
---|---|
PipelinesResource.ListRequest |
Run(RunPipelineRequest)
Runs a pipeline. If pipelineId
is specified in the request, then run a saved pipeline. If
ephemeralPipeline
is specified, then run that pipeline once without saving a copy. The caller must have
READ permission to the project where the pipeline is stored and WRITE permission to the project where the
pipeline will be run, as VMs will be created and storage will be used. If a pipeline operation is still
running after 6 days, it will be canceled.
Declaration
public virtual PipelinesResource.RunRequest Run(RunPipelineRequest body)
Parameters
Type | Name | Description |
---|---|---|
RunPipelineRequest | body | The body of the request. |
Returns
Type | Description |
---|---|
PipelinesResource.RunRequest |
SetOperationStatus(SetOperationStatusRequest)
Sets status of a given operation. Any new timestamps (as determined by description) are appended to TimestampEvents. Should only be called by VMs created by the Pipelines Service and not by end users.
Declaration
public virtual PipelinesResource.SetOperationStatusRequest SetOperationStatus(SetOperationStatusRequest body)
Parameters
Type | Name | Description |
---|---|---|
SetOperationStatusRequest | body | The body of the request. |
Returns
Type | Description |
---|---|
PipelinesResource.SetOperationStatusRequest |