Class StreamAdminPaginators

Collection of helper methods that can be used to provide an enumerator interface to any list operations of StreamAdmin where multiple pages of data may be fetched. Two styles of enumerators are supported:

• Enumerating over the Response objects returned by the list operation. These are referred to as ResponseEnumerators, and the methods are suffixed with ResponseEnumerator. For example: listUsersResponseEnumerator.
• Enumerating over the resources/records being listed. These are referred to as RecordEnumerators, and the methods are suffixed with RecordEnumerator. For example: listUsersRecordEnumerator.

These enumerators abstract away the need to write code to manually handle pagination via looping and using the page tokens. They will automatically fetch more data from the service when required.

As an example, if we were using the ListUsers operation in IdentityService, then the iterator returned by calling a ResponseEnumerator method would iterate over the ListUsersResponse objects returned by each ListUsers call, whereas the enumerables returned by calling a RecordEnumerator method would iterate over the User records and we don't have to deal with ListUsersResponse objects at all. In either case, pagination will be automatically handled so we can iterate until there are no more responses or no more resources/records available.

Inheritance

object

StreamAdminPaginators

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.StreamingService

Assembly: OCI.DotNetSDK.Streaming.dll

Syntax

public class StreamAdminPaginators

Constructors

StreamAdminPaginators(StreamAdminClient)

Declaration

public StreamAdminPaginators(StreamAdminClient client)

Parameters

Type	Name	Description
StreamAdminClient	client

Methods

ListConnectHarnessesRecordEnumerator(ListConnectHarnessesRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the ConnectHarnessSummary objects contained in responses from the ListConnectHarnesses operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<ConnectHarnessSummary> ListConnectHarnessesRecordEnumerator(ListConnectHarnessesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListConnectHarnessesRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<ConnectHarnessSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListConnectHarnessesResponseEnumerator(ListConnectHarnessesRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListConnectHarnesses operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<ListConnectHarnessesResponse> ListConnectHarnessesResponseEnumerator(ListConnectHarnessesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListConnectHarnessesRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<ListConnectHarnessesResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListStreamPoolsRecordEnumerator(ListStreamPoolsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the StreamPoolSummary objects contained in responses from the ListStreamPools operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<StreamPoolSummary> ListStreamPoolsRecordEnumerator(ListStreamPoolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListStreamPoolsRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<StreamPoolSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListStreamPoolsResponseEnumerator(ListStreamPoolsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListStreamPools operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<ListStreamPoolsResponse> ListStreamPoolsResponseEnumerator(ListStreamPoolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListStreamPoolsRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<ListStreamPoolsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListStreamsRecordEnumerator(ListStreamsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the StreamSummary objects contained in responses from the ListStreams operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<StreamSummary> ListStreamsRecordEnumerator(ListStreamsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListStreamsRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<StreamSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListStreamsResponseEnumerator(ListStreamsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListStreams operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<ListStreamsResponse> ListStreamsResponseEnumerator(ListStreamsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListStreamsRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<ListStreamsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type