Class ProjectsResource.LocationsResource.PipelinesResource
The "pipelines" collection of methods.
Inherited Members
Namespace: Google.Apis.Datapipelines.v1
Assembly: Google.Apis.Datapipelines.v1.dll
Syntax
public class ProjectsResource.LocationsResource.PipelinesResource
Constructors
PipelinesResource(IClientService)
Constructs a new resource.
Declaration
public PipelinesResource(IClientService service)
Parameters
Type | Name | Description |
---|---|---|
IClient |
service |
Properties
Jobs
Gets the Jobs resource.
Declaration
public virtual ProjectsResource.LocationsResource.PipelinesResource.JobsResource Jobs { get; }
Property Value
Type | Description |
---|---|
Projects |
Methods
Create(GoogleCloudDatapipelinesV1Pipeline, string)
Creates a pipeline. For a batch pipeline, you can pass scheduler information. Data Pipelines uses the scheduler information to create an internal scheduler that runs jobs periodically. If the internal scheduler is not configured, you can use RunPipeline to run jobs.
Declaration
public virtual ProjectsResource.LocationsResource.PipelinesResource.CreateRequest Create(GoogleCloudDatapipelinesV1Pipeline body, string parent)
Parameters
Type | Name | Description |
---|---|---|
Google |
body | The body of the request. |
string | parent | Required. The location name. For example: |
Returns
Type | Description |
---|---|
Projects |
Delete(string)
Deletes a pipeline. If a scheduler job is attached to the pipeline, it will be deleted.
Declaration
public virtual ProjectsResource.LocationsResource.PipelinesResource.DeleteRequest Delete(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The pipeline name. For example:
|
Returns
Type | Description |
---|---|
Projects |
Get(string)
Looks up a single pipeline. Returns a "NOT_FOUND" error if no such pipeline exists. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it.
Declaration
public virtual ProjectsResource.LocationsResource.PipelinesResource.GetRequest Get(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The pipeline name. For example:
|
Returns
Type | Description |
---|---|
Projects |
List(string)
Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it.
Declaration
public virtual ProjectsResource.LocationsResource.PipelinesResource.ListRequest List(string parent)
Parameters
Type | Name | Description |
---|---|---|
string | parent | Required. The location name. For example: |
Returns
Type | Description |
---|---|
Projects |
Patch(GoogleCloudDatapipelinesV1Pipeline, string)
Updates a pipeline. If successful, the updated Pipeline is returned. Returns NOT_FOUND
if the
pipeline doesn't exist. If UpdatePipeline does not return successfully, you can retry the
UpdatePipeline request until you receive a successful response.
Declaration
public virtual ProjectsResource.LocationsResource.PipelinesResource.PatchRequest Patch(GoogleCloudDatapipelinesV1Pipeline body, string name)
Parameters
Type | Name | Description |
---|---|---|
Google |
body | The body of the request. |
string | name | The pipeline name. For example:
|
Returns
Type | Description |
---|---|
Projects |
Run(GoogleCloudDatapipelinesV1RunPipelineRequest, string)
Creates a job for the specified pipeline directly. You can use this method when the internal scheduler is not configured and you want to trigger the job directly or through an external system. Returns a "NOT_FOUND" error if the pipeline doesn't exist. Returns a "FORBIDDEN" error if the user doesn't have permission to access the pipeline or run jobs for the pipeline.
Declaration
public virtual ProjectsResource.LocationsResource.PipelinesResource.RunRequest Run(GoogleCloudDatapipelinesV1RunPipelineRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
Google |
body | The body of the request. |
string | name | Required. The pipeline name. For example:
|
Returns
Type | Description |
---|---|
Projects |
Stop(GoogleCloudDatapipelinesV1StopPipelineRequest, string)
Freezes pipeline execution permanently. If there's a corresponding scheduler entry, it's deleted, and the pipeline state is changed to "ARCHIVED". However, pipeline metadata is retained.
Declaration
public virtual ProjectsResource.LocationsResource.PipelinesResource.StopRequest Stop(GoogleCloudDatapipelinesV1StopPipelineRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
Google |
body | The body of the request. |
string | name | Required. The pipeline name. For example:
|
Returns
Type | Description |
---|---|
Projects |