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 Debug API

Operations for retrieving debug configuration and submitting debug captures.

Google Cloud Dataflow Debug 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 Debug. 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 2 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version v1b3.

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

2 operations 2 paths 5 schemas 2 POST

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 Debug 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 2

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

Debug 2

Operations for retrieving debug configuration and submitting debug captures.

POST
/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig
Google Cloud Dataflow Get debug configuration for a job component
getLocationJobDebugConfig 3 params body → 200400401403404429500
POST
/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture
Google Cloud Dataflow Send debug capture data for a job component
sendLocationJobDebugCapture 3 params body → 200400401403404429500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are SendDebugCaptureRequest (5 properties), Status (3 properties), GetDebugConfigRequest (3 properties), GetDebugConfigResponse (1 property). Each schema is shown below with its type and property counts.

SendDebugCaptureResponse
object
Response to a send debug capture request. This is an empty response body.
GetDebugConfigRequest
object
Request to get the debug configuration for a specific component of a Dataflow job.
3 properties
GetDebugConfigResponse
object
Response to a request for debug configuration.
1 property
Status
object
The Status type defines a logical error model, compatible with gRPC and Google API error conventions.
3 properties
SendDebugCaptureRequest
object
Request to send debug capture data for a specific component of a Dataflow job.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Google Cloud Dataflow publishes across the network.

Google Cloud Dataflow Flex Templates API
Google Cloud Dataflow Jobs 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 Debug 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.