Package org.apache.drill.exec.store.http.paginator

Class HeaderIndexPaginator

java.lang.Object

org.apache.drill.exec.store.http.paginator.Paginator

org.apache.drill.exec.store.http.paginator.HeaderIndexPaginator

All Implemented Interfaces:

Iterator<String>

public class HeaderIndexPaginator
extends Paginator

The Header Index Paginator is used when the API in question send a link in the HTTP header containing the URL for the next page.

Field Summary

Fields inherited from class org.apache.drill.exec.store.http.paginator.Paginator

builder, limit, MODE, pageSize, partialPageReceived

Constructor Summary

Constructors

Constructor	Description
HeaderIndexPaginator(okhttp3.HttpUrl.Builder builder, int pageSize, int limit, String nextPageParam, String firstPageURL)

Method Summary

Modifier and Type	Method	Description
boolean	hasNext()
String	next()
void	setResponseHeaders(okhttp3.Headers headers)	This method sets the headers for the Header Index Paginator.

Methods inherited from class org.apache.drill.exec.store.http.paginator.Paginator

getMode, getPageSize, notifyPartialPage, setBuilder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Details

HeaderIndexPaginator

public HeaderIndexPaginator(okhttp3.HttpUrl.Builder builder,
 int pageSize,
 int limit,
 String nextPageParam,
 String firstPageURL)

Method Details

hasNext

public boolean hasNext()

setResponseHeaders

public void setResponseHeaders(okhttp3.Headers headers)

This method sets the headers for the Header Index Paginator. This must be called with updated headers before the next() method is called.

Parameters:

headers - A Headers object containing the response headers from the previous API call.

next

public String next()