Type Alias ArvoOrchestrationSubjectContent

ArvoOrchestrationSubjectContent: {
    execution: {
        id: string;
        initiator: string;
    };
    meta: Record<string, string>;
    orchestrator: {
        name: string;
        version: ArvoSemanticVersion;
    };
}

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

Type declaration

execution: {
id: string;
initiator: string;
}
Details about the current execution.
- 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 ';'
  Example
```
"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 ';'
  Example
```
"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.
- name: string
  The name of the orchestrator.
  
  Should be prefixed with a reverse-DNS name. Note: The string must not contain ';'
  Example
```
"com.example.myorchestrator"
```
- version: ArvoSemanticVersion
  The version of the orchestrator.

Type Alias ArvoOrchestrationSubjectContent

Type declaration

execution: { id: string; initiator: string; }

id: string

Example

initiator: string

Example

meta: Record<string, string>

orchestrator: { name: string; version: ArvoSemanticVersion; }

name: string

Example

version: ArvoSemanticVersion

Settings

execution: {
id: string;
initiator: string;
}

orchestrator: {
name: string;
version: ArvoSemanticVersion;
}