ICheckpointStore<TStoreObject> Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Defines a contract for storing and retrieving checkpoints associated with a specific session and key.
public interface ICheckpointStore<TStoreObject>
type ICheckpointStore<'StoreObject> = interface
Public Interface ICheckpointStore(Of TStoreObject)
Type Parameters
- TStoreObject
The type of object to be stored as the value for each checkpoint.
- Derived
Remarks
Implementations of this interface enable durable or in-memory storage of checkpoints, which can be used to resume or audit long-running processes. The interface is generic to support different storage object types depending on the application's requirements.
Methods
| Name | Description |
|---|---|
| CreateCheckpointAsync(String, TStoreObject, CheckpointInfo) |
Asynchronously creates a checkpoint for the specified session and key, associating it with the provided value and optional parent checkpoint. |
| RetrieveCheckpointAsync(String, CheckpointInfo) |
Asynchronously retrieves a checkpoint object associated with the specified session and checkpoint key. |
| RetrieveIndexAsync(String, CheckpointInfo) |
Asynchronously retrieves the collection of checkpoint information for the specified session identifier, optionally filtered by a parent checkpoint. |