workflow_invocations

Creates, updates, deletes, gets or lists a workflow_invocations resource.

Overview

Name	workflow_invocations
Type	Resource
Id	google.dataform.workflow_invocations

Fields

Name	Datatype	Description
name	string	Output only. The workflow invocation's name.
compilationResult	string	Immutable. The name of the compilation result to use for this invocation. Must be in the format projects/*/locations/*/repositories/*/compilationResults/*.
dataEncryptionState	object	Describes encryption state of a resource.
invocationConfig	object	Includes various configuration options for a workflow invocation. If both included_targets and included_tags are unset, all actions will be included.
invocationTiming	object	Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.
resolvedCompilationResult	string	Output only. The resolved compilation result that was used to create this invocation. Will be in the format projects/*/locations/*/repositories/*/compilationResults/*.
state	string	Output only. This workflow invocation's current state.
workflowConfig	string	Immutable. The name of the workflow config to invoke. Must be in the format projects/*/locations/*/repositories/*/workflowConfigs/*.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, projectsId, repositoriesId, workflowInvocationsId	Fetches a single WorkflowInvocation.
list	SELECT	locationsId, projectsId, repositoriesId	Lists WorkflowInvocations in a given Repository.
query	SELECT	locationsId, projectsId, repositoriesId, workflowInvocationsId	Returns WorkflowInvocationActions in a given WorkflowInvocation.
create	INSERT	locationsId, projectsId, repositoriesId	Creates a new WorkflowInvocation in a given Repository.
delete	DELETE	locationsId, projectsId, repositoriesId, workflowInvocationsId	Deletes a single WorkflowInvocation.
cancel	EXEC	locationsId, projectsId, repositoriesId, workflowInvocationsId	Requests cancellation of a running WorkflowInvocation.

SELECT examples

Lists WorkflowInvocations in a given Repository.

SELECT
name,
compilationResult,
dataEncryptionState,
invocationConfig,
invocationTiming,
resolvedCompilationResult,
state,
workflowConfig
FROM google.dataform.workflow_invocations
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND repositoriesId = '{{ repositoriesId }}';

INSERT example

Use the following StackQL query and manifest file to create a new workflow_invocations resource.

All Properties

/*+ create */
INSERT INTO google.dataform.workflow_invocations (
locationsId,
projectsId,
repositoriesId,
compilationResult,
workflowConfig,
invocationConfig
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ repositoriesId }}',
'{{ compilationResult }}',
'{{ workflowConfig }}',
'{{ invocationConfig }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: compilationResult
      value: string
    - name: workflowConfig
      value: string
    - name: name
      value: string
    - name: invocationConfig
      value:
        - name: includedTargets
          value:
            - - name: database
                value: string
              - name: schema
                value: string
              - name: name
                value: string
        - name: includedTags
          value:
            - string
        - name: transitiveDependenciesIncluded
          value: boolean
        - name: transitiveDependentsIncluded
          value: boolean
        - name: fullyRefreshIncrementalTablesEnabled
          value: boolean
        - name: serviceAccount
          value: string
    - name: state
      value: string
    - name: invocationTiming
      value:
        - name: startTime
          value: string
        - name: endTime
          value: string
    - name: resolvedCompilationResult
      value: string
    - name: dataEncryptionState
      value:
        - name: kmsKeyVersionName
          value: string

DELETE example

Deletes the specified workflow_invocations resource.

/*+ delete */
DELETE FROM google.dataform.workflow_invocations
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND repositoriesId = '{{ repositoriesId }}'
AND workflowInvocationsId = '{{ workflowInvocationsId }}';