Type alias PreWriterRecord

PreWriterRecord: {
    context?: string;
    name?: string;
    orchestrationCheckpoints?: string;
    orchestrationExecutionUnits?: string;
    orchestrationLogs?: string;
    processId?: string;
    stage?: string;
    status?: string;
    traceId?: string;
    version?: string;
}

Represents the record structure for pre-writing operations in a unified storage manager context. This type includes various properties related to the orchestration process, providing metadata about the execution state, status, and logging information.

Type declaration

  • Optional context?: string

    A JSON string representing the operation context of the orchestration machine. This context includes runtime details that are essential for understanding the current state and history of the orchestration process.

  • Optional name?: string

    The name of the orchestrator. This identifier can be used to categorize or identify the specific orchestration logic or workflow being executed.

  • Optional orchestrationCheckpoints?: string

    A JSON string containing timestamps of when the orchestrator received and processed events. This chronological record is essential for performance analysis and optimization.

  • Optional orchestrationExecutionUnits?: string

    A JSON string representing the number of execution units consumed during the span of the orcehstration

  • Optional orchestrationLogs?: string

    A JSON string representing the log entries generated during the orchestration process. These logs include events emitted by the orchestrator, providing insight into its operational behavior.

  • Optional processId?: string

    A unique seed used for generating process IDs within the orchestrator. This supports the orchestration's execution tracking and identification.

  • Optional stage?: string

    The current execution stage of the orchestration state machine. This property can be used to track the progress within the orchestration flow.

  • Optional status?: string

    The overall status of the orchestration process. Valid values are 'done', 'active', or 'error'. This allows for quick assessment of the orchestration's health and operational state.

  • Optional traceId?: string

    The unique identifier (trace ID) for the orchestration, facilitating traceability and logging across the orchestration lifecycle. This ID is crucial for debugging and monitoring.

  • Optional version?: string

    The version of the orchestrator. Versioning helps in managing updates and understanding the evolution of the orchestration logic over time.

Generated using TypeDoc