- [Resource: WorkflowInvocation](https://docs.cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.workflowInvocations#WorkflowInvocation)
  - [JSON representation](https://docs.cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.workflowInvocations#WorkflowInvocation.SCHEMA_REPRESENTATION)
- [State](https://docs.cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.workflowInvocations#State)
- [Methods](https://docs.cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.workflowInvocations#METHODS_SUMMARY)

## Resource: WorkflowInvocation

Represents a single invocation of a compilation result.

| JSON representation |
|---|
| ``` { "name": string, "invocationConfig": { object (`https://docs.cloud.google.com/dataform/reference/rest/v1beta1/InvocationConfig`) }, "state": enum (`https://docs.cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.workflowInvocations#State`), "invocationTiming": { object (`https://docs.cloud.google.com/dataform/reference/rest/Shared.Types/Interval`) }, "resolvedCompilationResult": string, "dataEncryptionState": { object (`https://docs.cloud.google.com/dataform/reference/rest/v1beta1/DataEncryptionState`) }, "privateResourceMetadata": { object (`https://docs.cloud.google.com/dataform/reference/rest/v1beta1/PrivateResourceMetadata`) }, "pipelineConfig": { object (`https://docs.cloud.google.com/dataform/reference/rest/v1beta1/PipelineConfig`) }, // Union field `compilation_source` can be only one of the following: "compilationResult": string, "workflowConfig": string // End of list of possible types for union field `compilation_source`. "internalMetadata": string } ``` |

| Fields ||
|---|---|
| `name` | `string` Output only. The workflow invocation's name. |
| `invocationConfig` | ``object (`https://docs.cloud.google.com/dataform/reference/rest/v1beta1/InvocationConfig`)`` Immutable. If left unset, a default InvocationConfig will be used. |
| `state` | ``enum (`https://docs.cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.workflowInvocations#State`)`` Output only. This workflow invocation's current state. |
| `invocationTiming` | ``object (`https://docs.cloud.google.com/dataform/reference/rest/Shared.Types/Interval`)`` Output only. This workflow invocation's timing details. |
| `resolvedCompilationResult` | `string` Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. |
| `dataEncryptionState` | ``object (`https://docs.cloud.google.com/dataform/reference/rest/v1beta1/DataEncryptionState`)`` Output only. Only set if the repository has a KMS Key. |
| `privateResourceMetadata` | ``object (`https://docs.cloud.google.com/dataform/reference/rest/v1beta1/PrivateResourceMetadata`)`` Output only. Metadata indicating whether this resource is user-scoped. `WorkflowInvocation` resource is `userScoped` only if it is sourced from a compilation result and the compilation result is user-scoped. |
| `pipelineConfig` | ``object (`https://docs.cloud.google.com/dataform/reference/rest/v1beta1/PipelineConfig`)`` Output only. The pipeline options which define the pipeline type and path within the Git repository. |
| Union field `compilation_source`. The source of the compilation result to use for this invocation. `compilation_source` can be only one of the following: ||
| `compilationResult` | `string` Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. |
| `workflowConfig` | `string` Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`. |
| `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. |

## State

Represents the current state of a workflow invocation.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Default value. This value is unused. |
| `RUNNING` | The workflow invocation is currently running. |
| `SUCCEEDED` | The workflow invocation succeeded. A terminal state. |
| `CANCELLED` | The workflow invocation was cancelled. A terminal state. |
| `FAILED` | The workflow invocation failed. A terminal state. |
| `CANCELING` | The workflow invocation is being cancelled, but some actions are still running. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.workflowInvocations/cancel` | Requests cancellation of a running WorkflowInvocation. |
| ### `https://docs.cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.workflowInvocations/create` | Creates a new WorkflowInvocation in a given Repository. |
| ### `https://docs.cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.workflowInvocations/delete` | Deletes a single WorkflowInvocation. |
| ### `https://docs.cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.workflowInvocations/get` | Fetches a single WorkflowInvocation. |
| ### `https://docs.cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.workflowInvocations/list` | Lists WorkflowInvocations in a given Repository. |
| ### `https://docs.cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.workflowInvocations/query` | Returns WorkflowInvocationActions in a given WorkflowInvocation. |