org.stellar.sdk.requests

Class AssetsRequestBuilder

java.lang.Object

org.stellar.sdk.requests.RequestBuilder

org.stellar.sdk.requests.AssetsRequestBuilder

public class AssetsRequestBuilder
extends RequestBuilder

Nested Class Summary

Nested classes/interfaces inherited from class org.stellar.sdk.requests.RequestBuilder

RequestBuilder.Order

Constructor Summary

Constructors

Constructor and Description
AssetsRequestBuilder(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl serverURI)

Method Summary

Modifier and Type	Method and Description
AssetsRequestBuilder	assetCode(java.lang.String assetCode)
AssetsRequestBuilder	assetIssuer(java.lang.String assetIssuer)
AssetsRequestBuilder	cursor(java.lang.String token) Sets cursor parameter on the request.
Page<AssetResponse>	execute() Build and execute request.
static Page<AssetResponse>	execute(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl uri) Requests specific uri and returns Page of AssetResponse.
AssetsRequestBuilder	limit(int number) Sets limit parameter on the request.
AssetsRequestBuilder	order(RequestBuilder.Order direction) Sets order parameter on the request.

Methods inherited from class org.stellar.sdk.requests.RequestBuilder

setAssetParameter, setAssetsParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetsRequestBuilder

public AssetsRequestBuilder(okhttp3.OkHttpClient httpClient,
                            okhttp3.HttpUrl serverURI)

Method Detail

assetCode

public AssetsRequestBuilder assetCode(java.lang.String assetCode)

assetIssuer

public AssetsRequestBuilder assetIssuer(java.lang.String assetIssuer)

execute

public static Page<AssetResponse> execute(okhttp3.OkHttpClient httpClient,
                                          okhttp3.HttpUrl uri)

Requests specific uri and returns Page of AssetResponse. This * method is helpful for getting the next set of results.

Parameters:

httpClient - OkHttpClient to use to send the request.

uri - HttpUrl URI to send the request to.

Returns:

Page of AssetResponse

Throws:

NetworkException - All the exceptions below are subclasses of NetworkError

BadRequestException - 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 server

RequestTimeoutException - When Horizon returns a Timeout or connection timeout occurred

UnknownResponseException - if the server returns an unknown status code

ConnectionErrorException - When the request cannot be executed due to cancellation or connectivity problems, etc.

execute

public Page<AssetResponse> execute()

Build and execute request.

Returns:

Page of AssetResponse

Throws:

NetworkException - All the exceptions below are subclasses of NetworkError

BadRequestException - 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 server

RequestTimeoutException - When Horizon returns a Timeout or connection timeout occurred

UnknownResponseException - if the server returns an unknown status code

ConnectionErrorException - When the request cannot be executed due to cancellation or connectivity problems, etc.

cursor

public AssetsRequestBuilder cursor(java.lang.String token)

Description copied from class: RequestBuilder

Sets 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.

Overrides:

cursor in class RequestBuilder

Parameters:

token - A cursor is a value that points to a specific location in a collection of resources.

See Also:

Page documentation

limit

public AssetsRequestBuilder limit(int number)

Description copied from class: RequestBuilder

Sets limit parameter on the request. It defines maximum number of records to return. For range and default values check documentation of the endpoint requested.

Overrides:

limit in class RequestBuilder

Parameters:

number - maxium number of records to return

order

public AssetsRequestBuilder order(RequestBuilder.Order direction)

Description copied from class: RequestBuilder

Sets order parameter on the request.

Overrides:

order in class RequestBuilder

Parameters:

direction - RequestBuilder.Order