Class StateCosmosDBService

Namespace

FoundationaLLM.State.Services

Assembly

FoundationaLLM.State.dll

Service to access Azure Cosmos DB for NoSQL.

public class StateCosmosDBService : IStateCosmosDBService

Inheritance

object

StateCosmosDBService

Implements

IStateCosmosDBService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Constructors

StateCosmosDBService(IOptions<AzureCosmosDBSettings>, CosmosClient, ILogger<StateCosmosDBService>)

Initializes a new instance of the StateCosmosDBService class.

public StateCosmosDBService(IOptions<AzureCosmosDBSettings> settings, CosmosClient client, ILogger<StateCosmosDBService> logger)

Parameters

settings IOptions<AzureCosmosDBSettings>

The AzureCosmosDBSettings settings retrieved by the injected IOptions<TOptions>.

client CosmosClient

The Cosmos DB client.

logger ILogger<StateCosmosDBService>

The logging interface used to log under the StateCosmosDBService type name.

Exceptions

ArgumentException

Thrown if any of the required settings are null or empty.

Methods

GetLongRunningOperation(string, CancellationToken)

Retrieves a long-running operation by its identifier.

public Task<LongRunningOperation> GetLongRunningOperation(string id, CancellationToken cancellationToken = default)

Parameters

id string

The long-running operation identifier.

cancellationToken CancellationToken

Returns

Task<LongRunningOperation>

GetLongRunningOperationLogEntries(string, CancellationToken)

Retrieves all log entries for a long-running operation.

public Task<List<LongRunningOperationLogEntry>> GetLongRunningOperationLogEntries(string operationId, CancellationToken cancellationToken = default)

Parameters

operationId string

The long-running operation identifier.

cancellationToken CancellationToken

Returns

Task<List<LongRunningOperationLogEntry>>

GetLongRunningOperationResult(string, CancellationToken)

Retrieves the result of a long-running operation.

public Task<JsonDocument?> GetLongRunningOperationResult(string operationId, CancellationToken cancellationToken = default)

Parameters

operationId string

The long-running operation identifier.

cancellationToken CancellationToken

Returns

Task<JsonDocument>

GetLongRunningOperations(CancellationToken)

Retrieves all long-running operations.

public Task<List<LongRunningOperation>> GetLongRunningOperations(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<List<LongRunningOperation>>

UpsertLongRunningOperation(LongRunningOperation, CancellationToken)

Inserts or updates a long-running operation and creates a log entry.

public Task<LongRunningOperation> UpsertLongRunningOperation(LongRunningOperation operation, CancellationToken cancellationToken = default)

Parameters

operation LongRunningOperation

The long-running operation to insert or update.

cancellationToken CancellationToken

Returns

Task<LongRunningOperation>

UpsertLongRunningOperationResult(dynamic, CancellationToken)

Inserts or updates the result of a long-running operation.

public Task<object?> UpsertLongRunningOperationResult(dynamic operationResult, CancellationToken cancellationToken = default)

Parameters

operationResult dynamic

The operation result to insert or update.

cancellationToken CancellationToken

Returns

Task<object>