Workflow Executions v1 API - Class Execution (2.3.0)

public sealed class Execution : IMessage<Execution>, IEquatable<Execution>, IDeepCloneable<Execution>, IBufferMessage, IMessage

Reference documentation and code samples for the Workflow Executions v1 API class Execution.

A running instance of a Workflow.

Inheritance

object > Execution

Namespace

Google.Cloud.Workflows.Executions.V1

Assembly

Google.Cloud.Workflows.Executions.V1.dll

Constructors

Execution()

public Execution()

Execution(Execution)

public Execution(Execution other)
Parameter
NameDescription
otherExecution

Properties

Argument

public string Argument { get; set; }

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\"}"}'

Property Value
TypeDescription
string

CallLogLevel

public Execution.Types.CallLogLevel CallLogLevel { get; set; }

The call logging level associated to this execution.

Property Value
TypeDescription
ExecutionTypesCallLogLevel

Duration

public Duration Duration { get; set; }

Output only. Measures the duration of the execution.

Property Value
TypeDescription
Duration

EndTime

public Timestamp EndTime { get; set; }

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

Property Value
TypeDescription
Timestamp

Error

public Execution.Types.Error Error { get; set; }

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.

Property Value
TypeDescription
ExecutionTypesError

ExecutionName

public ExecutionName ExecutionName { get; set; }

ExecutionName-typed view over the Name resource name property.

Property Value
TypeDescription
ExecutionName

Labels

public MapField<string, string> Labels { get; }

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.

Property Value
TypeDescription
MapFieldstringstring

Name

public string Name { get; set; }

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

Property Value
TypeDescription
string

Result

public string Result { get; set; }

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

Property Value
TypeDescription
string

StartTime

public Timestamp StartTime { get; set; }

Output only. Marks the beginning of execution.

Property Value
TypeDescription
Timestamp

State

public Execution.Types.State State { get; set; }

Output only. Current state of the execution.

Property Value
TypeDescription
ExecutionTypesState

StateError

public Execution.Types.StateError StateError { get; set; }

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.

Property Value
TypeDescription
ExecutionTypesStateError

Status

public Execution.Types.Status Status { get; set; }

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

Property Value
TypeDescription
ExecutionTypesStatus

WorkflowRevisionId

public string WorkflowRevisionId { get; set; }

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

Property Value
TypeDescription
string