Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1381128.5 KB
projects

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.

patch/v1/{+name}

Path parameters

namestring required

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.

Query parameters

updateMaskstring

List of fields to be updated. If not present, the entire workflow will be updated.

Request body

serviceAccountstring

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'CALL_LOG_LEVEL_UNSPECIFIED' | 'LOG_ALL_CALLS' | 'LOG_ERRORS_ONLY' | 'LOG_NONE'

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.

descriptionstring

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.

cryptoKeyVersionstring

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'EXECUTION_HISTORY_LEVEL_UNSPECIFIED' | 'EXECUTION_HISTORY_BASIC' | 'EXECUTION_HISTORY_DETAILED'

Optional. Describes the execution history level to apply to this workflow.

revisionIdstring

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.

labelsobject

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.

tagsobject

Optional. Input only. Immutable. Tags associated with this workflow.

allKmsKeysVersionsstring[]

Output only. A list of all KMS crypto key versions used to encrypt or decrypt the data associated with the workflow.

sourceContentsstring

Workflow code to be executed. The size limit is 128KB.

userEnvVarsobject

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".

revisionCreateTimestring google-datetime

Output only. The timestamp for the latest revision of the workflow's creation.

allKmsKeysstring[]

Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow.

state'STATE_UNSPECIFIED' | 'ACTIVE' | 'UNAVAILABLE'

Output only. State of the workflow deployment.

updateTimestring google-datetime

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.

cryptoKeyNamestring

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.

createTimestring google-datetime

Output only. The timestamp for when the workflow was created. This is a workflow-wide field and is not tied to a specific revision.

namestring

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.

Response

Successful response