Interface IStateApi
The gateway's State service: per-service key/value state with etags. A
missing key is a RpcException with
NotFound; a lost compare-and-swap (an etag or createOnly
write) is Aborted; etag "0" is rejected with InvalidArgument.
public interface IStateApi
Methods
DeleteBulkStateAsync(string, IEnumerable<string>, bool, ChangeNotification?, CancellationToken)
Task<DeleteBulkStateResponse> DeleteBulkStateAsync(string service, IEnumerable<string> keys, bool publishChange = false, ChangeNotification? change = null, CancellationToken cancellationToken = default)
Parameters
servicestringkeysIEnumerable<string>publishChangeboolchangeChangeNotificationcancellationTokenCancellationToken
Returns
- Task<DeleteBulkStateResponse>
DeleteStateAsync(string, string, bool, bool, ChangeNotification?, CancellationToken)
Task<DeleteStateResponse> DeleteStateAsync(string service, string key, bool publishChange = false, bool includeValue = false, ChangeNotification? change = null, CancellationToken cancellationToken = default)
Parameters
servicestringkeystringpublishChangeboolincludeValueboolchangeChangeNotificationcancellationTokenCancellationToken
Returns
- Task<DeleteStateResponse>
GetBulkStateAsync(string, IEnumerable<string>, CancellationToken)
Task<List<StateItemDto>> GetBulkStateAsync(string service, IEnumerable<string> keys, CancellationToken cancellationToken = default)
Parameters
servicestringkeysIEnumerable<string>cancellationTokenCancellationToken
Returns
GetStateAsync(string, string, CancellationToken)
Task<(string Value, string Etag)> GetStateAsync(string service, string key, CancellationToken cancellationToken = default)
Parameters
servicestringkeystringcancellationTokenCancellationToken
Returns
QueryStateAsync(string, string, int, CancellationToken)
Task<List<StateItemDto>> QueryStateAsync(string service, string query, int limit = 0, CancellationToken cancellationToken = default)
Parameters
servicestringquerystringlimitintcancellationTokenCancellationToken
Returns
SaveStateAsync(string, string, string, string?, bool, bool, ChangeNotification?, CancellationToken)
Task<SaveStateResponse> SaveStateAsync(string service, string key, string value, string? etag = null, bool publishChange = false, bool includeValue = false, ChangeNotification? change = null, CancellationToken cancellationToken = default)
Parameters
servicestringkeystringvaluestringetagstringpublishChangeboolincludeValueboolchangeChangeNotificationcancellationTokenCancellationToken
Returns
- Task<SaveStateResponse>