- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- WorkflowInvocationAction
- State
- BigQueryAction
Returns WorkflowInvocationActions in a given WorkflowInvocation.
HTTP request
GET https://dataform.googleapis.com/v1beta1/{name=projects/*/locations/*/repositories/*/workflowInvocations/*}:query
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. The workflow invocation's name. Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
pageSize |
Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. |
pageToken |
Optional. Page token received from a previous When paginating, all other parameters provided to |
Request body
The request body must be empty.
Response body
workflowInvocations.query
response message.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"workflowInvocationActions": [
{
object ( |
Fields | |
---|---|
workflowInvocationActions[] |
List of workflow invocation actions. |
nextPageToken |
A token, which can be sent as |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the name
resource:
dataform.workflowInvocations.query
For more information, see the IAM documentation.
WorkflowInvocationAction
Represents a single action in a workflow invocation.
JSON representation |
---|
{ "target": { object ( |
Fields | |
---|---|
target |
Output only. This action's identifier. Unique within the workflow invocation. |
canonicalTarget |
Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result. |
state |
Output only. This action's current state. |
failureReason |
Output only. If and only if action's state is FAILED a failure reason is set. |
invocationTiming |
Output only. This action's timing details. |
bigqueryAction |
Output only. The workflow action's bigquery action details. |
State
Represents the current state of a workflow invocation action.
Enums | |
---|---|
PENDING |
The action has not yet been considered for invocation. |
RUNNING |
The action is currently running. |
SKIPPED |
Execution of the action was skipped because upstream dependencies did not all complete successfully. A terminal state. |
DISABLED |
Execution of the action was disabled as per the configuration of the corresponding compilation result action. A terminal state. |
SUCCEEDED |
The action succeeded. A terminal state. |
CANCELLED |
The action was cancelled. A terminal state. |
FAILED |
The action failed. A terminal state. |
BigQueryAction
Represents a workflow action that will run against BigQuery.
JSON representation |
---|
{ "sqlScript": string } |
Fields | |
---|---|
sqlScript |
Output only. The generated BigQuery SQL script that will be executed. |