Class HistoryExecution

Namespace

OverKizApi.Models

Assembly

OverKizApi.dll

A completed execution record as stored in the gateway history log.

public sealed class HistoryExecution

Inheritance

object

HistoryExecution

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Properties

Commands

Per-command outcome records for this execution.

[JsonPropertyName("commands")]
public IReadOnlyList<HistoryExecutionCommand> Commands { get; init; }

Property Value

IReadOnlyList<HistoryExecutionCommand>

Duration

Total duration of the execution in milliseconds.

[JsonPropertyName("duration")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
public long Duration { get; init; }

Property Value

long

EffectiveStartTime

Unix epoch millisecond timestamp when the gateway actually started executing, or null if it was queued.

[JsonPropertyName("effectiveStartTime")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public long? EffectiveStartTime { get; init; }

Property Value

long?

EndTime

Unix epoch millisecond timestamp when the execution completed, or null if still active.

[JsonPropertyName("endTime")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public long? EndTime { get; init; }

Property Value

long?

EventTime

Unix epoch millisecond timestamp of when the execution was registered.

[JsonPropertyName("eventTime")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
public long EventTime { get; init; }

Property Value

long

ExecutionSubType

Further classification of the execution origin (internal, external, or scenario).

[JsonPropertyName("executionSubType")]
public ExecutionSubType ExecutionSubType { get; init; }

Property Value

ExecutionSubType

ExecutionType

How the execution was triggered (immediate, delayed, sunrise, or sunset).

[JsonPropertyName("executionType")]
public ExecutionType ExecutionType { get; init; }

Property Value

ExecutionType

FailureType

Overall failure type string for the execution (see FailureType).

[JsonPropertyName("failureType")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? FailureType { get; init; }

Property Value

string

Id

Unique execution ID.

[JsonPropertyName("id")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Id { get; init; }

Property Value

string

Label

Optional user-visible label (e.g. the scenario name that triggered the execution).

[JsonPropertyName("label")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Label { get; init; }

Property Value

string

Owner

Owner key identifying who triggered the execution.

[JsonPropertyName("owner")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Owner { get; init; }

Property Value

string

Source

Source that submitted the execution (e.g. "APP", "SCENARIO").

[JsonPropertyName("source")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Source { get; init; }

Property Value

string

State

Terminal state of the execution.

[JsonPropertyName("state")]
public ExecutionState State { get; init; }

Property Value

ExecutionState

Type

Execution type string (see ExecutionType).

[JsonPropertyName("type")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Type { get; init; }

Property Value

string