RSDTaskResultObject

public struct RSDTaskResultObject : RSDTaskResult, Codable

RSDTaskResultObject is a result associated with a task. This object includes a step history, task run UUID, schema identifier, and asynchronous results.

  • The identifier associated with the task, step, or asynchronous action.

    Declaration

    Swift

    public let identifier: String

  • A String that indicates the type of the result. This is used to decode the result using a RSDFactory.

    Declaration

    Swift

    public let type: RSDResultType

  • The start date timestamp for the result.

    Declaration

    Swift

    public var startDate: Date = Date()

  • The end date timestamp for the result.

    Declaration

    Swift

    public var endDate: Date = Date()

  • A unique identifier for this task run.

    Declaration

    Swift

    public let taskRunUUID: UUID

  • Schema info associated with this task.

    Declaration

    Swift

    public var schemaInfo: RSDSchemaInfo?

  • A listing of the step history for this task or section. The listed step results should only include the last result for any given step.

    Declaration

    Swift

    public var stepHistory: [RSDResult] = []

  • A list of all the asynchronous results for this task. The list should include uniquely identified results.

    Declaration

    Swift

    public var asyncResults: [RSDResult]?

  • Default initializer for this object.

    Declaration

    Swift

    public init(identifier: String, schemaInfo: RSDSchemaInfo? = nil)

    Parameters

    identifier

    The identifier string.
    schemaInfo

    The schemaInfo associated with this task result. Default = nil.

  • Initialize from a Decoder. This decoding method will use the RSDFactory instance associated with the decoder to decode the stepHistory, asyncResults, and schemaInfo.

    Throws

    DecodingError

    Declaration

    Swift

    public init(from decoder: Decoder) throws

    Parameters

    decoder

    The decoder to use to decode this instance.

  • Encode the result to the given encoder.

    Throws

    EncodingError

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws

    Parameters

    encoder

    The encoder to use to encode this instance.