Class DataLabelingPaginators
Collection of helper methods that can be used to provide an enumerator interface to any list operations of DataLabeling 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.
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.
Inherited Members
Namespace: Oci.DatalabelingservicedataplaneService
Assembly: OCI.DotNetSDK.Datalabelingservicedataplane.dll
Syntax
public class DataLabelingPaginators
Constructors
DataLabelingPaginators(DataLabelingClient)
Declaration
public DataLabelingPaginators(DataLabelingClient client)
Parameters
Type | Name | Description |
---|---|---|
DataLabelingClient | client |
Methods
ListAnnotationsRecordEnumerator(ListAnnotationsRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the AnnotationSummary objects contained in responses from the ListAnnotations operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<AnnotationSummary> ListAnnotationsRecordEnumerator(ListAnnotationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListAnnotationsRequest | 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<AnnotationSummary> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListAnnotationsResponseEnumerator(ListAnnotationsRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the responses received from the ListAnnotations operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<ListAnnotationsResponse> ListAnnotationsResponseEnumerator(ListAnnotationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListAnnotationsRequest | 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<ListAnnotationsResponse> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListRecordsRecordEnumerator(ListRecordsRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the RecordSummary objects contained in responses from the ListRecords operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<RecordSummary> ListRecordsRecordEnumerator(ListRecordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListRecordsRequest | 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<RecordSummary> | The enumerator, which supports a simple iteration over a collection of a specified type |
ListRecordsResponseEnumerator(ListRecordsRequest, RetryConfiguration, CancellationToken)
Creates a new enumerable which will iterate over the responses received from the ListRecords operation. This enumerable will fetch more data from the server as needed.
Declaration
public IEnumerable<ListRecordsResponse> ListRecordsResponseEnumerator(ListRecordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListRecordsRequest | 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<ListRecordsResponse> | The enumerator, which supports a simple iteration over a collection of a specified type |