public class LedgersRequestBuilder extends RequestBuilder
RequestBuilder.Order
Constructor and Description |
---|
LedgersRequestBuilder(okhttp3.OkHttpClient httpClient,
okhttp3.HttpUrl serverURI) |
Modifier and Type | Method and Description |
---|---|
LedgersRequestBuilder |
cursor(java.lang.String token)
Sets
cursor parameter on the request. |
Page<LedgerResponse> |
execute()
Build and execute request.
|
static Page<LedgerResponse> |
execute(okhttp3.OkHttpClient httpClient,
okhttp3.HttpUrl uri)
|
LedgerResponse |
ledger(okhttp3.HttpUrl uri)
Requests specific
uri and returns LedgerResponse . |
LedgerResponse |
ledger(long ledgerSeq)
Requests
GET /ledgers/{ledgerSeq} |
LedgersRequestBuilder |
limit(int number)
Sets
limit parameter on the request. |
LedgersRequestBuilder |
order(RequestBuilder.Order direction)
Sets
order parameter on the request. |
SSEStream<LedgerResponse> |
stream(EventListener<LedgerResponse> listener)
An overloaded version of
stream(EventListener, long) with default reconnect timeout. |
SSEStream<LedgerResponse> |
stream(EventListener<LedgerResponse> listener,
long reconnectTimeout)
Allows to stream SSE events from horizon.
|
setAssetParameter, setAssetsParameter
public LedgersRequestBuilder(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl serverURI)
public LedgerResponse ledger(okhttp3.HttpUrl uri)
uri
and returns LedgerResponse
. This method is helpful
for getting the links.LedgerResponse
NetworkException
- All the exceptions below are subclasses of
NetworkErrorBadRequestException
- if the request fails due to a bad request
(4xx)BadResponseException
- if the request fails due to a bad
response from the server (5xx)TooManyRequestsException
- if the request fails due to too many requests sent to the
serverRequestTimeoutException
- When Horizon returns a Timeout
or connection timeout occurredUnknownResponseException
- if the server returns an unknown
status codeConnectionErrorException
- When the request cannot be executed
due to cancellation or connectivity problems, etc.public LedgerResponse ledger(long ledgerSeq)
GET /ledgers/{ledgerSeq}
ledgerSeq
- Ledger to fetchLedgerResponse
NetworkException
- All the exceptions below are subclasses of
NetworkErrorBadRequestException
- if the request fails due to a bad request
(4xx)BadResponseException
- if the request fails due to a bad
response from the server (5xx)TooManyRequestsException
- if the request fails due to too many requests sent to the
serverRequestTimeoutException
- When Horizon returns a Timeout
or connection timeout occurredUnknownResponseException
- if the server returns an unknown
status codeConnectionErrorException
- When the request cannot be executed
due to cancellation or connectivity problems, etc.public static Page<LedgerResponse> execute(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl uri)
uri
and returns Page
of LedgerResponse
. This
method is helpful for getting the next set of results.httpClient
- OkHttpClient
to use to send the request.uri
- HttpUrl
URI to send the request to.Page
of LedgerResponse
NetworkException
- All the exceptions below are subclasses of
NetworkErrorBadRequestException
- if the request fails due to a bad request
(4xx)BadResponseException
- if the request fails due to a bad
response from the server (5xx)TooManyRequestsException
- if the request fails due to too many requests sent to the
serverRequestTimeoutException
- When Horizon returns a Timeout
or connection timeout occurredUnknownResponseException
- if the server returns an unknown
status codeConnectionErrorException
- When the request cannot be executed
due to cancellation or connectivity problems, etc.public SSEStream<LedgerResponse> stream(EventListener<LedgerResponse> listener, long reconnectTimeout)
listener
- EventListener
implementation with LedgerResponse
typereconnectTimeout
- Custom stream connection timeout in msclose()
connection when not needed anymorepublic SSEStream<LedgerResponse> stream(EventListener<LedgerResponse> listener)
stream(EventListener, long)
with default reconnect timeout.public Page<LedgerResponse> execute()
Page
of LedgerResponse
TooManyRequestsException
- when too many requests were sent to the Horizon server.ConnectionErrorException
- if the request fails due to an
IOException, including but not limited to a timeout, connection failure etc.public LedgersRequestBuilder cursor(java.lang.String token)
RequestBuilder
cursor
parameter on the request. A cursor is a value that points to a
specific location in a collection of resources. The cursor attribute itself is an opaque value
meaning that users should not try to parse it.cursor
in class RequestBuilder
token
- A cursor is a value that points to a specific location in a collection of
resources.public LedgersRequestBuilder limit(int number)
RequestBuilder
limit
parameter on the request. It defines maximum number of records to
return. For range and default values check documentation of the endpoint requested.limit
in class RequestBuilder
number
- maxium number of records to returnpublic LedgersRequestBuilder order(RequestBuilder.Order direction)
RequestBuilder
order
parameter on the request.order
in class RequestBuilder
direction
- RequestBuilder.Order