Class ProjectsResource.LocationsResource.PipelinesResource

The "pipelines" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.PipelinesResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

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
IClientService	service

Properties

Jobs

Gets the Jobs resource.

Declaration

public virtual ProjectsResource.LocationsResource.PipelinesResource.JobsResource Jobs { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.PipelinesResource.JobsResource

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
GoogleCloudDatapipelinesV1Pipeline	body	The body of the request.
string	parent	Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.

Returns

Type	Description
ProjectsResource.LocationsResource.PipelinesResource.CreateRequest

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: projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID.

Returns

Type	Description
ProjectsResource.LocationsResource.PipelinesResource.DeleteRequest

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: projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID.

Returns

Type	Description
ProjectsResource.LocationsResource.PipelinesResource.GetRequest

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: projects/PROJECT_ID/locations/LOCATION_ID.

Returns

Type	Description
ProjectsResource.LocationsResource.PipelinesResource.ListRequest

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
GoogleCloudDatapipelinesV1Pipeline	body	The body of the request.
string	name	The pipeline name. For example: projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID. * PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and periods (.). For more information, see Identifying projects. LOCATION_ID is the canonical ID for the pipeline's location. The list of available locations can be obtained by calling google.cloud.location.Locations.ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in App Engine regions. * PIPELINE_ID is the ID of the pipeline. Must be unique for the selected project and location.

Returns

Type	Description
ProjectsResource.LocationsResource.PipelinesResource.PatchRequest

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
GoogleCloudDatapipelinesV1RunPipelineRequest	body	The body of the request.
string	name	Required. The pipeline name. For example: projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID.

Returns

Type	Description
ProjectsResource.LocationsResource.PipelinesResource.RunRequest

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
GoogleCloudDatapipelinesV1StopPipelineRequest	body	The body of the request.
string	name	Required. The pipeline name. For example: projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID.

Returns

Type	Description
ProjectsResource.LocationsResource.PipelinesResource.StopRequest