Google Cloud Dataflow Templates API

openapi: 3.2.0
info:
  title: Google Cloud Dataflow Debug Templates 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/
servers:
- url: https://dataflow.googleapis.com
  description: Google Cloud Dataflow API production endpoint
security:
- oauth2: []
- apiKey: []
tags:
- name: Templates
  description: Operations for working with Dataflow classic templates.
paths:
  /v1b3/projects/{projectId}/locations/{location}/templates:
    post:
      operationId: createLocationJobFromTemplate
      summary: Google Cloud Dataflow Create a job from a template in a specific location
      description: Creates a new Dataflow job from a classic template in the specified project and regional location. The template defines the pipeline structure and the request provides runtime parameters.
      tags:
      - Templates
      parameters:
      - $ref: '#/components/parameters/projectId'
      - $ref: '#/components/parameters/locationPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateJobFromTemplateRequest'
      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'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /v1b3/projects/{projectId}/locations/{location}/templates:get:
    get:
      operationId: getLocationTemplate
      summary: Google Cloud Dataflow Get template metadata in a specific location
      description: Retrieves the metadata for a Dataflow template in the specified project and regional location. Returns template information including name, description, parameters, and streaming capability.
      tags:
      - Templates
      parameters:
      - $ref: '#/components/parameters/projectId'
      - $ref: '#/components/parameters/locationPath'
      - name: gcsPath
        in: query
        description: Required. A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL beginning with gs://.
        required: true
        schema:
          type: string
      - name: view
        in: query
        description: The view to retrieve. Defaults to METADATA_ONLY.
        schema:
          type: string
          enum:
          - METADATA_ONLY
      responses:
        '200':
          description: Successful response containing the template metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTemplateResponse'
        '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}/templates:launch:
    post:
      operationId: launchLocationTemplate
      summary: Google Cloud Dataflow Launch a template job in a specific location
      description: Launches a Dataflow job from a classic template in the specified project and regional location. Validates the template parameters and creates a new job with the provided configuration.
      tags:
      - Templates
      parameters:
      - $ref: '#/components/parameters/projectId'
      - $ref: '#/components/parameters/locationPath'
      - name: gcsPath
        in: query
        description: A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL beginning with gs://.
        schema:
          type: string
      - name: validateOnly
        in: query
        description: If true, the request is validated but not actually executed. Defaults to false.
        schema:
          type: boolean
      - name: dynamicTemplate.gcsPath
        in: query
        description: Path to the dynamic template spec file on Cloud Storage.
        schema:
          type: string
      - name: dynamicTemplate.stagingLocation
        in: query
        description: Cloud Storage path for staging dependencies.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LaunchTemplateParameters'
      responses:
        '200':
          description: Successful response containing the launch result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LaunchTemplateResponse'
        '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}/templates:
    post:
      operationId: createProjectJobFromTemplate
      summary: Google Cloud Dataflow Create a job from a template in a project
      description: Creates a new Dataflow job from a classic template in the specified project. The template defines the pipeline structure and the request provides runtime parameters.
      tags:
      - Templates
      parameters:
      - $ref: '#/components/parameters/projectId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateJobFromTemplateRequest'
      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'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /v1b3/projects/{projectId}/templates:get:
    get:
      operationId: getProjectTemplate
      summary: Google Cloud Dataflow Get template metadata in a project
      description: Retrieves the metadata for a Dataflow template in the specified project. Returns template information including name, description, parameters, and streaming capability.
      tags:
      - Templates
      parameters:
      - $ref: '#/components/parameters/projectId'
      - name: gcsPath
        in: query
        description: Required. A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL beginning with gs://.
        required: true
        schema:
          type: string
      - name: view
        in: query
        description: The view to retrieve. Defaults to METADATA_ONLY.
        schema:
          type: string
          enum:
          - METADATA_ONLY
      - $ref: '#/components/parameters/location'
      responses:
        '200':
          description: Successful response containing the template metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTemplateResponse'
        '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}/templates:launch:
    post:
      operationId: launchProjectTemplate
      summary: Google Cloud Dataflow Launch a template job in a project
      description: Launches a Dataflow job from a classic template in the specified project. Validates the template parameters and creates a new job with the provided configuration.
      tags:
      - Templates
      parameters:
      - $ref: '#/components/parameters/projectId'
      - name: gcsPath
        in: query
        description: A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL beginning with gs://.
        schema:
          type: string
      - name: validateOnly
        in: query
        description: If true, the request is validated but not actually executed. Defaults to false.
        schema:
          type: boolean
      - name: dynamicTemplate.gcsPath
        in: query
        description: Path to the dynamic template spec file on Cloud Storage.
        schema:
          type: string
      - name: dynamicTemplate.stagingLocation
        in: query
        description: Cloud Storage path for staging dependencies.
        schema:
          type: string
      - $ref: '#/components/parameters/location'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LaunchTemplateParameters'
      responses:
        '200':
          description: Successful response containing the launch result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LaunchTemplateResponse'
        '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'
components:
  schemas:
    TemplateMetadata:
      type: object
      description: Metadata describing a template, including its name, description, and parameters.
      properties:
        name:
          type: string
          description: Required. The name of the template.
        description:
          type: string
          description: Optional. A description of the template.
        parameters:
          type: array
          description: The parameters for the template.
          items:
            $ref: '#/components/schemas/ParameterMetadata'
        streaming:
          type: boolean
          description: If true, this template processes unbounded data streams.
        supportsAtLeastOnce:
          type: boolean
          description: If true, this template supports at-least-once processing.
        supportsExactlyOnce:
          type: boolean
          description: If true, this template supports exactly-once processing.
        defaultStreamingMode:
          type: string
          description: The default streaming mode for the template.
    SDKInfo:
      type: object
      description: SDK information.
      properties:
        language:
          type: string
          description: The SDK language.
          enum:
          - UNKNOWN
          - JAVA
          - PYTHON
          - GO
        version:
          type: string
          description: The SDK version.
    GetTemplateResponse:
      type: object
      description: The response to a GetTemplate request.
      properties:
        status:
          $ref: '#/components/schemas/Status'
        metadata:
          $ref: '#/components/schemas/TemplateMetadata'
        templateType:
          type: string
          description: The type of the template.
          enum:
          - UNKNOWN
          - LEGACY
          - FLEX
        runtimeMetadata:
          $ref: '#/components/schemas/RuntimeMetadata'
    JobType:
      type: string
      description: The type of Dataflow job, indicating batch or streaming execution.
      enum:
      - JOB_TYPE_UNKNOWN
      - JOB_TYPE_BATCH
      - JOB_TYPE_STREAMING
    ComponentSource:
      type: object
      description: An identification of a collection produced or consumed by a component transform.
      properties:
        userName:
          type: string
          description: Human-readable name for this source.
        name:
          type: string
          description: Dataflow service generated name for this source.
        originalTransformOrCollection:
          type: string
          description: User name for the original user transform or collection this source corresponds to.
    LaunchTemplateParameters:
      type: object
      description: Parameters to provide to the template being launched.
      properties:
        jobName:
          type: string
          description: Required. The unique name to assign to the job.
        parameters:
          type: object
          description: The runtime parameters to pass to the job.
          additionalProperties:
            type: string
        environment:
          $ref: '#/components/schemas/RuntimeEnvironment'
        update:
          type: boolean
          description: If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.
        transformNameMapping:
          type: object
          description: Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
          additionalProperties:
            type: string
    ExecutionStageState:
      type: object
      description: Describes the state of a particular execution stage within a Dataflow job.
      properties:
        executionStageName:
          type: string
          description: The name of the execution stage.
        executionStageState:
          $ref: '#/components/schemas/JobState'
        currentStateTime:
          type: string
          format: date-time
          description: The time at which the stage entered its current state.
    RuntimeUpdatableParams:
      type: object
      description: Additional job parameters that can be updated during execution without stopping the job.
      properties:
        maxNumWorkers:
          type: integer
          format: int32
          description: The maximum number of workers for autoscaling.
        minNumWorkers:
          type: integer
          format: int32
          description: The minimum number of workers for autoscaling.
        workerUtilizationHint:
          type: number
          format: double
          description: Target worker utilization between 0.1 and 0.9, used by the autoscaler to determine when to scale.
    TransformSummary:
      type: object
      description: Description of a transform executed as part of a Dataflow job.
      properties:
        kind:
          type: string
          description: The type of transform.
          enum:
          - UNKNOWN_KIND
          - PAR_DO_KIND
          - GROUP_BY_KEY_KIND
          - FLATTEN_KIND
          - READ_KIND
          - WRITE_KIND
          - CONSTANT_KIND
          - SINGLETON_KIND
          - SHUFFLE_KIND
        id:
          type: string
          description: SDK-generated unique identifier of the transform.
        name:
          type: string
          description: User-provided name of the transform.
        displayData:
          type: array
          description: Transform-specific display data.
          items:
            $ref: '#/components/schemas/DisplayData'
        outputCollectionName:
          type: array
          description: User names for the output collections of this transform.
          items:
            type: string
        inputCollectionName:
          type: array
          description: User names for the input collections of this transform.
          items:
            type: string
    Environment:
      type: object
      description: Describes the environment in which a Dataflow job runs, including worker pool configuration, networking, and runtime settings.
      properties:
        tempStoragePrefix:
          type: string
          description: The prefix of the Cloud Storage path for temporary storage used during job execution.
        clusterManagerApiService:
          type: string
          description: The type of cluster manager API to use for managing workers.
        experiments:
          type: array
          description: A list of experiment flags passed to the SDK and Dataflow service for enabling experimental features.
          items:
            type: string
        serviceOptions:
          type: array
          description: A list of service-level feature flags for the Dataflow service.
          items:
            type: string
        serviceKmsKeyName:
          type: string
          description: 'The Cloud KMS key used for encrypting data at rest. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}.'
        workerPools:
          type: array
          description: The worker pool configuration for the job. Each pool defines the machine type, disk, network, and autoscaling settings.
          items:
            $ref: '#/components/schemas/WorkerPool'
        userAgent:
          type: object
          description: A structure describing the SDK and its version used by the job.
          additionalProperties: true
        version:
          type: object
          description: A structure describing which version of the Dataflow service the job requires.
          additionalProperties: true
        dataset:
          type: string
          description: 'The BigQuery dataset for workflow logging tables. Format: bigquery.googleapis.com/projects/{project}/datasets/{dataset}.'
        sdkPipelineOptions:
          type: object
          description: The Cloud Dataflow SDK pipeline options specified by the user, passed through to the SDK without modification.
          additionalProperties: true
        serviceAccountEmail:
          type: string
          description: The email address of the service account to run the workers as.
        flexResourceSchedulingGoal:
          type: string
          description: Which Flexible Resource Scheduling mode to run in for Flex RS jobs.
          enum:
          - FLEXRS_UNSPECIFIED
          - FLEXRS_SPEED_OPTIMIZED
          - FLEXRS_COST_OPTIMIZED
        workerRegion:
          type: string
          description: The Compute Engine region where workers should be created. Overrides the default location.
        workerZone:
          type: string
          description: The specific Compute Engine zone where workers should be created.
        shuffleMode:
          type: string
          description: The shuffle mode for the job, set by the service.
          readOnly: true
          enum:
          - SHUFFLE_MODE_UNSPECIFIED
          - VM_BASED
          - SERVICE_BASED
        debugOptions:
          $ref: '#/components/schemas/DebugOptions'
        streamingMode:
          type: string
          description: The streaming mode for the job, specifying the message processing guarantee.
          enum:
          - STREAMING_MODE_UNSPECIFIED
          - STREAMING_MODE_EXACTLY_ONCE
          - STREAMING_MODE_AT_LEAST_ONCE
    RuntimeMetadata:
      type: object
      description: RuntimeMetadata describing a runtime environment.
      properties:
        sdkInfo:
          $ref: '#/components/schemas/SDKInfo'
        parameters:
          type: array
          description: The parameters for the template.
          items:
            $ref: '#/components/schemas/ParameterMetadata'
    BigTableIODetails:
      type: object
      description: Metadata for a Cloud Bigtable connector used by the job.
      properties:
        projectId:
          type: string
          description: ProjectId accessed in the connection.
        instanceId:
          type: string
          description: InstanceId accessed in the connection.
        tableId:
          type: string
          description: TableId accessed in the connection.
    ParameterMetadata:
      type: object
      description: Metadata for a specific parameter used by a template.
      properties:
        name:
          type: string
          description: Required. The name of the parameter.
        label:
          type: string
          description: Required. The label to display for the parameter.
        helpText:
          type: string
          description: Required. Help text to display for the parameter.
        isOptional:
          type: boolean
          description: Optional. Whether the parameter is optional. Defaults to false.
        regexes:
          type: array
          description: Optional. Regular expressions used to validate the value of the parameter.
          items:
            type: string
        paramType:
          type: string
          description: The type of the parameter.
          enum:
          - DEFAULT
          - TEXT
          - GCS_READ_BUCKET
          - GCS_WRITE_BUCKET
          - GCS_READ_FILE
          - GCS_WRITE_FILE
          - GCS_READ_FOLDER
          - GCS_WRITE_FOLDER
          - PUBSUB_TOPIC
          - PUBSUB_SUBSCRIPTION
          - BIGQUERY_TABLE
          - JAVASCRIPT_UDF_FILE
          - SERVICE_ACCOUNT
          - MACHINE_TYPE
          - KMS_KEY_NAME
          - WORKER_REGION
          - WORKER_ZONE
          - BOOLEAN
          - ENUM
          - NUMBER
          - KAFKA_TOPIC
          - KAFKA_READ_TOPIC
          - KAFKA_WRITE_TOPIC
    AutoscalingSettings:
      type: object
      description: Settings for autoscaling the number of worker instances in a pool.
      properties:
        algorithm:
          type: string
          description: The autoscaling algorithm to use.
          enum:
          - AUTOSCALING_ALGORITHM_UNKNOWN
          - AUTOSCALING_ALGORITHM_NONE
          - AUTOSCALING_ALGORITHM_BASIC
        maxNumWorkers:
          type: integer
          format: int32
          description: The maximum number of workers to scale up to.
    JobMetadata:
      type: object
      description: Metadata available primarily for filtering jobs. Represents information about the external data sources and sinks used by the job.
      properties:
        sdkVersion:
          $ref: '#/components/schemas/SdkVersion'
        spannerDetails:
          type: array
          description: Identification of Cloud Spanner sources used by this job.
          items:
            $ref: '#/components/schemas/SpannerIODetails'
        bigqueryDetails:
          type: array
          description: Identification of BigQuery sources used by this job.
          items:
            $ref: '#/components/schemas/BigQueryIODetails'
        bigTableDetails:
          type: array
          description: Identification of Cloud Bigtable sources used by this job.
          items:
            $ref: '#/components/schemas/BigTableIODetails'
        pubsubDetails:
          type: array
          description: Identification of Pub/Sub sources used by this job.
          items:
            $ref: '#/components/schemas/PubSubIODetails'
        fileDetails:
          type: array
          description: Identification of file-based sources used by this job.
          items:
            $ref: '#/components/schemas/FileIODetails'
        datastoreDetails:
          type: array
          description: Identification of Datastore sources used by this job.
          items:
            $ref: '#/components/schemas/DatastoreIODetails'
        userDisplayProperties:
          type: object
          description: User-supplied properties for display in the Dataflow monitoring UI.
          additionalProperties:
            type: string
    PubSubIODetails:
      type: object
      description: Metadata for a Pub/Sub connector used by the job.
      properties:
        topic:
          type: string
          description: Topic accessed in the connection.
        subscription:
          type: string
          description: Subscription used in the connection.
    RuntimeEnvironment:
      type: object
      description: The environment values to set at runtime for a template job launch.
      properties:
        numWorkers:
          type: integer
          format: int32
          description: The initial number of Compute Engine instances for the job.
        maxWorkers:
          type: integer
          format: int32
          description: The maximum number of Compute Engine instances for the job.
        zone:
          type: string
          description: The Compute Engine availability zone for launching worker instances.
        workerRegion:
          type: string
          description: The Compute Engine region for the workers.
        workerZone:
          type: string
          description: The Compute Engine zone where workers should be launched.
        serviceAccountEmail:
          type: string
          description: The email address of the service account to run workers as.
        tempLocation:
          type: string
          description: The Cloud Storage path for temporary files. Must be a valid Cloud Storage URL beginning with gs://.
        bypassTempDirValidation:
          type: boolean
          description: Whether to bypass the safety check for the temp directory.
        machineType:
          type: string
          description: The machine type to use for the job, such as n1-standard-4.
        network:
          type: string
          description: Network to which VMs will be assigned.
        subnetwork:
          type: string
          description: Subnetwork to which VMs will be assigned.
        additionalExperiments:
          type: array
          description: Additional experiment flags for the job.
          items:
            type: string
        additionalUserLabels:
          type: object
          description: Additional user labels to be specified for the job.
          additionalProperties:
            type: string
        kmsKeyName:
          type: string
          description: Cloud KMS key for encrypting data at rest.
        diskSizeGb:
          type: integer
          format: int32
          description: The disk size in gigabytes to use on each worker.
        ipConfiguration:
          type: string
          description: Configuration for VM networking.
          enum:
          - WORKER_IP_UNSPECIFIED
          - WORKER_IP_PUBLIC
          - WORKER_IP_PRIVATE
        enableStreamingEngine:
          type: boolean
          description: Whether to enable Streaming Engine for the job.
        streamingMode:
          type: string
          description: Specifies the Streaming Engine message processing guarantees.
          enum:
          - STREAMING_MODE_UNSPECIFIED
          - STREAMING_MODE_EXACTLY_ONCE
          - STREAMING_MODE_AT_LEAST_ONCE
    Package:
      type: object
      description: Describes a package to be installed on worker instances.
      properties:
        name:
          type: string
          description: The name of the package.
        location:
          type: string
          description: The Cloud Storage location of the package.
    PipelineDescription:
      type: object
      description: A descriptive representation of a pipeline, providing structural information about the stages and transforms in the pipeline graph.
      properties:
        originalPipelineTransform:
          type: array
          description: Description of each transform in the pipeline as provided by the user.
          items:
            $ref: '#/components/schemas/TransformSummary'
        executionPipelineStage:
          type: array
          description: Description of each stage of execution after the pipeline has been optimized by the service.
          items:
            $ref: '#/components/schemas/ExecutionStageSummary'
        displayData:
          type: array
          description: Pipeline level display data.
          items:
            $ref: '#/components/schemas/DisplayData'
    DebugOptions:
      type: object
      description: Describes debugging options for a Dataflow job.
      properties:
        enableHotKeyLogging:
          type: boolean
          description: When true, enables logging of hot key detections during job execution.
    BigQueryIODetails:
      type: object
      description: Metadata for a BigQuery connector used by the job.
      properties:
        table:
          type: string
          description: Table accessed in the connection.
        dataset:
          type: string
          description: Dataset accessed in the connection.
        projectId:
          type: string
          description: Project accessed in the connection.
        query:
          type: string
          description: Query used to access data in the connection.
    Status:
      type: object
      description: The Status type defines a logical error model, compatible with gRPC and Google API error conventions.
      properties:
        code:
          type: integer
          format: int32
          description: The status code, which should be an enum value of google.rpc.Code.
        message:
          type: string
          description: A developer-facing error message, which should be in English.
        details:
          type: array
          description: A list of messages that carry the error details.
          items:
            type: object
            additionalProperties: true
    CreateJobFromTemplateRequest:
      type: object
      description: Request to create a new Dataflow job from a classic template stored in Cloud Storage.
      properties:
        jobName:
          type: string
          description: Required. The unique name to assign to the created job.
        gcsPath:
          type: string
          description: Required. A Cloud Storage path to the template from which to create the job. Must begin with gs://.
        parameters:
          type: object
          description: The runtime parameters to pass to the template, as key-value string pairs.
          additionalProperties:
            type: string
        environment:
          $ref: '#/components/schemas/RuntimeEnvironment'
        location:
          type: string
          description: The regional endpoint to which to direct the request.
    Step:
      type: object
      description: Defines a particular step within a Dataflow job pipeline, corresponding to a transform in the pipeline graph.
      properties:
        kind:
          type: string
          description: The type of transform this step represents, such as ParallelRead, ParallelDo, or GroupByKey.
        name:
          type: string
          description: The unique name of this step within the job.
        properties:
          type: object
          description: Named properties associated with the step, containing the step configuration.
          additionalProperties: true
    DatastoreIODetails:
      type: object
      description: Metadata for a Datastore connector used by the job.
      properties:
        namespace:
          type: string
          description: Namespace used in the connection.
        projectId:
          type: string
          description: ProjectId accessed in the connection.
    FileIODetails:
      type: object
      description: Metadata for a file connector used by the job.
      properties:
        filePattern:
          type: string
          description: File pattern used in the connection.
    LaunchTemplateResponse:
      type: object
      description: Response to the request to launch a template.
      properties:
        job:
          $ref: '#/components/schemas/Job'
    JobState:
      type: string
      description: The current or requested state of a Dataflow job. States represent the lifecycle of a job from creation through completion or cancellation.
      enum:
      - JOB_STATE_UNKNOWN
      - JOB_STATE_STOPPED
      - JOB_STATE_RUNNING
      - JOB_STATE_DONE
      - JOB_STATE_FAILED
      - JOB_STATE_CA

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