Google Cloud Dataflow API

Manages Google Cloud Dataflow projects on Google Cloud Platform for creating and managing data processing pipelines, including job submission, monitoring, and resource management for both batch and streaming workloads.

Documentation

Specifications

Other Resources

🔗
OpenAPI Discovery
https://dataflow.googleapis.com/$discovery/rest?version=v1b3
🔗
Guides
https://cloud.google.com/dataflow/docs/guides
🔗
Pricing
https://cloud.google.com/dataflow/pricing
🔗
Samples
https://cloud.google.com/dataflow/docs/samples
🔗
Support
https://cloud.google.com/dataflow/docs/support
🔗
SDKs
https://cloud.google.com/dataflow/docs/reference/libraries
🔗
Console
https://console.cloud.google.com/dataflow
🔗
StatusPage
https://status.cloud.google.com/
🔗
Security
https://cloud.google.com/dataflow/docs/concepts/security-and-permissions
🔗
Monitoring
https://cloud.google.com/dataflow/docs/guides/using-cloud-monitoring
🔗
Errors
https://cloud.google.com/dataflow/docs/guides/common-errors
🔗
Templates
https://cloud.google.com/dataflow/docs/concepts/dataflow-templates
🔗
Python SDK
https://cloud.google.com/python/docs/reference/dataflow/latest/index.html
🔗
Java SDK
https://cloud.google.com/java/docs/reference/google-cloud-dataflow/latest/overview.html
🔗
Node.js SDK
https://cloud.google.com/nodejs/docs/reference/dataflow/latest/overview
🔗
SDK Version Support
https://cloud.google.com/dataflow/docs/support/sdk-version-support-status
🔗
Metrics
https://cloud.google.com/dataflow/docs/guides/using-monitoring-intf
🔗
JSON Schema
https://raw.githubusercontent.com/api-evangelist/google-cloud-dataflow/refs/heads/main/json-schema/google-cloud-dataflow-job-schema.json
🔗
JSON Schema
https://raw.githubusercontent.com/api-evangelist/google-cloud-dataflow/refs/heads/main/json-schema/google-cloud-dataflow-environment-schema.json
🔗
JSON Schema
https://raw.githubusercontent.com/api-evangelist/google-cloud-dataflow/refs/heads/main/json-schema/google-cloud-dataflow-worker-pool-schema.json
🔗
JSON Schema
https://raw.githubusercontent.com/api-evangelist/google-cloud-dataflow/refs/heads/main/json-schema/google-cloud-dataflow-snapshot-schema.json
🔗
JSON Schema
https://raw.githubusercontent.com/api-evangelist/google-cloud-dataflow/refs/heads/main/json-schema/google-cloud-dataflow-pipeline-schema.json
🔗
JSON Schema
https://raw.githubusercontent.com/api-evangelist/google-cloud-dataflow/refs/heads/main/json-schema/google-cloud-dataflow-template-schema.json
🔗
JSON Schema
https://raw.githubusercontent.com/api-evangelist/google-cloud-dataflow/refs/heads/main/json-schema/google-cloud-dataflow-metrics-schema.json
🔗
JSON-LD Context
https://raw.githubusercontent.com/api-evangelist/google-cloud-dataflow/refs/heads/main/json-ld/google-cloud-dataflow-context.jsonld
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/google-cloud-dataflow/refs/heads/main/capabilities/google-cloud-dataflow-debug.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/google-cloud-dataflow/refs/heads/main/capabilities/google-cloud-dataflow-flex-templates.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/google-cloud-dataflow/refs/heads/main/capabilities/google-cloud-dataflow-jobs.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/google-cloud-dataflow/refs/heads/main/capabilities/google-cloud-dataflow-messages.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/google-cloud-dataflow/refs/heads/main/capabilities/google-cloud-dataflow-metrics.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/google-cloud-dataflow/refs/heads/main/capabilities/google-cloud-dataflow-snapshots.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/google-cloud-dataflow/refs/heads/main/capabilities/google-cloud-dataflow-stages.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/google-cloud-dataflow/refs/heads/main/capabilities/google-cloud-dataflow-templates.yaml

OpenAPI Specification

google-cloud-dataflow-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Google Cloud Dataflow API
  description: >-
    Manages Google Cloud Dataflow projects on Google Cloud Platform for creating
    and managing data processing pipelines, including job submission, monitoring,
    and resource management for both batch and streaming workloads.
  version: v1b3
  termsOfService: https://cloud.google.com/terms
  contact:
    name: Google Cloud Support
    url: https://cloud.google.com/dataflow/docs/support
  license:
    name: Creative Commons Attribution 4.0
    url: https://creativecommons.org/licenses/by/4.0/
externalDocs:
  description: Google Cloud Dataflow REST API Reference
  url: https://cloud.google.com/dataflow/docs/reference/rest
servers:
  - url: https://dataflow.googleapis.com
    description: Google Cloud Dataflow API production endpoint
security:
  - oauth2: []
  - apiKey: []
tags:
  - name: Debug
    description: Operations for retrieving debug configuration and submitting debug captures.
  - name: Flex Templates
    description: Operations for launching Dataflow Flex Templates.
  - name: Jobs
    description: Operations for creating, managing, and monitoring Dataflow jobs.
  - name: Messages
    description: Operations for retrieving job status messages and logs.
  - name: Metrics
    description: Operations for obtaining job and pipeline execution metrics.
  - name: Snapshots
    description: Operations for creating, listing, getting, and deleting job snapshots.
  - name: Stages
    description: Operations for retrieving stage-level execution details.
  - name: Templates
    description: Operations for working with Dataflow classic templates.
paths:
  /v1b3/projects/{projectId}/jobs:aggregated:
    get:
      operationId: listAggregatedJobs
      summary: Google Cloud Dataflow List aggregated jobs across all regions
      description: >-
        Lists all Dataflow jobs associated with the specified project across all
        regions. Returns a paginated list of jobs including their current state,
        type, and metadata.
      tags:
        - Jobs
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/jobView'
        - $ref: '#/components/parameters/jobFilter'
        - $ref: '#/components/parameters/jobName'
      responses:
        '200':
          description: Successful response containing the list of jobs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListJobsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'

  /v1b3/projects/{projectId}/jobs:
    get:
      operationId: listProjectJobs
      summary: Google Cloud Dataflow List jobs in a project
      description: >-
        Lists all Dataflow jobs associated with the specified project. Returns a
        paginated list that can be filtered by state and name. Use the location-
        specific endpoint for regional job listing.
      tags:
        - Jobs
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/jobView'
        - $ref: '#/components/parameters/jobFilter'
        - $ref: '#/components/parameters/jobName'
        - $ref: '#/components/parameters/location'
      responses:
        '200':
          description: Successful response containing the list of jobs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListJobsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
    post:
      operationId: createProjectJob
      summary: Google Cloud Dataflow Create a Dataflow job in a project
      description: >-
        Creates a new Dataflow job in the specified project. The job definition
        includes the pipeline configuration, environment settings, and execution
        parameters for batch or streaming workloads.
      tags:
        - Jobs
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/jobView'
        - name: replaceJobId
          in: query
          description: >-
            Deprecated. The ID of the job to replace when updating a pipeline.
          schema:
            type: string
        - $ref: '#/components/parameters/location'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Job'
      responses:
        '200':
          description: Successful response containing the created job.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'

  /v1b3/projects/{projectId}/jobs/{jobId}:
    get:
      operationId: getProjectJob
      summary: Google Cloud Dataflow Get a Dataflow job in a project
      description: >-
        Retrieves the state of a specified Dataflow job in the given project.
        Returns the full job resource including current state, pipeline
        description, environment, and metadata.
      tags:
        - Jobs
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/jobId'
        - $ref: '#/components/parameters/jobView'
        - $ref: '#/components/parameters/location'
      responses:
        '200':
          description: Successful response containing the job details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
    put:
      operationId: updateProjectJob
      summary: Google Cloud Dataflow Update a Dataflow job in a project
      description: >-
        Updates the state of an existing Dataflow job in the specified project.
        This is primarily used to change the requested state of a job, such as
        cancelling or draining a running job.
      tags:
        - Jobs
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/jobId'
        - $ref: '#/components/parameters/location'
        - name: updateMask
          in: query
          description: >-
            The list of fields to update relative to the job. If empty, only the
            requestedState field will be considered.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Job'
      responses:
        '200':
          description: Successful response containing the updated job.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'

  /v1b3/projects/{projectId}/jobs/{jobId}:snapshot:
    post:
      operationId: snapshotProjectJob
      summary: Google Cloud Dataflow Snapshot a Dataflow job in a project
      description: >-
        Creates a snapshot of a streaming Dataflow job in the specified project.
        Snapshots capture the state of a streaming pipeline and can be used to
        start a new job from that state.
      tags:
        - Snapshots
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/jobId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SnapshotJobRequest'
      responses:
        '200':
          description: Successful response containing the created snapshot.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Snapshot'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'

  /v1b3/projects/{projectId}/jobs/{jobId}/metrics:
    get:
      operationId: getProjectJobMetrics
      summary: Google Cloud Dataflow Get metrics for a Dataflow job in a project
      description: >-
        Retrieves the execution metrics for a specified Dataflow job in the given
        project. Returns metric updates including counters, distributions, and
        other pipeline performance indicators.
      tags:
        - Metrics
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/jobId'
        - name: startTime
          in: query
          description: >-
            Return only metric data that has changed since this time. Default is
            to return all information about all metrics for the job.
          schema:
            type: string
            format: date-time
        - $ref: '#/components/parameters/location'
      responses:
        '200':
          description: Successful response containing the job metrics.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobMetrics'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'

  /v1b3/projects/{projectId}/jobs/{jobId}/messages:
    get:
      operationId: listProjectJobMessages
      summary: Google Cloud Dataflow List messages for a Dataflow job in a project
      description: >-
        Retrieves the status messages for a specified Dataflow job in the given
        project. Messages include informational updates, warnings, and errors
        generated during job execution.
      tags:
        - Messages
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/jobId'
        - name: minimumImportance
          in: query
          description: Filter to return only messages with at least this importance level.
          schema:
            $ref: '#/components/schemas/JobMessageImportance'
        - name: startTime
          in: query
          description: >-
            Return messages with timestamps greater than or equal to this value.
          schema:
            type: string
            format: date-time
        - name: endTime
          in: query
          description: Return messages with timestamps less than this value.
          schema:
            type: string
            format: date-time
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/location'
      responses:
        '200':
          description: Successful response containing the list of job messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListJobMessagesResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'

  /v1b3/projects/{projectId}/locations/{location}/jobs:
    get:
      operationId: listLocationJobs
      summary: Google Cloud Dataflow List jobs in a specific location
      description: >-
        Lists all Dataflow jobs associated with the specified project in the
        given regional location. Returns a paginated list that can be filtered
        by state and name.
      tags:
        - Jobs
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/locationPath'
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/pageSize'
        - $ref: '#/components/parameters/jobView'
        - $ref: '#/components/parameters/jobFilter'
        - $ref: '#/components/parameters/jobName'
      responses:
        '200':
          description: Successful response containing the list of jobs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListJobsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
    post:
      operationId: createLocationJob
      summary: Google Cloud Dataflow Create a Dataflow job in a specific location
      description: >-
        Creates a new Dataflow job in the specified project and regional
        location. The job definition includes the pipeline configuration,
        environment settings, and execution parameters.
      tags:
        - Jobs
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/locationPath'
        - $ref: '#/components/parameters/jobView'
        - name: replaceJobId
          in: query
          description: >-
            Deprecated. The ID of the job to replace when updating a pipeline.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Job'
      responses:
        '200':
          description: Successful response containing the created job.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'

  /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}:
    get:
      operationId: getLocationJob
      summary: Google Cloud Dataflow Get a Dataflow job in a specific location
      description: >-
        Retrieves the state of a specified Dataflow job in the given project and
        regional location. Returns the full job resource including current state,
        pipeline description, environment, and metadata.
      tags:
        - Jobs
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/locationPath'
        - $ref: '#/components/parameters/jobId'
        - $ref: '#/components/parameters/jobView'
      responses:
        '200':
          description: Successful response containing the job details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
    put:
      operationId: updateLocationJob
      summary: Google Cloud Dataflow Update a Dataflow job in a specific location
      description: >-
        Updates the state of an existing Dataflow job in the specified project
        and regional location. This is primarily used to change the requested
        state of a job, such as cancelling or draining a running job.
      tags:
        - Jobs
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/locationPath'
        - $ref: '#/components/parameters/jobId'
        - name: updateMask
          in: query
          description: >-
            The list of fields to update relative to the job. If empty, only the
            requestedState field will be considered.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Job'
      responses:
        '200':
          description: Successful response containing the updated job.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'

  /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}:snapshot:
    post:
      operationId: snapshotLocationJob
      summary: Google Cloud Dataflow Snapshot a Dataflow job in a specific location
      description: >-
        Creates a snapshot of a streaming Dataflow job in the specified project
        and regional location. Snapshots capture the state of a streaming
        pipeline and can be used to start a new job from that state.
      tags:
        - Snapshots
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/locationPath'
        - $ref: '#/components/parameters/jobId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SnapshotJobRequest'
      responses:
        '200':
          description: Successful response containing the created snapshot.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Snapshot'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'

  /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics:
    get:
      operationId: getLocationJobMetrics
      summary: Google Cloud Dataflow Get metrics for a Dataflow job in a specific location
      description: >-
        Retrieves the execution metrics for a specified Dataflow job in the given
        project and regional location. Returns metric updates including counters,
        distributions, and other pipeline performance indicators.
      tags:
        - Metrics
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/locationPath'
        - $ref: '#/components/parameters/jobId'
        - name: startTime
          in: query
          description: >-
            Return only metric data that has changed since this time. Default is
            to return all information about all metrics for the job.
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Successful response containing the job metrics.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobMetrics'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'

  /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages:
    get:
      operationId: listLocationJobMessages
      summary: Google Cloud Dataflow List messages for a Dataflow job in a specific location
      description: >-
        Retrieves the status messages for a specified Dataflow job in the given
        project and regional location. Messages include informational updates,
        warnings, and errors generated during job execution.
      tags:
        - Messages
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/locationPath'
        - $ref: '#/components/parameters/jobId'
        - name: minimumImportance
          in: query
          description: Filter to return only messages with at least this importance level.
          schema:
            $ref: '#/components/schemas/JobMessageImportance'
        - name: startTime
          in: query
          description: >-
            Return messages with timestamps greater than or equal to this value.
          schema:
            type: string
            format: date-time
        - name: endTime
          in: query
          description: Return messages with timestamps less than this value.
          schema:
            type: string
            format: date-time
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: Successful response containing the list of job messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListJobMessagesResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'

  /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/executionDetails:
    get:
      operationId: getLocationJobExecutionDetails
      summary: Google Cloud Dataflow Get execution details for a Dataflow job
      description: >-
        Retrieves detailed execution status information for a specified Dataflow
        job in the given project and regional location. Returns information about
        the stages of the pipeline and their execution status.
      tags:
        - Jobs
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/locationPath'
        - $ref: '#/components/parameters/jobId'
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: Successful response containing the job execution details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobExecutionDetails'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'

  /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/stages/{stageId}/executionDetails:
    get:
      operationId: getLocationJobStageExecutionDetails
      summary: Google Cloud Dataflow Get stage execution details for a Dataflow job
      description: >-
        Retrieves detailed execution status information for a specific stage of
        a Dataflow job in the given project and regional location. Returns
        worker-level progress and straggler information.
      tags:
        - Stages
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/locationPath'
        - $ref: '#/components/parameters/jobId'
        - name: stageId
          in: path
          required: true
          description: The stage for which to fetch information.
          schema:
            type: string
        - $ref: '#/components/parameters/pageToken'
        - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: Successful response containing the stage execution details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StageExecutionDetails'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'

  /v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}:
    get:
      operationId: getLocationSnapshot
      summary: Google Cloud Dataflow Get a snapshot in a specific location
      description: >-
        Retrieves the details of a specified snapshot in the given project and
        regional location. Returns the snapshot metadata including state,
        creation time, and associated job information.
      tags:
        - Snapshots
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/locationPath'
        - name: snapshotId
          in: path
          required: true
          description: The ID of the snapshot to retrieve.
          schema:
            type: string
      responses:
        '200':
          description: Successful response containing the snapshot details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Snapshot'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      operationId: deleteLocationSnapshot
      summary: Google Cloud Dataflow Delete a snapshot in a specific location
      description: >-
        Deletes a specified snapshot in the given project and regional location.
        This permanently removes the snapshot and its associated data.
      tags:
        - Snapshots
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/locationPath'
        - name: snapshotId
          in: path
          required: true
          description: The ID of the snapshot to delete.
          schema:
            type: string
      responses:
        '200':
          description: Successful response indicating the snapshot was deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSnapshotResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'

  /v1b3/projects/{projectId}/locations/{location}/snapshots:
    get:
      operationId: listLocationSnapshots
      summary: Google Cloud Dataflow List snapshots in a specific location
      description: >-
        Lists all available snapshots in the specified project and regional
        location. Returns snapshot metadata including state, creation time,
        and associated job information.
      tags:
        - Snapshots
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/locationPath'
        - name: jobId
          in: query
          description: If specified, list snapshots created from this job only.
          schema:
            type: string
      responses:
        '200':
          description: Successful response containing the list of snapshots.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSnapshotsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'

  /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig:
    post:
      operationId: getLocationJobDebugConfig
      summary: Google Cloud Dataflow Get debug configuration for a job component
      description: >-
        Retrieves the debug configuration for a specific component of a Dataflow
        job in the given project and regional location. Used internally by
        Dataflow workers for debugging purposes.
      tags:
        - Debug
      parameters:
        - $ref: '#/components/parameters/projectId'
        - $ref: '#/components/parameters/locationPath'
        - $ref: '#/components/parameters/jobId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDebugConfigRequest'
      responses:
        '200':
          description: Successful response containing the debug configuration.
          c

# --- truncated at 32 KB (110 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/google-cloud-dataflow/refs/heads/main/openapi/google-cloud-dataflow-api-openapi.yml