Package ai.reveng.api

Class FirmwareApi

java.lang.Object

ai.reveng.api.FirmwareApi

public class FirmwareApi
extends Object

Constructor Summary

Constructors

Constructor	Description
FirmwareApi()
FirmwareApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
Object	getBinariesForFirmwareTask(String taskId)	Upload firmware for unpacking Uploads a firmware file and begins a 'Firmware Unpacker' task.
okhttp3.Call	getBinariesForFirmwareTaskAsync(String taskId, ApiCallback<Object> _callback)	Upload firmware for unpacking (asynchronously) Uploads a firmware file and begins a 'Firmware Unpacker' task.
okhttp3.Call	getBinariesForFirmwareTaskCall(String taskId, ApiCallback _callback)	Build call for getBinariesForFirmwareTask
ApiResponse<Object>	getBinariesForFirmwareTaskWithHttpInfo(String taskId)	Upload firmware for unpacking Uploads a firmware file and begins a 'Firmware Unpacker' task.
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
Object	uploadFirmware(File _file, String password)	Upload firmware for unpacking Uploads a firmware file and begins a 'Firmware Unpacker' task.
okhttp3.Call	uploadFirmwareAsync(File _file, String password, ApiCallback<Object> _callback)	Upload firmware for unpacking (asynchronously) Uploads a firmware file and begins a 'Firmware Unpacker' task.
okhttp3.Call	uploadFirmwareCall(File _file, String password, ApiCallback _callback)	Build call for uploadFirmware
ApiResponse<Object>	uploadFirmwareWithHttpInfo(File _file, String password)	Upload firmware for unpacking Uploads a firmware file and begins a 'Firmware Unpacker' task.

Methods inherited from class java.lang.Object

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

Constructor Details

FirmwareApi

public FirmwareApi()

FirmwareApi

public FirmwareApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

getBinariesForFirmwareTaskCall

public okhttp3.Call getBinariesForFirmwareTaskCall(@Nonnull
 String taskId,
 ApiCallback _callback)
                                            throws ApiException

Build call for getBinariesForFirmwareTask

Parameters:

taskId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

getBinariesForFirmwareTask

public Object getBinariesForFirmwareTask(@Nonnull
 String taskId)
                                  throws ApiException

Upload firmware for unpacking Uploads a firmware file and begins a 'Firmware Unpacker' task. Returns a result identifier, which can be used to poll for the response.

Parameters:

taskId - (required)

Returns:

Object

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

getBinariesForFirmwareTaskWithHttpInfo

public ApiResponse<Object> getBinariesForFirmwareTaskWithHttpInfo(@Nonnull
 String taskId)
                                                           throws ApiException

Upload firmware for unpacking Uploads a firmware file and begins a 'Firmware Unpacker' task. Returns a result identifier, which can be used to poll for the response.

Parameters:

taskId - (required)

Returns:

ApiResponse<Object>

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

getBinariesForFirmwareTaskAsync

public okhttp3.Call getBinariesForFirmwareTaskAsync(@Nonnull
 String taskId,
 ApiCallback<Object> _callback)
                                             throws ApiException

Upload firmware for unpacking (asynchronously) Uploads a firmware file and begins a 'Firmware Unpacker' task. Returns a result identifier, which can be used to poll for the response.

Parameters:

taskId - (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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

uploadFirmwareCall

public okhttp3.Call uploadFirmwareCall(@Nonnull
 File _file,
 @Nullable
 String password,
 ApiCallback _callback)
                                throws ApiException

Build call for uploadFirmware

Parameters:

_file - (required)

password - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
201	Successful Response	-
422	Unprocessable Entity	-
500	Internal Server Error	-

uploadFirmware

public Object uploadFirmware(@Nonnull
 File _file,
 @Nullable
 String password)
                      throws ApiException

Upload firmware for unpacking Uploads a firmware file and begins a 'Firmware Unpacker' task. Returns a result identifier, which can be used to poll for the response.

Parameters:

_file - (required)

password - (optional)

Returns:

Object

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
201	Successful Response	-
422	Unprocessable Entity	-
500	Internal Server Error	-

uploadFirmwareWithHttpInfo

public ApiResponse<Object> uploadFirmwareWithHttpInfo(@Nonnull
 File _file,
 @Nullable
 String password)
                                               throws ApiException

Upload firmware for unpacking Uploads a firmware file and begins a 'Firmware Unpacker' task. Returns a result identifier, which can be used to poll for the response.

Parameters:

_file - (required)

password - (optional)

Returns:

ApiResponse<Object>

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
201	Successful Response	-
422	Unprocessable Entity	-
500	Internal Server Error	-

uploadFirmwareAsync

public okhttp3.Call uploadFirmwareAsync(@Nonnull
 File _file,
 @Nullable
 String password,
 ApiCallback<Object> _callback)
                                 throws ApiException

Upload firmware for unpacking (asynchronously) Uploads a firmware file and begins a 'Firmware Unpacker' task. Returns a result identifier, which can be used to poll for the response.

Parameters:

_file - (required)

password - (optional)

_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

Response Details

Status Code	Description	Response Headers
201	Successful Response	-
422	Unprocessable Entity	-
500	Internal Server Error	-