Package markets.alpaca.client.rest

Class AlpacaPaginationOptions.Builder

java.lang.Object

markets.alpaca.client.rest.AlpacaPaginationOptions.Builder

Enclosing class:

AlpacaPaginationOptions

public static final class AlpacaPaginationOptions.Builder
extends Object

Builder for AlpacaPaginationOptions.

Method Summary

Modifier and Type	Method	Description
AlpacaPaginationOptions	build()	Builds immutable pagination options.
AlpacaPaginationOptions.Builder	maxItems(int maxItems)	Sets the maximum number of items to collect.
AlpacaPaginationOptions.Builder	maxPages(int maxPages)	Sets the maximum number of pages to fetch.
AlpacaPaginationOptions.Builder	repeatedTokenAction(AlpacaPaginationOptions.RepeatedTokenAction repeatedTokenAction)	Sets how repeated next-page tokens are handled.
AlpacaPaginationOptions.Builder	unlimitedItems()	Removes the maximum item limit.
AlpacaPaginationOptions.Builder	unlimitedPages()	Removes the maximum page limit.

Methods inherited from class java.lang.Object

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

Method Details

maxPages

public AlpacaPaginationOptions.Builder maxPages(int maxPages)

Sets the maximum number of pages to fetch.

unlimitedPages

public AlpacaPaginationOptions.Builder unlimitedPages()

Removes the maximum page limit.

maxItems

public AlpacaPaginationOptions.Builder maxItems(int maxItems)

Sets the maximum number of items to collect.

unlimitedItems

public AlpacaPaginationOptions.Builder unlimitedItems()

Removes the maximum item limit.

repeatedTokenAction

public AlpacaPaginationOptions.Builder repeatedTokenAction(AlpacaPaginationOptions.RepeatedTokenAction repeatedTokenAction)

Sets how repeated next-page tokens are handled.

build

public AlpacaPaginationOptions build()

Builds immutable pagination options.