workflows

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}
description	string	Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
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.
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.
createTime	string	Output only. The timestamp for when the workflow was created.
revisionCreateTime	string	Output only. The timestamp for the latest revision of the workflow's creation.
state	string	Output only. State of the workflow deployment.
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 40KiB. Keys cannot be empty strings and cannot start with “GOOGLE” or “WORKFLOWS".
sourceContents	string	Workflow code to be executed. The size limit is 128KB.
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.
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.
updateTime	string	Output only. The timestamp for when the workflow was last updated.
stateError	object	Describes an error related to the current state of the workflow.
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.

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.
_list	EXEC	locationsId, projectsId	Lists workflows in a given project and location. The default order is not specified.
patch	EXEC	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.