Package markets.alpaca.client.rest

Class AlpacaPaginationOptions

java.lang.Object

markets.alpaca.client.rest.AlpacaPaginationOptions

public final class AlpacaPaginationOptions
extends Object

Options for bounded and defensive pagination helpers.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AlpacaPaginationOptions.Builder	Builder for AlpacaPaginationOptions.
static enum	AlpacaPaginationOptions.RepeatedTokenAction	Behavior when a pagination sequence repeats a returned next-page token.

Method Summary

Modifier and Type	Method	Description
static AlpacaPaginationOptions.Builder	builder()	Returns a builder for pagination options.
static AlpacaPaginationOptions	defaults()	Returns the default options: unbounded page/item counts with repeated-token detection.
OptionalInt	maxItems()	Maximum items to collect, or empty when item count is unbounded.
OptionalInt	maxPages()	Maximum pages to fetch, or empty when page count is unbounded.
AlpacaPaginationOptions.RepeatedTokenAction	repeatedTokenAction()	Behavior when an endpoint returns the same next_page_token more than once.

Methods inherited from class java.lang.Object

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

Method Details

defaults

public static AlpacaPaginationOptions defaults()

Returns the default options: unbounded page/item counts with repeated-token detection.

builder

public static AlpacaPaginationOptions.Builder builder()

Returns a builder for pagination options.

maxPages

public OptionalInt maxPages()

Maximum pages to fetch, or empty when page count is unbounded.

maxItems

public OptionalInt maxItems()

Maximum items to collect, or empty when item count is unbounded.

repeatedTokenAction

public AlpacaPaginationOptions.RepeatedTokenAction repeatedTokenAction()

Behavior when an endpoint returns the same next_page_token more than once.