Oracle Cloud Infrastructure SDK 3.63.0 · com.oracle.bmc.paginator.internal.AbstractResponseIterator

Field Summary

Modifier and Type	Field and Description
protected RESPONSE	currentResponse The most recent response/result of calling the list operation.
protected String	nextPageToken The page token to use on the next request to the list operation
protected final Function<RESPONSE, String>	nextPageTokenRetrievalFunction A function which can be used to extract the next page token from a response from a list operation
protected final Function<REQUEST, RESPONSE>	pageRetrievalFunction A function which can call a list operation with a request and return the response from that call
protected final REQUESTBUILDER	requestBuilder A builder which can be used to construct requests to the list operation
protected final Function<RequestBuilderAndToken<REQUESTBUILDER>, REQUEST>	requestBuilderFunction A function which constructs a request to a list operation based on a builder object and pagination token

Constructor Summary

Access	Constructor and Description
public	AbstractResponseIterator(final REQUESTBUILDER a builder object which can create requests for a list operation requestBuilder, final Function<RESPONSE, String> a function which can extract the next page token from a response produced by a list operation nextPageTokenRetrievalFunction, final Function<RequestBuilderAndToken<REQUESTBUILDER>, REQUEST> a function which can build a request for a list operation based on a builder object and a pagination token to use requestBuilderFunction, final Function<REQUEST, RESPONSE> a function which will call a list operation with a request and return the response of the call pageRetrievalFunction) Constructs a new AbstractResponseIterator.

Access

Constructor and Description

public

AbstractResponseIterator(final REQUESTBUILDER

a builder object which can create requests for a list operation

requestBuilder, final Function<RESPONSE, String>

a function which can extract the next page token from a response produced by a list operation

nextPageTokenRetrievalFunction, final Function<RequestBuilderAndToken<REQUESTBUILDER>, REQUEST>

a function which can build a request for a list operation based on a builder object and a pagination token to use

requestBuilderFunction, final Function<REQUEST, RESPONSE>

a function which will call a list operation with a request and return the response of the call

pageRetrievalFunction)

Constructs a new AbstractResponseIterator.

Method Summary

Modifier and Type	Method and Description
protected void	fetchNextPage() Updates the state of this class with the next page of results
protected Optional<String>	Returns: null if we have not previously made a request to fetch any results. Otherwise, an Optional containing the next page token to use. If there is no next page token to use then an empty/absent Optional will be returned getNextPageToken() Gets the page token that should be used when the list operation is next called.
protected REQUEST	Returns: the next request that should be used when calling the list operation getNextRequest() Based on the state of this class, produces the next request that should be used when calling the list operation so that the next page of results will be returned.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

currentResponse	back to summary
protected RESPONSE currentResponse The most recent response/result of calling the list operation. If the operation has never been called, then this will be null

nextPageToken	back to summary
protected String nextPageToken The page token to use on the next request to the list operation

nextPageTokenRetrievalFunction	back to summary
protected final Function<RESPONSE, String> nextPageTokenRetrievalFunction A function which can be used to extract the next page token from a response from a list operation

pageRetrievalFunction	back to summary
protected final Function<REQUEST, RESPONSE> pageRetrievalFunction A function which can call a list operation with a request and return the response from that call

requestBuilder	back to summary
protected final REQUESTBUILDER requestBuilder A builder which can be used to construct requests to the list operation

requestBuilderFunction	back to summary
protected final Function<RequestBuilderAndToken<REQUESTBUILDER>, REQUEST> requestBuilderFunction A function which constructs a request to a list operation based on a builder object and pagination token

Constructor Detail

AbstractResponseIterator	back to summary
public AbstractResponseIterator(final REQUESTBUILDER requestBuilder, final Function<RESPONSE, String> nextPageTokenRetrievalFunction, final Function<RequestBuilderAndToken<REQUESTBUILDER>, REQUEST> requestBuilderFunction, final Function<REQUEST, RESPONSE> pageRetrievalFunction) Constructs a new AbstractResponseIterator. Parameters requestBuilder:REQUESTBUILDER a builder object which can create requests for a list operation nextPageTokenRetrievalFunction:Function<RESPONSE, String> a function which can extract the next page token from a response produced by a list operation requestBuilderFunction:Function<RequestBuilderAndToken<REQUESTBUILDER>, REQUEST> a function which can build a request for a list operation based on a builder object and a pagination token to use pageRetrievalFunction:Function<REQUEST, RESPONSE> a function which will call a list operation with a request and return the response of the call

AbstractResponseIterator

back to summary

public AbstractResponseIterator(final REQUESTBUILDER requestBuilder, final Function<RESPONSE, String> nextPageTokenRetrievalFunction, final Function<RequestBuilderAndToken<REQUESTBUILDER>, REQUEST> requestBuilderFunction, final Function<REQUEST, RESPONSE> pageRetrievalFunction)

Constructs a new AbstractResponseIterator.

Parameters

requestBuilder:REQUESTBUILDER: a builder object which can create requests for a list operation
nextPageTokenRetrievalFunction:Function<RESPONSE, String>: a function which can extract the next page token from a response produced by a list operation
requestBuilderFunction:Function<RequestBuilderAndToken<REQUESTBUILDER>, REQUEST>: a function which can build a request for a list operation based on a builder object and a pagination token to use
pageRetrievalFunction:Function<REQUEST, RESPONSE>: a function which will call a list operation with a request and return the response of the call

Method Detail

fetchNextPage	back to summary
protected void fetchNextPage() Updates the state of this class with the next page of results

getNextPageToken	back to summary
protected Optional<String> getNextPageToken() Gets the page token that should be used when the list operation is next called. Returns:Optional<String> null if we have not previously made a request to fetch any results. Otherwise, an Optional containing the next page token to use. If there is no next page token to use then an empty/absent Optional will be returned

getNextPageToken

back to summary

protected Optional<String> getNextPageToken()

Gets the page token that should be used when the list operation is next called.

Returns:Optional<String>: null if we have not previously made a request to fetch any results. Otherwise, an Optional containing the next page token to use. If there is no next page token to use then an empty/absent Optional will be returned

getNextRequest	back to summary
protected REQUEST getNextRequest() Based on the state of this class, produces the next request that should be used when calling the list operation so that the next page of results will be returned. This will just create the request and not make any service calls Returns:REQUEST the next request that should be used when calling the list operation

getNextRequest

back to summary

protected REQUEST getNextRequest()

Based on the state of this class, produces the next request that should be used when calling the list operation so that the next page of results will be returned. This will just create the request and not make any service calls

Returns:REQUEST: the next request that should be used when calling the list operation

public abstract Class AbstractResponseIterator<REQUESTBUILDER, REQUEST, RESPONSE>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail