Package markets.alpaca.client.rest

Class AlpacaPage<T>

java.lang.Object

markets.alpaca.client.rest.AlpacaPage<T>

public final class AlpacaPage<T>
extends Object

A single paginated REST response page with HTTP metadata.

Constructor Summary

Constructors

Constructor	Description
AlpacaPage(T body, int statusCode, Map<String,List<String>> headers, String nextPageToken)

Method Summary

Modifier and Type	Method	Description
T	body()	Deserialized response body for this page.
boolean	hasNextPage()	Returns true when another page is available.
Optional<String>	header(String name)	First value for a header name, matched case-insensitively.
Map<String,List<String>>	headers()	HTTP response headers for this page.
List<String>	headers(String name)	Values for a header name, matched case-insensitively.
String	nextPageToken()	Next page token, or null when this is the final page.
Optional<String>	nextPageTokenOptional()	Next page token as an Optional.
AlpacaRateLimit	rateLimit()	Parsed rate-limit metadata from this page's HTTP headers.
int	statusCode()	HTTP status code returned with this page.

Methods inherited from class java.lang.Object

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

Constructor Details

AlpacaPage

public AlpacaPage(T body,
 int statusCode,
 Map<String,List<String>> headers,
 String nextPageToken)

Method Details

body

public T body()

Deserialized response body for this page.

statusCode

public int statusCode()

HTTP status code returned with this page.

headers

public Map<String,List<String>> headers()

HTTP response headers for this page.

header

public Optional<String> header(String name)

First value for a header name, matched case-insensitively.

headers

public List<String> headers(String name)

Values for a header name, matched case-insensitively.

nextPageToken

public String nextPageToken()

Next page token, or null when this is the final page.

nextPageTokenOptional

public Optional<String> nextPageTokenOptional()

Next page token as an Optional.

hasNextPage

public boolean hasNextPage()

Returns true when another page is available.

rateLimit

public AlpacaRateLimit rateLimit()

Parsed rate-limit metadata from this page's HTTP headers.