workflow_invocations

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

Overview

Name	workflow_invocations
Type	Resource
Id	google.dataform.workflow_invocations

Fields

The following fields are returned by SELECT queries:

get

Successful response

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	Output only. Only set if the repository has a KMS Key. (id: DataEncryptionState)
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.
invocationConfig	object	Immutable. If left unset, a default InvocationConfig will be used. (id: InvocationConfig)
invocationTiming	object	Output only. This workflow invocation's timing details. (id: Interval)
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/*.

query

Successful response

Name	Datatype	Description
nextPageToken	string	A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
workflowInvocationActions	array	List of workflow invocation actions.

list

Successful response

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	Output only. Only set if the repository has a KMS Key. (id: DataEncryptionState)
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.
invocationConfig	object	Immutable. If left unset, a default InvocationConfig will be used. (id: InvocationConfig)
invocationTiming	object	Output only. This workflow invocation's timing details. (id: Interval)
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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, repositoriesId, workflowInvocationsId		Fetches a single WorkflowInvocation.
query	select	projectsId, locationsId, repositoriesId, workflowInvocationsId	pageSize, pageToken	Returns WorkflowInvocationActions in a given WorkflowInvocation.
list	select	projectsId, locationsId, repositoriesId	pageSize, pageToken, orderBy, filter	Lists WorkflowInvocations in a given Repository.
create	insert	projectsId, locationsId, repositoriesId		Creates a new WorkflowInvocation in a given Repository.
delete	delete	projectsId, locationsId, repositoriesId, workflowInvocationsId		Deletes a single WorkflowInvocation.
cancel	exec	projectsId, locationsId, repositoriesId, workflowInvocationsId		Requests cancellation of a running WorkflowInvocation.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
repositoriesId	string
workflowInvocationsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Fetches a single WorkflowInvocation.

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

query

Returns WorkflowInvocationActions in a given WorkflowInvocation.

SELECT
nextPageToken,
workflowInvocationActions
FROM google.dataform.workflow_invocations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND repositoriesId = '{{ repositoriesId }}' -- required
AND workflowInvocationsId = '{{ workflowInvocationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

list

Lists WorkflowInvocations in a given Repository.

SELECT
name,
compilationResult,
dataEncryptionState,
internalMetadata,
invocationConfig,
invocationTiming,
resolvedCompilationResult,
state,
workflowConfig
FROM google.dataform.workflow_invocations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND repositoriesId = '{{ repositoriesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}';

INSERT examples

create

Creates a new WorkflowInvocation in a given Repository.

INSERT INTO google.dataform.workflow_invocations (
data__compilationResult,
data__workflowConfig,
data__invocationConfig,
projectsId,
locationsId,
repositoriesId
)
SELECT 
'{{ compilationResult }}',
'{{ workflowConfig }}',
'{{ invocationConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ repositoriesId }}'
RETURNING
name,
compilationResult,
dataEncryptionState,
internalMetadata,
invocationConfig,
invocationTiming,
resolvedCompilationResult,
state,
workflowConfig
;

Manifest

# Description fields are for documentation purposes
- name: workflow_invocations
  props:
    - name: projectsId
      value: string
      description: Required parameter for the workflow_invocations resource.
    - name: locationsId
      value: string
      description: Required parameter for the workflow_invocations resource.
    - name: repositoriesId
      value: string
      description: Required parameter for the workflow_invocations resource.
    - name: compilationResult
      value: string
      description: >
        Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
        
    - name: workflowConfig
      value: string
      description: >
        Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`.
        
    - name: invocationConfig
      value: object
      description: >
        Immutable. If left unset, a default InvocationConfig will be used.
        

DELETE examples

delete

Deletes a single WorkflowInvocation.

DELETE FROM google.dataform.workflow_invocations
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND repositoriesId = '{{ repositoriesId }}' --required
AND workflowInvocationsId = '{{ workflowInvocationsId }}' --required;

Lifecycle Methods

cancel

Requests cancellation of a running WorkflowInvocation.

EXEC google.dataform.workflow_invocations.cancel 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@repositoriesId='{{ repositoriesId }}' --required, 
@workflowInvocationsId='{{ workflowInvocationsId }}' --required;