@Generated(value="OracleSDKGenerator", comments="API Version: 20211001") public class DataLabelingPaginators extends Object
Collection of helper methods that can be used to provide an Iterable
interface
to any list operations of DataLabeling where multiple pages of data may be fetched.
Two styles of iteration are supported:
These iterables 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 Iterable
returned by calling a
ResponseIterator method would iterate over the ListUsersResponse objects returned by each ListUsers call, whereas the Iterable
returned by calling a RecordIterator 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.
Constructor and Description |
---|
DataLabelingPaginators(DataLabeling client) |
Modifier and Type | Method and Description |
---|---|
Iterable<AnnotationSummary> |
listAnnotationsRecordIterator(ListAnnotationsRequest request)
Creates a new iterable which will iterate over the
AnnotationSummary objects
contained in responses from the listAnnotations operation. |
Iterable<ListAnnotationsResponse> |
listAnnotationsResponseIterator(ListAnnotationsRequest request)
Creates a new iterable which will iterate over the responses received from the listAnnotations operation.
|
Iterable<RecordSummary> |
listRecordsRecordIterator(ListRecordsRequest request)
Creates a new iterable which will iterate over the
RecordSummary objects
contained in responses from the listRecords operation. |
Iterable<ListRecordsResponse> |
listRecordsResponseIterator(ListRecordsRequest request)
Creates a new iterable which will iterate over the responses received from the listRecords operation.
|
public DataLabelingPaginators(DataLabeling client)
public Iterable<ListAnnotationsResponse> listAnnotationsResponseIterator(ListAnnotationsRequest request)
Creates a new iterable which will iterate over the responses received from the listAnnotations operation. This iterable will fetch more data from the server as needed.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the responses received from the service.public Iterable<AnnotationSummary> listAnnotationsRecordIterator(ListAnnotationsRequest request)
Creates a new iterable which will iterate over the AnnotationSummary
objects
contained in responses from the listAnnotations operation. This iterable will fetch more data from the
server as needed.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the AnnotationSummary
objects
contained in responses received from the service.public Iterable<ListRecordsResponse> listRecordsResponseIterator(ListRecordsRequest request)
Creates a new iterable which will iterate over the responses received from the listRecords operation. This iterable will fetch more data from the server as needed.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the responses received from the service.public Iterable<RecordSummary> listRecordsRecordIterator(ListRecordsRequest request)
Creates a new iterable which will iterate over the RecordSummary
objects
contained in responses from the listRecords operation. This iterable will fetch more data from the
server as needed.
request
- a request which can be sent to the service operationIterable
which can be used to iterate over the RecordSummary
objects
contained in responses received from the service.Copyright © 2016–2022. All rights reserved.