io.gate.gateapi.api

Class FuturesApi.APIlistFuturesOrdersRequest

java.lang.Object

io.gate.gateapi.api.FuturesApi.APIlistFuturesOrdersRequest

Enclosing class:

FuturesApi

public class FuturesApi.APIlistFuturesOrdersRequest
extends Object

Method Summary

Modifier and Type	Method and Description
okhttp3.Call	buildCall(ApiCallback _callback) Build call for listFuturesOrders
List<FuturesOrder>	execute() Execute listFuturesOrders request
okhttp3.Call	executeAsync(ApiCallback<List<FuturesOrder>> _callback) Execute listFuturesOrders request (asynchronously)
ApiResponse<List<FuturesOrder>>	executeWithHttpInfo() Execute listFuturesOrders request with HTTP info returned
FuturesApi.APIlistFuturesOrdersRequest	lastId(String lastId) Set lastId
FuturesApi.APIlistFuturesOrdersRequest	limit(Integer limit) Set limit
FuturesApi.APIlistFuturesOrdersRequest	offset(Integer offset) Set offset

Methods inherited from class java.lang.Object

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

Method Detail

limit

public FuturesApi.APIlistFuturesOrdersRequest limit(Integer limit)

Set limit

Parameters:

limit - Maximum number of records to be returned in a single list (optional, default to 100)

Returns:

APIlistFuturesOrdersRequest

offset

public FuturesApi.APIlistFuturesOrdersRequest offset(Integer offset)

Set offset

Parameters:

offset - List offset, starting from 0 (optional, default to 0)

Returns:

APIlistFuturesOrdersRequest

lastId

public FuturesApi.APIlistFuturesOrdersRequest lastId(String lastId)

Set lastId

Parameters:

lastId - Specify list staring point using the `id` of last record in previous list-query results (optional)

Returns:

APIlistFuturesOrdersRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listFuturesOrders

Parameters:

_callback - ApiCallback API callback

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	* X-Pagination-Limit - Request limit specified * X-Pagination-Offset - Request offset specified

execute

public List<FuturesOrder> execute()
                           throws ApiException

Execute listFuturesOrders request

Returns:

List<FuturesOrder>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	* X-Pagination-Limit - Request limit specified * X-Pagination-Offset - Request offset specified

executeWithHttpInfo

public ApiResponse<List<FuturesOrder>> executeWithHttpInfo()
                                                    throws ApiException

Execute listFuturesOrders request with HTTP info returned

Returns:

ApiResponse<List<FuturesOrder>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	* X-Pagination-Limit - Request limit specified * X-Pagination-Offset - Request offset specified

executeAsync

public okhttp3.Call executeAsync(ApiCallback<List<FuturesOrder>> _callback)
                          throws ApiException

Execute listFuturesOrders request (asynchronously)

Parameters:

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	* X-Pagination-Limit - Request limit specified * X-Pagination-Offset - Request offset specified