Workflow

import type { Workflow } from "https://googleapis.deno.dev/v1/workflows:v1.ts";

Workflow program to be executed by Workflows.

interface Workflow {

callLogLevel?:

| "CALL_LOG_LEVEL_UNSPECIFIED"

| "LOG_ALL_CALLS"

| "LOG_ERRORS_ONLY"

| "LOG_NONE";

readonly createTime?: Date;

cryptoKeyName?: string;

description?: string;

labels?: {

[key: string]: string;

};

name?: string;

readonly revisionCreateTime?: Date;

readonly revisionId?: string;

serviceAccount?: string;

sourceContents?: string;

readonly state?: "STATE_UNSPECIFIED" | "ACTIVE" | "UNAVAILABLE";

readonly stateError?: StateError;

readonly updateTime?: Date;

userEnvVars?: {

[key: string]: string;

};

}

§Properties

callLogLevel?: "CALL_LOG_LEVEL_UNSPECIFIED" | "LOG_ALL_CALLS" | "LOG_ERRORS_ONLY" | "LOG_NONE"

[src]

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.

readonly createTime?: Date

[src]

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

[src]

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.

description?: string

[src]

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.

labels?: {

[key: string]: string;

}

[src]

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.

name?: string

[src]

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.

readonly revisionCreateTime?: Date

[src]

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

readonly revisionId?: string

[src]

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

[src]

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

[src]

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

readonly state?: "STATE_UNSPECIFIED" | "ACTIVE" | "UNAVAILABLE"

[src]

Output only. State of the workflow deployment.

readonly stateError?: StateError

[src]

Output only. Error regarding the state of the workflow. For example, this field will have error details if the execution data is unavailable due to revoked KMS key permissions.

readonly updateTime?: Date

[src]

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?: {

[key: string]: string;

}

[src]

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