workflow_configs

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

Overview

Name	workflow_configs
Type	Resource
Id	google.dataform.workflow_configs

Fields

Name	Datatype	Description
name	string	Identifier. The workflow config's name.
createTime	string	Output only. The timestamp of when the WorkflowConfig was created.
cronSchedule	string	Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
invocationConfig	object	Includes various configuration options for a workflow invocation. If both included_targets and included_tags are unset, all actions will be included.
recentScheduledExecutionRecords	array	Output only. Records of the 10 most recent scheduled execution attempts, ordered in in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
releaseConfig	string	Required. The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.
timeZone	string	Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
updateTime	string	Output only. The timestamp of when the WorkflowConfig was last updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, projectsId, repositoriesId, workflowConfigsId	Fetches a single WorkflowConfig.
list	SELECT	locationsId, projectsId, repositoriesId	Lists WorkflowConfigs in a given Repository.
create	INSERT	locationsId, projectsId, repositoriesId	Creates a new WorkflowConfig in a given Repository.
delete	DELETE	locationsId, projectsId, repositoriesId, workflowConfigsId	Deletes a single WorkflowConfig.
patch	UPDATE	locationsId, projectsId, repositoriesId, workflowConfigsId	Updates a single WorkflowConfig.

SELECT examples

Lists WorkflowConfigs in a given Repository.

SELECT
name,
createTime,
cronSchedule,
invocationConfig,
recentScheduledExecutionRecords,
releaseConfig,
timeZone,
updateTime
FROM google.dataform.workflow_configs
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND repositoriesId = '{{ repositoriesId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.dataform.workflow_configs (
locationsId,
projectsId,
repositoriesId,
name,
releaseConfig,
invocationConfig,
cronSchedule,
timeZone
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ repositoriesId }}',
'{{ name }}',
'{{ releaseConfig }}',
'{{ invocationConfig }}',
'{{ cronSchedule }}',
'{{ timeZone }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: releaseConfig
      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: cronSchedule
      value: string
    - name: timeZone
      value: string
    - name: recentScheduledExecutionRecords
      value:
        - - name: workflowInvocation
            value: string
          - name: errorStatus
            value:
              - name: code
                value: integer
              - name: message
                value: string
              - name: details
                value:
                  - object
          - name: executionTime
            value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string

UPDATE example

Updates a workflow_configs resource.

/*+ update */
UPDATE google.dataform.workflow_configs
SET 
name = '{{ name }}',
releaseConfig = '{{ releaseConfig }}',
invocationConfig = '{{ invocationConfig }}',
cronSchedule = '{{ cronSchedule }}',
timeZone = '{{ timeZone }}'
WHERE 
locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND repositoriesId = '{{ repositoriesId }}'
AND workflowConfigsId = '{{ workflowConfigsId }}';

DELETE example

Deletes the specified workflow_configs resource.

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