Class ListKeysPageIterator

Namespace

Azure.Iot.Operations.Services.StateStore

Assembly

Azure.Iot.Operations.Services.dll

Provides caller-driven access to pages of State Store keys.

public sealed class ListKeysPageIterator

Inheritance

object

ListKeysPageIterator

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

GetNextPageAsync(CancellationToken)

Requests the next page of keys from the State Store.

public Task<IReadOnlyList<StateStoreKey>?> GetNextPageAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<IReadOnlyList<StateStoreKey>>

The next page of keys, which may be empty, or null when all pages have been returned.

Remarks

Each call makes at most one request. If a request fails, the continuation token is unchanged and the call may be retried. Concurrent calls are not supported.