Preparing search index...
The search index is not available

Settings

Member Visibility

Protected
Private
Inherited
External

Theme

xorca
OrchestrationStateType

Type alias OrchestrationStateType

OrchestrationStateType: "parallel" | "final"

Type representing possible states in an orchestration machine.

Defined in src/create_orchestration_machine/types.ts:17

Action
A generic class for defining actions within an XState state machine context. It encapsulates
CloudOrchestrationActor
A specialized Actor class designed for cloud orchestration scenarios. It extends the XState Actor class,
Emit
`Emit` class facilitates the creation and management of typed events within a state machine.
Guard
Represents a condition (guard) within a state machine context using XState. Guards in XState are
OrchestrationRouter
PersistableActor
A class that extends the functionality of a standard actor with persistence and locking capabilities.
Transition
Manages state transitions within a state machine, allowing configuration of transition conditions, actions, and targets.
IOrchestrateCloudEvents
Describes a basic orchestration router interface, including the unique orchestrator name,
IOrchestrationRouter
Extends the basic orchestration router interface with additional configuration options,
BasicContext
Represents the standard context for a state machine, incorporating critical metadata that enhances
BasicEventObject
Defines a basic event object structure for a state machine, integrating custom data with standard
CloudOrchestrationActorOptions
Configuration options tailored for a CloudOrchestrationActor, extending the base ActorOptions with cloud-specific features.
CloudOrchestrationMiddlewares
Interface defining middleware options for a Cloud Orchestration Actor, facilitating customization of event processing and orchestration logic.
CreateOrchestrationMachineOptions
Options configuration for creating an orchestration machine.
GuardedTransitionV3
Describes configurations for state transitions within the state machine that are contingent on specific conditions
OnOrchestrationEvent
Middleware function type for processing CloudEvents.
OnOrchestrationEventTransformer
Middleware function type for processing CloudEvents.
OnOrchestrationState
Middleware function type for handling orchestration logic based on state and snapshot data.
OnOrchestrationStateEmit
Middleware function type for handling orchestration logic based on state and snapshot data.
OrchestrationMachine
Represents the output of the `createOrchestrationMachine` function.
OrchestrationMachineAllowedStringKeys
Type representing allowed string keys in orchestration machine configuration,
OrchestrationMachineConfig
Configuration for an orchestration machine. This defines the machine. It is a subset of
OrchestrationMachineConfigV3
Represents the configuration schema for an orchestration state machine, encompassing states, transitions,
OrchestrationMachineWithVersion
Defines a version-specific orchestration state machine configuration.
OrchestrationProcessResponse
Defines the structure of responses from the orchestration router, including event details,
OrchestrationStateConfig
Configuration for an orchestration machine state.
OrchestrationStateConfigV3
Configures individual states within an orchestration machine, including details on state types, transitions,
OrchestrationStateType
Type representing possible states in an orchestration machine.
OrchestrationTransitionConfig
Configuration for transitioning between states in an orchestration machine.
PersistableActorInput
Defines the structure for the input parameters required by the `withPersistance` function.
PreWriterRecord
Represents the record structure for pre-writing operations in a unified storage manager context.
Version
Represents the version of a state machine in the format '{number}.{number}.{number}'.
BasicActions
A dictionary to reference the basic actions
InternalEchoCloudEventHandler
Defines a CloudEventHandler for handling dummy events specifically designed
appendPreWriter
Use this as a append pre writer for the unified storage manager
assignEventDataToContext
assignExecutionUnitsToContext
assignLogsToContext
assignOrchestrationTimeToContext
createCloudEvent
Creates a new CloudEvent based on the provided parameters.
createCloudOrchestrationActor
Factory function for creating instances of CloudOrchestrationActor. This function simplifies the instantiation
createOrchestrationHandler
Creates an event handler for orchestrating events in xOrca.
createOrchestrationInitHandler
Creates an event handler for initializing orchestrations in xOrca.
createOrchestrationMachine
createOrchestrationMachineV2
createOrchestrationMachineV3
createOrchestrationRouter
Creates and configures an instance of an orchestration router. This router is responsible for
generateShortUuid
Generates a short UUID by first creating a standard UUID, then hashing it using SHA-256.
internalEchoEventState
Creates an internal echo state to clear the event cache in an orchestrator's memory.
makeCloudEventSubject
Creates a subject string for a given process, name, and version.
orchestrateCloudEvents
parseCloudEventSubject
Parses a subject string and returns an object with processId, name, and version.
withBasicActions
This function adds the default actions to the action list
withDefaultActions
withPersistableActor
Helper function for managing the lifecycle of a PersistableActor.

Generated using TypeDoc