gcp.bigquery.dataset.describe

Describe a BigQuery dataset (existence + metadata).

Overview

Property	Value
Workflow type	Linear
Library	Base-gcp
Version	1.0

Input Schema

Field	Type	Required	Default	Description
connection_uuid	uuid	Yes	—	GCP CloudConnection UUID.
project_id	string	No	—	Dataset project; defaults to the connection's project.
dataset_id	string	Yes	—	BigQuery dataset id.

Output Schema

Field	Type	Required	Default	Description
connection_uuid	uuid	No	—	Echoed connection UUID.
project_id	string	No	—	Effective project id.
dataset_id	string	No	—	BigQuery dataset id.
exists	boolean	No	—	True when the dataset exists.
location	string	No	—	Dataset location.
self_link	string	No	—	Dataset selfLink.
dataset	json	No	—	Sanitized dataset resource.
failure_reason	string	No	—	Human-readable failure reason.
failed_step	string	No	—	Failed logical step.
failed_layer	json	No	—	Engine failed layer envelope.
failed_at_state	string	No	—	State where failure occurred.
error	string	No	—	Error message.
error_type	string	No	—	Error class.

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	preflight	—
describing	No	No	—	complete	—
preflighting	No	No	—	execute	—
completed	No	Yes	Yes	—	—
failed	No	Yes	No	—	—

State Diagram

Transitions

From	Action	To	Description
pending	preflight	preflighting	—
preflighting	execute	describing	—
describing	complete	completed	—
* (any state)	fail	failed	—

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "gcp.bigquery.dataset.describe",
  "initial_data": {
    "connection_uuid": "value",
    "dataset_id": "value"
  }
}