Skip to main content
← back to extensions

@swamp/gcp/datapipelines

v2026.04.04.1

Google Cloud datapipelines infrastructure models

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

gcpgoogle-clouddatapipelinescloudinfrastructure

Contents

models

Install

$ swamp extension pull @swamp/gcp/datapipelines

Release Notes

  • Updated: pipelines

@swamp/gcp/datapipelines/pipelinesv2026.04.04.1pipelines.ts

Global Arguments

ArgumentTypeDescription
displayName?stringRequired. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_).
name?stringThe 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](https://cloud.google.com/resource-manager/docs/creating-managing-projects#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.Lo
pipelineSources?recordImmutable. The sources of the pipeline (for example, Dataplex). The keys and values are set by the corresponding sources during pipeline creation.
scheduleInfo?objectDetails of the schedule the pipeline runs on.
schedulerServiceAccountEmail?stringOptional. A service account email to be used with the Cloud Scheduler job. If not specified, the default compute engine service account will be used.
state?enumRequired. The state of the pipeline. When the pipeline is created, the state is set to 'PIPELINE_STATE_ACTIVE' by default. State changes can be requested by setting the state to stopping, paused, or resuming. State cannot be changed through UpdatePipeline requests.
type?enumRequired. The type of the pipeline. This field affects the scheduling of the pipeline and the type of metrics to show for the pipeline.
workload?objectWorkload details for creating the pipeline jobs.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a pipelines
getGet a pipelines
ArgumentTypeDescription
identifierstringThe name of the pipelines
updateUpdate pipelines attributes
deleteDelete the pipelines
ArgumentTypeDescription
identifierstringThe name of the pipelines
syncSync pipelines state from GCP
runrun
stopstop

Resources

state(infinite)— The main pipeline entity and all the necessary metadata for launching and man...
@swamp/gcp/datapipelines/pipelines-jobsv2026.04.03.3pipelines_jobs.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a jobs
ArgumentTypeDescription
identifierstringThe name of the jobs
syncSync jobs state from GCP

Resources

state(infinite)— Definition of the job information maintained by the pipeline. Fields in this ...