@swamp/gcp/dataflow
v2026.04.04.1
Google Cloud dataflow infrastructure models
Labels
gcpgoogle-clouddataflowcloudinfrastructure
Contents
Install
$ swamp extension pull @swamp/gcp/dataflowRelease Notes
- Updated: jobs, templates
@swamp/gcp/dataflow/jobsv2026.04.04.1jobs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| clientRequestId? | string | The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. The request to create a job will fail if the service has knowledge of a previously submitted job with the same client's ID and job name. The caller may use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it. |
| createTime? | string | The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. |
| createdFromSnapshotId? | string | If this is specified, the job's initial state is populated from the given snapshot. |
| currentState? | enum | The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field might be mutated by the Dataflow service; callers cannot mutate it. |
| currentStateTime? | string | The timestamp associated with the current state. |
| environment? | object | Describes the environment in which a Dataflow Job runs. |
| executionInfo? | object | Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. |
| id? | string | The unique ID of this job. This field is set by the Dataflow service when the job is created, and is immutable for the life of the job. |
| jobMetadata? | object | Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. |
| labels? | record | User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \\p{Ll}\\p{Lo}{0,62} * Values must conform to regexp: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size. |
| location? | string | Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. |
| name? | string | Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?` |
| pipelineDescription? | object | A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. |
| projectId? | string | The ID of the Google Cloud project that the job belongs to. |
| replaceJobId? | string | If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. |
| replacedByJobId? | string | If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. |
| requestedState? | enum | The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. |
| runtimeUpdatableParams? | object | Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. |
| satisfiesPzs? | boolean | Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. |
| serviceResources? | object | Resources used by the Dataflow Service to run the job. |
| stageStates? | array | This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. |
| startTime? | string | The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service. |
| steps? | array | Exactly one of step or steps_location should be specified. The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL. |
| stepsLocation? | string | The Cloud Storage location where the steps are stored. |
| tempFiles? | array | A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} |
| transformNameMapping? | record | Optional. The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. |
| type? | enum | Optional. The type of Dataflow job. |
| view? | string | The level of information requested in response. |
createCreate a jobs
getGet a jobs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the jobs |
updateUpdate jobs attributes
syncSync jobs state from GCP
aggregatedaggregated
get_metricsget metrics
snapshotsnapshot
| Argument | Type | Description |
|---|---|---|
| description? | any | |
| location? | any | |
| snapshotSources? | any | |
| ttl? | any |
Resources
state(infinite)— Defines a job to be run by the Cloud Dataflow service. Do not enter confident...
@swamp/gcp/dataflow/jobs-messagesv2026.04.03.3jobs_messages.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a messages
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the messages |
syncSync messages state from GCP
Resources
state(infinite)— A structured message reporting an autoscaling decision made by the Dataflow s...
@swamp/gcp/dataflow/jobs-snapshotsv2026.04.03.3jobs_snapshots.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a snapshots
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the snapshots |
syncSync snapshots state from GCP
Resources
state(infinite)— Represents a snapshot of a job.
@swamp/gcp/dataflow/snapshotsv2026.04.03.3snapshots.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a snapshots
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the snapshots |
deleteDelete the snapshots
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the snapshots |
syncSync snapshots state from GCP
Resources
state(infinite)— Represents a snapshot of a job.
@swamp/gcp/dataflow/templatesv2026.04.04.1templates.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| environment? | object | The environment values to set at runtime. |
| gcsPath? | string | Required. A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with `gs://`. |
| jobName? | string | Required. The job name to use for the created job. |
| location? | string | The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. |
| parameters? | record | The runtime parameters to pass to the job. |
createCreate a templates
getGet a templates
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the templates |
syncSync templates state from GCP
launchlaunch
| Argument | Type | Description |
|---|---|---|
| environment? | any | |
| jobName? | any | |
| parameters? | any | |
| transformNameMapping? | any | |
| update? | any |
Resources
state(infinite)— The response to a GetTemplate request.
2026.04.03.364.4 KBApr 3, 2026
Google Cloud dataflow infrastructure models
Release Notes
- Updated: jobs, jobs_messages, jobs_snapshots, snapshots, templates
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddataflowcloudinfrastructure
2026.04.03.163.2 KBApr 3, 2026
Google Cloud dataflow infrastructure models
Release Notes
- Updated: jobs, jobs_messages, jobs_snapshots, snapshots, templates
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddataflowcloudinfrastructure
2026.04.02.263.0 KBApr 2, 2026
Google Cloud dataflow infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddataflowcloudinfrastructure
2026.03.27.160.0 KBMar 27, 2026
Google Cloud dataflow infrastructure models
Release Notes
- Added: jobs, jobs_messages, jobs_snapshots, snapshots, templates
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddataflowcloudinfrastructure