Module api

Source

Structs§

Datapipelines
Central instance to access all Datapipelines related resource activities
GoogleCloudDatapipelinesV1DataflowJobDetails
Pipeline job details specific to the Dataflow API. This is encapsulated here to allow for more executors to store their specific details separately.
GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment
The environment values to be set at runtime for a Flex Template.
GoogleCloudDatapipelinesV1Job
Definition of the job information maintained by the pipeline. Fields in this entity are retrieved from the executor API (e.g. Dataflow API).
GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter
Launch Flex Template parameter.
GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest
A request to launch a Dataflow job from a Flex Template.
GoogleCloudDatapipelinesV1LaunchTemplateParameters
Parameters to provide to the template being launched.
GoogleCloudDatapipelinesV1LaunchTemplateRequest
A request to launch a template.
GoogleCloudDatapipelinesV1ListJobsResponse
Response message for ListJobs
GoogleCloudDatapipelinesV1ListPipelinesResponse
Response message for ListPipelines.
GoogleCloudDatapipelinesV1Pipeline
The main pipeline entity and all the necessary metadata for launching and managing linked jobs.
GoogleCloudDatapipelinesV1RunPipelineRequest
Request message for RunPipeline
GoogleCloudDatapipelinesV1RunPipelineResponse
Response message for RunPipeline
GoogleCloudDatapipelinesV1RuntimeEnvironment
The environment values to set at runtime.
GoogleCloudDatapipelinesV1ScheduleSpec
Details of the schedule the pipeline runs on.
GoogleCloudDatapipelinesV1SdkVersion
The version of the SDK used to run the job.
GoogleCloudDatapipelinesV1StopPipelineRequest
Request message for StopPipeline.
GoogleCloudDatapipelinesV1Workload
Workload details for creating the pipeline jobs.
GoogleProtobufEmpty
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); }
GoogleRpcStatus
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.
ProjectLocationPipelineCreateCall
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.
ProjectLocationPipelineDeleteCall
Deletes a pipeline. If a scheduler job is attached to the pipeline, it will be deleted.
ProjectLocationPipelineGetCall
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.
ProjectLocationPipelineJobListCall
Lists jobs for a given pipeline. Throws a “FORBIDDEN” error if the caller doesn’t have permission to access it.
ProjectLocationPipelineListCall
Lists pipelines. Returns a “FORBIDDEN” error if the caller doesn’t have permission to access it.
ProjectLocationPipelinePatchCall
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.
ProjectLocationPipelineRunCall
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.
ProjectLocationPipelineStopCall
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.
ProjectMethods
A builder providing access to all methods supported on project resources. It is not used directly, but through the Datapipelines hub.

Enums§

Scope
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.