workflow_configs

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

Overview

Name	`workflow_configs`
Type	Resource
Id	`google.dataform.workflow_configs`

Fields

The following fields are returned by SELECT queries:

get
list

Successful response

Name	Datatype	Description
`name`	`string`	Identifier. The workflow config's name.
`createTime`	`string (google-datetime)`	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.
`disabled`	`boolean`	Optional. Disables automatic creation of workflow invocations.
`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`	Optional. If left unset, a default InvocationConfig will be used. (id: InvocationConfig)
`recentScheduledExecutionRecords`	`array`	Output only. Records of the 10 most recent scheduled execution attempts, ordered 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 (google-datetime)`	Output only. The timestamp of when the WorkflowConfig was last updated.

Successful response

Name	Datatype	Description
`name`	`string`	Identifier. The workflow config's name.
`createTime`	`string (google-datetime)`	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.
`disabled`	`boolean`	Optional. Disables automatic creation of workflow invocations.
`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`	Optional. If left unset, a default InvocationConfig will be used. (id: InvocationConfig)
`recentScheduledExecutionRecords`	`array`	Output only. Records of the 10 most recent scheduled execution attempts, ordered 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 (google-datetime)`	Output only. The timestamp of when the WorkflowConfig was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`projectsId`, `locationsId`, `repositoriesId`, `workflowConfigsId`		Fetches a single WorkflowConfig.
`list`	`select`	`projectsId`, `locationsId`, `repositoriesId`	`pageSize`, `pageToken`	Lists WorkflowConfigs in a given Repository.
`create`	`insert`	`projectsId`, `locationsId`, `repositoriesId`	`workflowConfigId`	Creates a new WorkflowConfig in a given Repository.
`patch`	`update`	`projectsId`, `locationsId`, `repositoriesId`, `workflowConfigsId`	`updateMask`	Updates a single WorkflowConfig. Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.
`delete`	`delete`	`projectsId`, `locationsId`, `repositoriesId`, `workflowConfigsId`		Deletes a single WorkflowConfig.

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`
`workflowConfigsId`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`updateMask`	`string (google-fieldmask)`
`workflowConfigId`	`string`

`SELECT` examples

get
list

Fetches a single WorkflowConfig.

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

Lists WorkflowConfigs in a given Repository.

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

`INSERT` examples

create
Manifest

Creates a new WorkflowConfig in a given Repository.

INSERT INTO google.dataform.workflow_configs (
data__name,
data__releaseConfig,
data__invocationConfig,
data__cronSchedule,
data__timeZone,
data__disabled,
projectsId,
locationsId,
repositoriesId,
workflowConfigId
)
SELECT 
'{{ name }}',
'{{ releaseConfig }}',
'{{ invocationConfig }}',
'{{ cronSchedule }}',
'{{ timeZone }}',
{{ disabled }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ repositoriesId }}',
'{{ workflowConfigId }}'
RETURNING
name,
createTime,
cronSchedule,
disabled,
internalMetadata,
invocationConfig,
recentScheduledExecutionRecords,
releaseConfig,
timeZone,
updateTime
;

# Description fields are for documentation purposes
- name: workflow_configs
  props:
    - name: projectsId
      value: string
      description: Required parameter for the workflow_configs resource.
    - name: locationsId
      value: string
      description: Required parameter for the workflow_configs resource.
    - name: repositoriesId
      value: string
      description: Required parameter for the workflow_configs resource.
    - name: name
      value: string
      description: >
        Identifier. The workflow config's name.
        
    - name: releaseConfig
      value: string
      description: >
        Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
        
    - name: invocationConfig
      value: object
      description: >
        Optional. If left unset, a default InvocationConfig will be used.
        
    - name: cronSchedule
      value: string
      description: >
        Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
        
    - name: timeZone
      value: string
      description: >
        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.
        
    - name: disabled
      value: boolean
      description: >
        Optional. Disables automatic creation of workflow invocations.
        
    - name: workflowConfigId
      value: string

`UPDATE` examples

patch

Updates a single WorkflowConfig. Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

UPDATE google.dataform.workflow_configs
SET 
data__name = '{{ name }}',
data__releaseConfig = '{{ releaseConfig }}',
data__invocationConfig = '{{ invocationConfig }}',
data__cronSchedule = '{{ cronSchedule }}',
data__timeZone = '{{ timeZone }}',
data__disabled = {{ disabled }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND repositoriesId = '{{ repositoriesId }}' --required
AND workflowConfigsId = '{{ workflowConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
cronSchedule,
disabled,
internalMetadata,
invocationConfig,
recentScheduledExecutionRecords,
releaseConfig,
timeZone,
updateTime;

`DELETE` examples

delete

Deletes a single WorkflowConfig.

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

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​