public class EffectsRequestBuilder extends RequestBuilder
RequestBuilder.Order
Constructor and Description |
---|
EffectsRequestBuilder(okhttp3.OkHttpClient httpClient,
okhttp3.HttpUrl serverURI) |
Modifier and Type | Method and Description |
---|---|
EffectsRequestBuilder |
cursor(java.lang.String token)
Sets
cursor parameter on the request. |
Page<EffectResponse> |
execute()
Build and execute request.
|
static Page<EffectResponse> |
execute(okhttp3.OkHttpClient httpClient,
okhttp3.HttpUrl uri)
|
EffectsRequestBuilder |
forAccount(@NonNull java.lang.String account)
Builds request to
GET /accounts/{account}/effects |
EffectsRequestBuilder |
forLedger(long ledgerSeq)
Builds request to
GET /ledgers/{ledgerSeq}/effects |
EffectsRequestBuilder |
forLiquidityPool(java.lang.String liquidityPoolId)
Builds request to
GET /liquidity_pools/{poolID}/effects |
EffectsRequestBuilder |
forOperation(long operationId)
Builds request to
GET /operation/{operationId}/effects |
EffectsRequestBuilder |
forTransaction(@NonNull java.lang.String transactionId)
Builds request to
GET /transactions/{transactionId}/effects |
EffectsRequestBuilder |
limit(int number)
Sets
limit parameter on the request. |
EffectsRequestBuilder |
order(RequestBuilder.Order direction)
Sets
order parameter on the request. |
SSEStream<EffectResponse> |
stream(EventListener<EffectResponse> listener)
An overloaded version of
stream(EventListener, long) with default reconnect timeout. |
SSEStream<EffectResponse> |
stream(EventListener<EffectResponse> listener,
long reconnectTimeout)
Allows to stream SSE events from horizon.
|
setAssetParameter, setAssetsParameter
public EffectsRequestBuilder(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl serverURI)
public EffectsRequestBuilder forAccount(@NonNull @NonNull java.lang.String account)
GET /accounts/{account}/effects
account
- Account for which to get effectspublic EffectsRequestBuilder forLedger(long ledgerSeq)
GET /ledgers/{ledgerSeq}/effects
ledgerSeq
- Ledger for which to get effectspublic EffectsRequestBuilder forTransaction(@NonNull @NonNull java.lang.String transactionId)
GET /transactions/{transactionId}/effects
transactionId
- Transaction ID for which to get effectspublic EffectsRequestBuilder forLiquidityPool(java.lang.String liquidityPoolId)
GET /liquidity_pools/{poolID}/effects
liquidityPoolId
- Liquidity pool for which to get effectspublic EffectsRequestBuilder forOperation(long operationId)
GET /operation/{operationId}/effects
operationId
- Operation ID for which to get effectspublic static Page<EffectResponse> execute(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl uri)
uri
and returns Page
of EffectResponse
. 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 EffectResponse
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<EffectResponse> stream(EventListener<EffectResponse> listener, long reconnectTimeout)
listener
- EventListener
implementation with EffectResponse
typereconnectTimeout
- Custom stream connection timeout in msclose()
connection when not needed anymorepublic SSEStream<EffectResponse> stream(EventListener<EffectResponse> listener)
stream(EventListener, long)
with default reconnect timeout.public Page<EffectResponse> execute()
Page
of EffectResponse
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 EffectsRequestBuilder 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 EffectsRequestBuilder 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 EffectsRequestBuilder order(RequestBuilder.Order direction)
RequestBuilder
order
parameter on the request.order
in class RequestBuilder
direction
- RequestBuilder.Order