Show / Hide Table of Contents

Class Execution

A running instance of a Workflow.

Inheritance
object
Execution
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.WorkflowExecutions.v1.Data
Assembly: Google.Apis.WorkflowExecutions.v1.dll
Syntax
public class Execution : IDirectResponseSchema

Properties

Argument

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

Declaration
[JsonProperty("argument")]
public virtual string Argument { get; set; }
Property Value
Type Description
string

CallLogLevel

The call logging level associated to this execution.

Declaration
[JsonProperty("callLogLevel")]
public virtual string CallLogLevel { get; set; }
Property Value
Type Description
string

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. Marks the creation of the execution.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

DisableConcurrencyQuotaOverflowBuffering

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.

Declaration
[JsonProperty("disableConcurrencyQuotaOverflowBuffering")]
public virtual bool? DisableConcurrencyQuotaOverflowBuffering { get; set; }
Property Value
Type Description
bool?

Duration

Output only. Measures the duration of the execution.

Declaration
[JsonProperty("duration")]
public virtual object Duration { get; set; }
Property Value
Type Description
object

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EndTime

object representation of EndTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use EndTimeDateTimeOffset instead.")]
public virtual object EndTime { get; set; }
Property Value
Type Description
object

EndTimeDateTimeOffset

DateTimeOffset representation of EndTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? EndTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

EndTimeRaw

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

Declaration
[JsonProperty("endTime")]
public virtual string EndTimeRaw { get; set; }
Property Value
Type Description
string

Error

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.

Declaration
[JsonProperty("error")]
public virtual Error Error { get; set; }
Property Value
Type Description
Error

ExecutionHistoryLevel

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.

Declaration
[JsonProperty("executionHistoryLevel")]
public virtual string ExecutionHistoryLevel { get; set; }
Property Value
Type Description
string

Labels

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.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

Name

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

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Result

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

Declaration
[JsonProperty("result")]
public virtual string Result { get; set; }
Property Value
Type Description
string

StartTime

object representation of StartTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use StartTimeDateTimeOffset instead.")]
public virtual object StartTime { get; set; }
Property Value
Type Description
object

StartTimeDateTimeOffset

DateTimeOffset representation of StartTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? StartTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

StartTimeRaw

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

Declaration
[JsonProperty("startTime")]
public virtual string StartTimeRaw { get; set; }
Property Value
Type Description
string

State

Output only. Current state of the execution.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

StateError

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.

Declaration
[JsonProperty("stateError")]
public virtual StateError StateError { get; set; }
Property Value
Type Description
StateError

Status

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

Declaration
[JsonProperty("status")]
public virtual Status Status { get; set; }
Property Value
Type Description
Status

WorkflowRevisionId

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

Declaration
[JsonProperty("workflowRevisionId")]
public virtual string WorkflowRevisionId { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX