public class EffectsRequestBuilder extends RequestBuilder
RequestBuilder.Order
Constructor and Description |
---|
EffectsRequestBuilder(OkHttpClient httpClient,
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(OkHttpClient httpClient,
HttpUrl uri)
|
EffectsRequestBuilder |
forAccount(KeyPair account)
Builds request to
GET /accounts/{account}/effects |
EffectsRequestBuilder |
forLedger(long ledgerSeq)
Builds request to
GET /ledgers/{ledgerSeq}/effects |
EffectsRequestBuilder |
forOperation(long operationId)
Builds request to
GET /operation/{operationId}/effects |
EffectsRequestBuilder |
forTransaction(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. |
EventSource |
stream(EventListener<EffectResponse> listener)
Allows to stream SSE events from horizon.
|
public EffectsRequestBuilder(OkHttpClient httpClient, HttpUrl serverURI)
public EffectsRequestBuilder forAccount(KeyPair 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(java.lang.String transactionId)
GET /transactions/{transactionId}/effects
transactionId
- Transaction ID 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(OkHttpClient httpClient, HttpUrl uri) throws java.io.IOException, TooManyRequestsException
uri
and returns Page
of EffectResponse
.
This method is helpful for getting the next set of results.Page
of EffectResponse
TooManyRequestsException
- when too many requests were sent to the Horizon server.java.io.IOException
public EventSource stream(EventListener<EffectResponse> listener)
listener
- EventListener
implementation with EffectResponse
typeclose()
connection when not needed anymorepublic Page<EffectResponse> execute() throws java.io.IOException, TooManyRequestsException
Page
of EffectResponse
TooManyRequestsException
- when too many requests were sent to the Horizon server.java.io.IOException
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
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