@Generated(value="OracleSDKGenerator", comments="API Version: 20190801") public class EventPaginators extends Object
Collection of helper methods that can be used to provide an Iterable
interface
to any list operations of Event 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 |
---|
EventPaginators(Event client) |
Modifier and Type | Method and Description |
---|---|
Iterable<EventSummary> |
listEventsRecordIterator(ListEventsRequest request)
Creates a new iterable which will iterate over the
EventSummary objects
contained in responses from the listEvents operation. |
Iterable<ListEventsResponse> |
listEventsResponseIterator(ListEventsRequest request)
Creates a new iterable which will iterate over the responses received from the listEvents operation.
|
Iterable<RelatedEventSummary> |
listRelatedEventsRecordIterator(ListRelatedEventsRequest request)
Creates a new iterable which will iterate over the
RelatedEventSummary objects
contained in responses from the listRelatedEvents operation. |
Iterable<ListRelatedEventsResponse> |
listRelatedEventsResponseIterator(ListRelatedEventsRequest request)
Creates a new iterable which will iterate over the responses received from the listRelatedEvents operation.
|
@ConstructorProperties(value="client") public EventPaginators(Event client)
public Iterable<ListEventsResponse> listEventsResponseIterator(ListEventsRequest request)
Creates a new iterable which will iterate over the responses received from the listEvents 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<EventSummary> listEventsRecordIterator(ListEventsRequest request)
Creates a new iterable which will iterate over the EventSummary
objects
contained in responses from the listEvents 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 EventSummary
objects
contained in responses received from the service.public Iterable<ListRelatedEventsResponse> listRelatedEventsResponseIterator(ListRelatedEventsRequest request)
Creates a new iterable which will iterate over the responses received from the listRelatedEvents 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<RelatedEventSummary> listRelatedEventsRecordIterator(ListRelatedEventsRequest request)
Creates a new iterable which will iterate over the RelatedEventSummary
objects
contained in responses from the listRelatedEvents 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 RelatedEventSummary
objects
contained in responses received from the service.Copyright © 2016–2022. All rights reserved.