How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Google Cloud Dataflow Jobs API

Operations for creating, managing, and monitoring Dataflow jobs.

Google Cloud Dataflow Jobs API is one of 8 APIs that Google Cloud Dataflow publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 7 JSON Schema definitions.

Tagged areas include Job. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, pricing, authentication docs, a support channel, and 7 JSON Schemas.

This API exposes 10 operations across 6 paths, and defines 40 schemas. It is described by OpenAPI 3.1.0, at version v1b3.

Requests are made against a single base URL, https://dataflow.googleapis.com.

10 operations 6 paths 40 schemas 6 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1b3
Base URL
https://dataflow.googleapis.com
Authentication
OAuth 2.0, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Google Cloud Dataflow Jobs API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 3 scopes. An API key is passed in the query as key (apiKey). By default, every request must be authenticated.

  • oauth2 — OAuth 2.0 authentication for Google Cloud APIs.
  • apiKey — API key for identifying the calling project.

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 6 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Jobs 10

Operations for creating, managing, and monitoring Dataflow jobs.

GET
/v1b3/projects/{projectId}/jobs:aggregated
Google Cloud Dataflow List aggregated jobs across all regions
listAggregatedJobs 6 params → 200400401403404429500
GET
/v1b3/projects/{projectId}/jobs
Google Cloud Dataflow List jobs in a project
listProjectJobs 7 params → 200400401403429500
POST
/v1b3/projects/{projectId}/jobs
Google Cloud Dataflow Create a Dataflow job in a project
createProjectJob 4 params body → 200400401403409429500
GET
/v1b3/projects/{projectId}/jobs/{jobId}
Google Cloud Dataflow Get a Dataflow job in a project
getProjectJob 4 params → 200400401403404429500
PUT
/v1b3/projects/{projectId}/jobs/{jobId}
Google Cloud Dataflow Update a Dataflow job in a project
updateProjectJob 4 params body → 200400401403404429500
GET
/v1b3/projects/{projectId}/locations/{location}/jobs
Google Cloud Dataflow List jobs in a specific location
listLocationJobs 7 params → 200400401403429500
POST
/v1b3/projects/{projectId}/locations/{location}/jobs
Google Cloud Dataflow Create a Dataflow job in a specific location
createLocationJob 4 params body → 200400401403409429500
GET
/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}
Google Cloud Dataflow Get a Dataflow job in a specific location
getLocationJob 4 params → 200400401403404429500
PUT
/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}
Google Cloud Dataflow Update a Dataflow job in a specific location
updateLocationJob 4 params body → 200400401403404429500
GET
/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/executionDetails
Google Cloud Dataflow Get execution details for a Dataflow job
getLocationJobExecutionDetails 5 params → 200400401403404429500

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are Job (26 properties), Environment (17 properties), WorkerPool (16 properties), DisplayData (12 properties). Each schema is shown below with its type and property counts.

Step
object
Defines a particular step within a Dataflow job pipeline, corresponding to a transform in the pipeline graph.
3 properties
ComponentSource
object
An identification of a collection produced or consumed by a component transform.
3 properties
JobMetadata
object
Metadata available primarily for filtering jobs. Represents information about the external data sources and sinks used by the job.
8 properties
StageSource
object
Describes a stream of data that flows in or out of a stage.
4 properties
SdkHarnessContainerImage
object
Defines an SDK harness container image used by workers to execute pipeline code.
4 properties
BigQueryIODetails
object
Metadata for a BigQuery connector used by the job.
4 properties
ListJobsResponse
object
Response to a request to list Dataflow jobs. This may be a partial response, requiring pagination to retrieve all jobs.
3 properties
DatastoreIODetails
object
Metadata for a Datastore connector used by the job.
2 properties
ComponentTransform
object
An identification of a transform within a stage.
3 properties
ProgressTimeseries
object
Information about the progress of some component of job execution.
2 properties
SpannerIODetails
object
Metadata for a Cloud Spanner connector used by the job.
3 properties
DisplayData
object
Data provided with a pipeline or transform to provide descriptive information.
12 properties
StageSummary
object
Information about a particular execution stage of a job.
7 properties
MetricStructuredName
object
Identifies a metric, using both the key and the context in which it appears.
3 properties
Status
object
The Status type defines a logical error model, compatible with gRPC and Google API error conventions.
3 properties
Job
object
Defines a Dataflow job representing a pipeline execution. A job encapsulates the pipeline configuration, environment, execution state, and metadata for batch o…
26 properties
RuntimeUpdatableParams
object
Additional job parameters that can be updated during execution without stopping the job.
3 properties
TransformSummary
object
Description of a transform executed as part of a Dataflow job.
6 properties
JobType
string
The type of Dataflow job, indicating batch or streaming execution.
PubSubIODetails
object
Metadata for a Pub/Sub connector used by the job.
2 properties
SdkVersion
object
The version of the SDK used to run the job.
3 properties
BigTableIODetails
object
Metadata for a Cloud Bigtable connector used by the job.
3 properties
PipelineDescription
object
A descriptive representation of a pipeline, providing structural information about the stages and transforms in the pipeline graph.
3 properties
StragglerSummary
object
Summarizes straggler information within a stage.
2 properties
FailedLocation
object
Indicates which regional endpoint failed to respond.
1 property
StragglerDelineation
object
Information useful for straggler identification and debugging.
2 properties
AutoscalingSettings
object
Settings for autoscaling the number of worker instances in a pool.
2 properties
WorkerPool
object
Describes a pool of workers that execute pipeline transforms. Each pool specifies the machine type, disk configuration, networking, and autoscaling behavior.
16 properties
FileIODetails
object
Metadata for a file connector used by the job.
1 property
ServiceResources
object
Resources allocated by the Dataflow service for the job.
1 property
ExecutionState
string
The state of a stage execution.
MetricUpdate
object
Describes the state of a metric at a particular point in time.
11 properties
Environment
object
Describes the environment in which a Dataflow job runs, including worker pool configuration, networking, and runtime settings.
17 properties
Point
object
A point in the timeseries.
2 properties
JobState
string
The current or requested state of a Dataflow job. States represent the lifecycle of a job from creation through completion or cancellation.
JobExecutionDetails
object
Information about the execution of a job, including per-stage execution details.
2 properties
ExecutionStageSummary
object
Description of a stage of execution after pipeline optimization.
8 properties
ExecutionStageState
object
Describes the state of a particular execution stage within a Dataflow job.
3 properties
Package
object
Describes a package to be installed on worker instances.
2 properties
DebugOptions
object
Describes debugging options for a Dataflow job.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

google-cloud-dataflow-jobs-api-openapi.yml Raw ↑

Other APIs Google Cloud Dataflow publishes across the network.

Google Cloud Dataflow Debug API
Google Cloud Dataflow Flex Templates API
Google Cloud Dataflow Messages API
Google Cloud Dataflow Metrics API
Google Cloud Dataflow Snapshots API
Google Cloud Dataflow Stages API
Google Cloud Dataflow Templates API
Where this information came from

This is an independent, third-party profile of Google Cloud Dataflow Jobs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.