io.swagger.client.api

Class TasksApi

java.lang.Object

io.swagger.client.api.TasksApi

public class TasksApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TasksApi()
TasksApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
List<Export>	tasksGet(String type, Integer limit, Integer offset) Returns a list of all background tasks data.
com.squareup.okhttp.Call	tasksGetAsync(String type, Integer limit, Integer offset, ApiCallback<List<Export>> callback) Returns a list of all background tasks data.
com.squareup.okhttp.Call	tasksGetCall(String type, Integer limit, Integer offset, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for tasksGet
ApiResponse<List<Export>>	tasksGetWithHttpInfo(String type, Integer limit, Integer offset) Returns a list of all background tasks data.
void	tasksIdDelete(String id) Delete the specified background task.
com.squareup.okhttp.Call	tasksIdDeleteAsync(String id, ApiCallback<Void> callback) Delete the specified background task.
com.squareup.okhttp.Call	tasksIdDeleteCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for tasksIdDelete
ApiResponse<Void>	tasksIdDeleteWithHttpInfo(String id) Delete the specified background task.
String	tasksIdStatusGet(String id) Check the current status of the background task.
com.squareup.okhttp.Call	tasksIdStatusGetAsync(String id, ApiCallback<String> callback) Check the current status of the background task.
com.squareup.okhttp.Call	tasksIdStatusGetCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for tasksIdStatusGet
ApiResponse<String>	tasksIdStatusGetWithHttpInfo(String id) Check the current status of the background task.

Methods inherited from class java.lang.Object

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

Constructor Detail

TasksApi

public TasksApi()

TasksApi

public TasksApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

tasksGetCall

public com.squareup.okhttp.Call tasksGetCall(String type,
                                             Integer limit,
                                             Integer offset,
                                             ProgressResponseBody.ProgressListener progressListener,
                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                      throws ApiException

Build call for tasksGet

Parameters:

type - (required)

limit - Maximum of loaded items. (optional, default to 0)

offset - How many items should be loaded ahead. (optional, default to 0)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

tasksGet

public List<Export> tasksGet(String type,
                             Integer limit,
                             Integer offset)
                      throws ApiException

Returns a list of all background tasks data.

Parameters:

type - (required)

limit - Maximum of loaded items. (optional, default to 0)

offset - How many items should be loaded ahead. (optional, default to 0)

Returns:

List<Export>

Throws:

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

tasksGetWithHttpInfo

public ApiResponse<List<Export>> tasksGetWithHttpInfo(String type,
                                                      Integer limit,
                                                      Integer offset)
                                               throws ApiException

Returns a list of all background tasks data.

Parameters:

type - (required)

limit - Maximum of loaded items. (optional, default to 0)

offset - How many items should be loaded ahead. (optional, default to 0)

Returns:

ApiResponse<List<Export>>

Throws:

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

tasksGetAsync

public com.squareup.okhttp.Call tasksGetAsync(String type,
                                              Integer limit,
                                              Integer offset,
                                              ApiCallback<List<Export>> callback)
                                       throws ApiException

Returns a list of all background tasks data. (asynchronously)

Parameters:

type - (required)

limit - Maximum of loaded items. (optional, default to 0)

offset - How many items should be loaded ahead. (optional, default to 0)

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

tasksIdDeleteCall

public com.squareup.okhttp.Call tasksIdDeleteCall(String id,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for tasksIdDelete

Parameters:

id - ID of the exported file (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

tasksIdDelete

public void tasksIdDelete(String id)
                   throws ApiException

Delete the specified background task.

Parameters:

id - ID of the exported file (required)

Throws:

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

tasksIdDeleteWithHttpInfo

public ApiResponse<Void> tasksIdDeleteWithHttpInfo(String id)
                                            throws ApiException

Delete the specified background task.

Parameters:

id - ID of the exported file (required)

Returns:

ApiResponse<Void>

Throws:

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

tasksIdDeleteAsync

public com.squareup.okhttp.Call tasksIdDeleteAsync(String id,
                                                   ApiCallback<Void> callback)
                                            throws ApiException

Delete the specified background task. (asynchronously)

Parameters:

id - ID of the exported file (required)

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

tasksIdStatusGetCall

public com.squareup.okhttp.Call tasksIdStatusGetCall(String id,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for tasksIdStatusGet

Parameters:

id - ID of the exported file (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

tasksIdStatusGet

public String tasksIdStatusGet(String id)
                        throws ApiException

Check the current status of the background task.

Parameters:

id - ID of the exported file (required)

Returns:

String

Throws:

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

tasksIdStatusGetWithHttpInfo

public ApiResponse<String> tasksIdStatusGetWithHttpInfo(String id)
                                                 throws ApiException

Check the current status of the background task.

Parameters:

id - ID of the exported file (required)

Returns:

ApiResponse<String>

Throws:

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

tasksIdStatusGetAsync

public com.squareup.okhttp.Call tasksIdStatusGetAsync(String id,
                                                      ApiCallback<String> callback)
                                               throws ApiException

Check the current status of the background task. (asynchronously)

Parameters:

id - ID of the exported file (required)

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