ProjectsLocationsPipelines
class ProjectsLocationsPipelines extends Resource (View source)
The "pipelines" collection of methods.
Typical usage is:
$datapipelinesService = new Google\Service\Datapipelines(...);
$pipelines = $datapipelinesService->projects_locations_pipelines;Methods
Creates a pipeline. For a batch pipeline, you can pass scheduler information.
Deletes a pipeline. If a scheduler job is attached to the pipeline, it will be deleted. (pipelines.delete)
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. (pipelines.get)
Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it. (pipelines.listProjectsLocationsPipelines)
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. (pipelines.patch)
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.
Freezes pipeline execution permanently. If there's a corresponding scheduler entry, it's deleted, and the pipeline state is changed to "ARCHIVED".
Details
GoogleCloudDatapipelinesV1Pipeline
create(string $parent, GoogleCloudDatapipelinesV1Pipeline $postBody, array $optParams = [])
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. (pipelines.create)
GoogleProtobufEmpty
delete(string $name, array $optParams = [])
Deletes a pipeline. If a scheduler job is attached to the pipeline, it will be deleted. (pipelines.delete)
GoogleCloudDatapipelinesV1Pipeline
get(string $name, array $optParams = [])
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. (pipelines.get)
GoogleCloudDatapipelinesV1ListPipelinesResponse
listProjectsLocationsPipelines(string $parent, array $optParams = [])
Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it. (pipelines.listProjectsLocationsPipelines)
GoogleCloudDatapipelinesV1Pipeline
patch(string $name, GoogleCloudDatapipelinesV1Pipeline $postBody, array $optParams = [])
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. (pipelines.patch)
GoogleCloudDatapipelinesV1RunPipelineResponse
run(string $name, GoogleCloudDatapipelinesV1RunPipelineRequest $postBody, array $optParams = [])
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.
(pipelines.run)
GoogleCloudDatapipelinesV1Pipeline
stop(string $name, GoogleCloudDatapipelinesV1StopPipelineRequest $postBody, array $optParams = [])
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. (pipelines.stop)