Struct ComponentRunResultsMetadata

Namespace: Phoenix.ComponentAPI
Assembly: Phoenix.ComponentAPI.dll

An immutable structure that contains metadata about a particular run.

public struct ComponentRunResultsMetadata

Inherited Members

object.Equals(object), object.Equals(object, object), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object, object), object.ToString()

Constructors

ComponentRunResultsMetadata(RunStatus, Exception)

Constructor

Properties

Error

If ResultStatus is Error, this will contain an exception describing the error. Otherwise it will contain null.

ResultStatus

The status of this run.

Methods

IsValidStatus(RunStatus)

Given a status, check if it is a valid status for a component run result. The valid statuses are those that indicate that the run is complete - Phoenix.ComponentAPI.RunStatus.SUCCESS, Phoenix.ComponentAPI.RunStatus.FAILED, Phoenix.ComponentAPI.RunStatus.CANCELED.

RequireValidStatus(RunStatus, string)

Given a run status, check if it is a valid status for a run result. If it is valid, return the provided status. Otherwise, throw an System.ArgumentOutOfRangeException.