Method: projects.locations.repositories.workflowInvocations.query

Returns WorkflowInvocationActions in a given WorkflowInvocation.

HTTP request

GET https://dataform.googleapis.com/v1/{name=projects/*/locations/*/repositories/*/workflowInvocations/*}:query

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The workflow invocation's name.

Authorization requires the following IAM permission on the specified resource name:

  • dataform.workflowInvocations.query

Query parameters

Parameters
pageSize

integer

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

string

Optional. Page token received from a previous workflowInvocations.query call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to workflowInvocations.query, with the exception of pageSize, must match the call that provided the page token.

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 (WorkflowInvocationAction)
    }
  ],
  "nextPageToken": string
}
Fields
workflowInvocationActions[]

object (WorkflowInvocationAction)

List of workflow invocation actions.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/bigquery

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 (Target)
  },
  "canonicalTarget": {
    object (Target)
  },
  "state": enum (State),
  "failureReason": string,
  "invocationTiming": {
    object (Interval)
  },

  // Union field action can be only one of the following:
  "bigqueryAction": {
    object (BigQueryAction)
  },
  "notebookAction": {
    object (NotebookAction)
  },
  "dataPreparationAction": {
    object (DataPreparationAction)
  }
  // End of list of possible types for union field action.
  "internalMetadata": string
}
Fields
target

object (Target)

Output only. This action's identifier. Unique within the workflow invocation.
canonicalTarget

object (Target)

Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.
state

enum (State)

Output only. This action's current state.
failureReason

string

Output only. If and only if action's state is FAILED a failure reason is set.
invocationTiming

object (Interval)

Output only. This action's timing details. startTime will be set if the action is in [RUNNING, SUCCEEDED, CANCELLED, FAILED] state. endTime will be set if the action is in [SUCCEEDED, CANCELLED, FAILED] state.
Union field action. The action's details. action can be only one of the following:
bigqueryAction

object (BigQueryAction)

Output only. The workflow action's bigquery action details.
notebookAction

object (NotebookAction)

Output only. The workflow action's notebook action details.
dataPreparationAction

object (DataPreparationAction)

Output only. The workflow action's data preparation action details.
internalMetadata

string

Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

BigQueryAction

Represents a workflow action that will run against BigQuery.

JSON representation 
{
  "sqlScript": string,
  "jobId": string
}
Fields
sqlScript

string

Output only. The generated BigQuery SQL script that will be executed.
jobId

string

Output only. The ID of the BigQuery job that executed the SQL in sqlScript. Only set once the job has started to run.

NotebookAction

Represents a workflow action that will run against a Notebook runtime.

JSON representation 
{
  "contents": string,
  "jobId": string
}
Fields
contents

string

Output only. The code contents of a Notebook to be run.
jobId

string

Output only. The ID of the Vertex job that executed the notebook in contents and also the ID used for the outputs created in Google Cloud Storage buckets. Only set once the job has started to run.

DataPreparationAction

Represents a workflow action that will run a Data Preparation.

JSON representation 
{
  "generatedSql": string,
  "jobId": string,

  // Union field definition can be only one of the following:
  "contentsYaml": string,
  "contentsSql": {
    object (ActionSqlDefinition)
  }
  // End of list of possible types for union field definition.
}
Fields
generatedSql

string

Output only. The generated BigQuery SQL script that will be executed. For reference only.
jobId

string

Output only. The ID of the BigQuery job that executed the SQL in sqlScript. Only set once the job has started to run.
Union field definition. The definition for the data preparation. definition can be only one of the following:
contentsYaml

string

Output only. YAML representing the contents of the data preparation. Can be used to show the customer what the input was to their workflow.
contentsSql

object (ActionSqlDefinition)

SQL definition for a Data Preparation. Contains a SQL query and additional context information.

ActionSqlDefinition

Definition of a SQL Data Preparation

JSON representation 
{
  "query": string,
  "errorTable": {
    object (ActionErrorTable)
  },
  "loadConfig": {
    object (ActionLoadConfig)
  }
}
Fields
query

string

The SQL query representing the data preparation steps. Formatted as a Pipe SQL query statement.
errorTable

object (ActionErrorTable)

Error table configuration,
loadConfig

object (ActionLoadConfig)

Load configuration.

ActionErrorTable

Error table information, used to write error data into a BigQuery table.

JSON representation 
{
  "target": {
    object (Target)
  },
  "retentionDays": integer
}
Fields
target

object (Target)

Error Table target.
retentionDays

integer

Error table partition expiration in days. Only positive values are allowed.

ActionLoadConfig

Simplified load configuration for actions

JSON representation 
{

  // Union field mode can be only one of the following:
  "replace": {
    object (ActionSimpleLoadMode)
  },
  "append": {
    object (ActionSimpleLoadMode)
  },
  "maximum": {
    object (ActionIncrementalLoadMode)
  },
  "unique": {
    object (ActionIncrementalLoadMode)
  }
  // End of list of possible types for union field mode.
}
Fields
Union field mode. Load mode mode can be only one of the following:
replace

object (ActionSimpleLoadMode)

Replace destination table
append

object (ActionSimpleLoadMode)

Append into destination table
maximum

object (ActionIncrementalLoadMode)

Insert records where the value exceeds the previous maximum value for a column in the destination table
unique

object (ActionIncrementalLoadMode)

Insert records where the value of a column is not already present in the destination table

ActionSimpleLoadMode

This type has no fields.

Simple load definition

ActionIncrementalLoadMode

Load definition for incremental load modes

JSON representation 
{
  "column": string
}
Fields
column

string

Column name for incremental load modes

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.