REST Resource: projects.locations.workflows

Resource: Workflow

Workflow program to be executed by Workflows.

JSON representation
{
  "name": string,
  "description": string,
  "state": enum (State),
  "revisionId": string,
  "createTime": string,
  "updateTime": string,
  "revisionCreateTime": string,
  "labels": {
    string: string,
    ...
  },
  "serviceAccount": string,
  "sourceContents": string
}
Fields
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.

state

enum (State)

Output only. State of the workflow deployment.

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:

The format is "000001-a4d", where the first 6 characters define the zero-padded revision ordinal number. They are followed by a hyphen and 3 hexadecimal random characters.

createTime

string (Timestamp format)

Output only. The timestamp of when the workflow was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. The last update timestamp of the workflow.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

revisionCreateTime

string (Timestamp format)

Output only. The timestamp that the latest revision of the workflow was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

serviceAccount

string

Name of 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}

Using - as a wildcard for the {project} 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 32KB.

State

Describes the current state of workflow deployment. More states may be added in the future.

Enums
STATE_UNSPECIFIED Invalid state.
ACTIVE The workflow has been deployed successfully and is serving.

Methods

create

Creates a new workflow.

delete

Deletes a workflow with the specified name.

get

Gets details of a single Workflow.

list

Lists Workflows in a given project and location.

patch

Updates an existing workflow.