Class StateService
public class StateService : State.StateBase
- Inheritance
-
State.StateBaseStateService
- Inherited Members
Constructors
StateService(ServicesConfiguration, DaprClient, DaprClient, DaprComponentOptions, ILogger<StateService>, TopicCatalog?)
public StateService(ServicesConfiguration config, DaprClient daprClient, Dapr.DaprClient daprGrpcClient, DaprComponentOptions components, ILogger<StateService> logger, TopicCatalog? topics = null)
Parameters
configServicesConfigurationdaprClientDaprClientdaprGrpcClientDapr.DaprClientcomponentsDaprComponentOptionsloggerILogger<StateService>topicsTopicCatalog
Methods
DeleteBulkState(DeleteBulkStateRequest, ServerCallContext)
public override Task<DeleteBulkStateResponse> DeleteBulkState(DeleteBulkStateRequest request, ServerCallContext context)
Parameters
requestDeleteBulkStateRequestcontextServerCallContext
Returns
- Task<DeleteBulkStateResponse>
DeleteState(DeleteStateRequest, ServerCallContext)
public override Task<DeleteStateResponse> DeleteState(DeleteStateRequest request, ServerCallContext context)
Parameters
requestDeleteStateRequestcontextServerCallContext
Returns
- Task<DeleteStateResponse>
GetBulkState(GetBulkStateRequest, ServerCallContext)
public override Task<GetBulkStateResponse> GetBulkState(GetBulkStateRequest request, ServerCallContext context)
Parameters
requestGetBulkStateRequestcontextServerCallContext
Returns
- Task<GetBulkStateResponse>
GetState(GetStateRequest, ServerCallContext)
public override Task<GetStateResponse> GetState(GetStateRequest request, ServerCallContext context)
Parameters
requestGetStateRequestcontextServerCallContext
Returns
- Task<GetStateResponse>
QueryState(QueryStateRequest, ServerCallContext)
QueryState searches for state entries using Dapr's JSON query format. The store keeps each value as text (api#52), so a filter cannot match fields inside a value: query everything and filter by key, e.g. {"filter": {}} {"filter": {}, "page": {"limit": 50}} "{}" is Dapr's "match everything" query.
Requires the configured state store's Dapr component to support the
Query API. For Redis/Valkey backends (state.redis/state.valkey) this
means the RediSearch module must be loaded and the component must
declare queryIndexes metadata -- a plain Redis/Valkey component
without those does not support Query State at all (fails even "{}"),
and returns a generic error with no query-specific detail. If the
configured store doesn't support querying, use GetBulkState against
known keys instead (see the key-naming convention above).
public override Task<QueryStateResponse> QueryState(QueryStateRequest request, ServerCallContext context)
Parameters
requestQueryStateRequestThe request received from the client.
contextServerCallContextThe context of the server-side call handler being invoked.
Returns
- Task<QueryStateResponse>
The response to send back to the client (wrapped by a task).
SaveState(SaveStateRequest, ServerCallContext)
public override Task<SaveStateResponse> SaveState(SaveStateRequest request, ServerCallContext context)
Parameters
requestSaveStateRequestcontextServerCallContext
Returns
- Task<SaveStateResponse>