Execution

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

A running instance of a Workflow.

interface Execution {

argument?: string;

callLogLevel?:

| "CALL_LOG_LEVEL_UNSPECIFIED"

| "LOG_ALL_CALLS"

| "LOG_ERRORS_ONLY"

| "LOG_NONE";

readonly createTime?: Date;

disableConcurrencyQuotaOverflowBuffering?: boolean;

readonly duration?: number;

readonly endTime?: Date;

readonly error?: Error;

executionHistoryLevel?: "EXECUTION_HISTORY_LEVEL_UNSPECIFIED" | "EXECUTION_HISTORY_BASIC" | "EXECUTION_HISTORY_DETAILED";

labels?: {

[key: string]: string;

};

readonly name?: string;

readonly result?: string;

readonly startTime?: Date;

readonly state?:

| "STATE_UNSPECIFIED"

| "ACTIVE"

| "SUCCEEDED"

| "FAILED"

| "CANCELLED"

| "UNAVAILABLE"

| "QUEUED";

readonly stateError?: StateError;

readonly status?: Status;

readonly workflowRevisionId?: string;

}

§Properties

argument?: string

[src]

Input parameters of the execution represented as a JSON string. The size limit is 32KB. Note: If you are using the REST API directly to run your workflow, you must escape any JSON string value of argument. Example: '{"argument":"{\"firstName\":\"FIRST\",\"lastName\":\"LAST\"}"}'

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

[src]

The call logging level associated to this execution.

readonly createTime?: Date

[src]

Output only. Marks the creation of the execution.

disableConcurrencyQuotaOverflowBuffering?: boolean

[src]

Optional. If set to true, the execution will not be backlogged when the concurrency quota is exhausted. The backlog execution starts when the concurrency quota becomes available.

readonly duration?: number

[src]

Output only. Measures the duration of the execution.

readonly endTime?: Date

[src]

Output only. Marks the end of execution, successful or not.

readonly error?: Error

[src]

Output only. The error which caused the execution to finish prematurely. The value is only present if the execution's state is FAILED or CANCELLED.

executionHistoryLevel?: "EXECUTION_HISTORY_LEVEL_UNSPECIFIED" | "EXECUTION_HISTORY_BASIC" | "EXECUTION_HISTORY_DETAILED"

[src]

Optional. Describes the execution history level to apply to this execution. If not specified, the execution history level is determined by its workflow's execution history level. If the levels are different, the executionHistoryLevel overrides the workflow's execution history level for this execution.

labels?: {

[key: string]: string;

}

[src]

Labels associated with this execution. 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. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution.

readonly name?: string

[src]

Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

readonly result?: string

[src]

Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is SUCCEEDED.

readonly startTime?: Date

[src]

Output only. Marks the beginning of execution. Note that this will be the same as createTime for executions that start immediately.

[src]

Output only. Current state of the execution.

readonly stateError?: StateError

[src]

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

readonly status?: Status

[src]

Output only. Status tracks the current steps and progress data of this execution.

readonly workflowRevisionId?: string

[src]

Output only. Revision of the workflow this execution is using.