workflows

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

Overview

Name	`workflows`
Type	Resource
Id	`google.workflows.workflows`

Fields

Name	Datatype	Description
`name`	`string`	The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}. This is a workflow-wide field and is not tied to a specific revision.
`description`	`string`	Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision.
`allKmsKeys`	`array`	Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow.
`allKmsKeysVersions`	`array`	Output only. A list of all KMS crypto key versions used to encrypt or decrypt the data associated with the workflow.
`callLogLevel`	`string`	Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence.
`createTime`	`string`	Output only. The timestamp for when the workflow was created. This is a workflow-wide field and is not tied to a specific revision.
`cryptoKeyName`	`string`	Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted.
`cryptoKeyVersion`	`string`	Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}
`executionHistoryLevel`	`string`	Optional. Describes the level of the execution history feature to apply to this workflow.
`labels`	`object`	Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision.
`revisionCreateTime`	`string`	Output only. The timestamp for the latest revision of the workflow's creation.
`revisionId`	`string`	Output only. The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first six characters define the zero-padded revision ordinal number. They are followed by a hyphen and three hexadecimal random characters.
`serviceAccount`	`string`	The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. The `{account}` value can be the `email` address or the `unique_id` of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision.
`sourceContents`	`string`	Workflow code to be executed. The size limit is 128KB.
`state`	`string`	Output only. State of the workflow deployment.
`stateError`	`object`	Describes an error related to the current state of the workflow.
`updateTime`	`string`	Output only. The timestamp for when the workflow was last updated. This is a workflow-wide field and is not tied to a specific revision.
`userEnvVars`	`object`	Optional. User-defined environment variables associated with this workflow revision. This map has a maximum length of 20. Each string can take up to 4KiB. Keys cannot be empty strings and cannot start with "GOOGLE" or "WORKFLOWS".

Methods

Name	Accessible by	Required Params	Description
`get`	`SELECT`	`locationsId, projectsId, workflowsId`	Gets details of a single workflow.
`list`	`SELECT`	`locationsId, projectsId`	Lists workflows in a given project and location. The default order is not specified.
`create`	`INSERT`	`locationsId, projectsId`	Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation returns a ALREADY_EXISTS error.
`delete`	`DELETE`	`locationsId, projectsId, workflowsId`	Deletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow.
`patch`	`UPDATE`	`locationsId, projectsId, workflowsId`	Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow might be created as a result of a successful update operation. In that case, the new revision is used in new workflow executions.

`SELECT` examples

Lists workflows in a given project and location. The default order is not specified.

SELECT
name,
description,
allKmsKeys,
allKmsKeysVersions,
callLogLevel,
createTime,
cryptoKeyName,
cryptoKeyVersion,
executionHistoryLevel,
labels,
revisionCreateTime,
revisionId,
serviceAccount,
sourceContents,
state,
stateError,
updateTime,
userEnvVars
FROM google.workflows.workflows
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

`INSERT` example

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

All Properties
Manifest

/*+ create */
INSERT INTO google.workflows.workflows (
locationsId,
projectsId,
name,
description,
labels,
serviceAccount,
sourceContents,
cryptoKeyName,
callLogLevel,
userEnvVars,
executionHistoryLevel
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ description }}',
'{{ labels }}',
'{{ serviceAccount }}',
'{{ sourceContents }}',
'{{ cryptoKeyName }}',
'{{ callLogLevel }}',
'{{ userEnvVars }}',
'{{ executionHistoryLevel }}'
;

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: description
      value: string
    - name: state
      value: string
    - name: revisionId
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: revisionCreateTime
      value: string
    - name: labels
      value: object
    - name: serviceAccount
      value: string
    - name: sourceContents
      value: string
    - name: cryptoKeyName
      value: string
    - name: stateError
      value:
        - name: details
          value: string
        - name: type
          value: string
    - name: callLogLevel
      value: string
    - name: userEnvVars
      value: object
    - name: executionHistoryLevel
      value: string
    - name: allKmsKeys
      value:
        - string
    - name: allKmsKeysVersions
      value:
        - string
    - name: cryptoKeyVersion
      value: string

`UPDATE` example

Updates a workflows resource.

/*+ update */
UPDATE google.workflows.workflows
SET 
name = '{{ name }}',
description = '{{ description }}',
labels = '{{ labels }}',
serviceAccount = '{{ serviceAccount }}',
sourceContents = '{{ sourceContents }}',
cryptoKeyName = '{{ cryptoKeyName }}',
callLogLevel = '{{ callLogLevel }}',
userEnvVars = '{{ userEnvVars }}',
executionHistoryLevel = '{{ executionHistoryLevel }}'
WHERE 
locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND workflowsId = '{{ workflowsId }}';

`DELETE` example

Deletes the specified workflows resource.

/*+ delete */
DELETE FROM google.workflows.workflows
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND workflowsId = '{{ workflowsId }}';

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

UPDATE example​

DELETE example​