arvo-core
    Preparing search index...

    Type Alias ArvoOrchestrationSubjectContent

    Represents the content for Arvo orchestration subject. This type provides information about the orchestrator and the current execution.

    type ArvoOrchestrationSubjectContent = {
        execution: { domain: string | null; id: string; initiator: string };
        meta: Record<string, string>;
        orchestrator: { name: string; version: ArvoSemanticVersion };
    }
    Index

    Properties

    execution meta orchestrator

    Properties

    execution: { domain: string | null; id: string; initiator: string }

    Details about the current execution.

    Type Declaration

    • domain: string | null

      The domain of the init event

    • id: string

      A unique identifier for the execution.

      Should be a non-empty string. The recomendation is to use uuid v4 to generate these ids. Note: The string must not contain ';'

      "abc123", "execution-2023-05-15-001"
    • initiator: string

      The entity or process that initiated the execution.

      Should be prefixed with a reverse-DNS name. Note: The string must not contain ';'

      "com.example.initiator-service"
    meta: Record<string, string>

    Additional metadata for the orchestration process. Store essential key-value pairs that provide context or configuration details necessary for the orchestration. Use selectively to maintain clarity and avoid storing unnecessary information.

    orchestrator: { name: string; version: ArvoSemanticVersion }

    Information about the orchestrator.

    Type Declaration

    • name: string

      The name of the orchestrator.

      Should be prefixed with a reverse-DNS name. Note: The string must not contain ';'

      "com.example.myorchestrator"
    • version: ArvoSemanticVersion

      The version of the orchestrator.

    Settings

    Member Visibility

    On This Page

    Properties