de.irisnet.java.client

Class MiscellaneousOperationsApi

java.lang.Object

de.irisnet.java.client.MiscellaneousOperationsApi

public class MiscellaneousOperationsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
MiscellaneousOperationsApi()
MiscellaneousOperationsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
File	downloadProcessed(String filename) Get the resulting media file.
okhttp3.Call	downloadProcessedAsync(String filename, ApiCallback<File> _callback) Get the resulting media file.
okhttp3.Call	downloadProcessedCall(String filename, ApiCallback _callback) Build call for downloadProcessed
ApiResponse<File>	downloadProcessedWithHttpInfo(String filename) Get the resulting media file.
Long	getAICost() Get the cost per image check of the previously set parameters.
okhttp3.Call	getAICostAsync(ApiCallback<Long> _callback) Get the cost per image check of the previously set parameters.
okhttp3.Call	getAICostCall(ApiCallback _callback) Build call for getAICost
ApiResponse<Long>	getAICostWithHttpInfo() Get the cost per image check of the previously set parameters.
ApiClient	getApiClient()
LicenseInfo	getLicenseInfo(String licenseKey) Get information from given license key.
okhttp3.Call	getLicenseInfoAsync(String licenseKey, ApiCallback<LicenseInfo> _callback) Get information from given license key.
okhttp3.Call	getLicenseInfoCall(String licenseKey, ApiCallback _callback) Build call for getLicenseInfo
ApiResponse<LicenseInfo>	getLicenseInfoWithHttpInfo(String licenseKey) Get information from given license key.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

MiscellaneousOperationsApi

public MiscellaneousOperationsApi()

MiscellaneousOperationsApi

public MiscellaneousOperationsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

downloadProcessedCall

public okhttp3.Call downloadProcessedCall(String filename,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for downloadProcessed

Parameters:

filename - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Returns the file AI produced file with masking or blurring, depending on given AI parameters.	-
404	Specified file was not found.	-

downloadProcessed

public File downloadProcessed(String filename)
                       throws ApiException

Get the resulting media file.

Parameters:

filename - (required)

Returns:

File

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	Returns the file AI produced file with masking or blurring, depending on given AI parameters.	-
404	Specified file was not found.	-

downloadProcessedWithHttpInfo

public ApiResponse<File> downloadProcessedWithHttpInfo(String filename)
                                                throws ApiException

Get the resulting media file.

Parameters:

filename - (required)

Returns:

ApiResponse<File>

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	Returns the file AI produced file with masking or blurring, depending on given AI parameters.	-
404	Specified file was not found.	-

downloadProcessedAsync

public okhttp3.Call downloadProcessedAsync(String filename,
                                           ApiCallback<File> _callback)
                                    throws ApiException

Get the resulting media file. (asynchronously)

Parameters:

filename - (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:

Status Code	Description	Response Headers
200	Returns the file AI produced file with masking or blurring, depending on given AI parameters.	-
404	Specified file was not found.	-

getAICostCall

public okhttp3.Call getAICostCall(ApiCallback _callback)
                           throws ApiException

Build call for getAICost

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
429	The ai could not handle the request because it is either overloaded or currently down for maintenance. This is a temporary state. A 'Retry-After' Header is included in the response to signal the client to retry after a certain amount of seconds.	-
200	Contains the cost of the AI check with the current set of parameters.	-

getAICost

public Long getAICost()
               throws ApiException

Get the cost per image check of the previously set parameters. The cost of the configuration is subtracted from the license key during each check.

Returns:

Long

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
429	The ai could not handle the request because it is either overloaded or currently down for maintenance. This is a temporary state. A 'Retry-After' Header is included in the response to signal the client to retry after a certain amount of seconds.	-
200	Contains the cost of the AI check with the current set of parameters.	-

getAICostWithHttpInfo

public ApiResponse<Long> getAICostWithHttpInfo()
                                        throws ApiException

Get the cost per image check of the previously set parameters. The cost of the configuration is subtracted from the license key during each check.

Returns:

ApiResponse<Long>

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
429	The ai could not handle the request because it is either overloaded or currently down for maintenance. This is a temporary state. A 'Retry-After' Header is included in the response to signal the client to retry after a certain amount of seconds.	-
200	Contains the cost of the AI check with the current set of parameters.	-

getAICostAsync

public okhttp3.Call getAICostAsync(ApiCallback<Long> _callback)
                            throws ApiException

Get the cost per image check of the previously set parameters. The cost of the configuration is subtracted from the license key during each check. (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
429	The ai could not handle the request because it is either overloaded or currently down for maintenance. This is a temporary state. A 'Retry-After' Header is included in the response to signal the client to retry after a certain amount of seconds.	-
200	Contains the cost of the AI check with the current set of parameters.	-

getLicenseInfoCall

public okhttp3.Call getLicenseInfoCall(String licenseKey,
                                       ApiCallback _callback)
                                throws ApiException

Build call for getLicenseInfo

Parameters:

licenseKey - License obtained from the https://irisnet.de/subscribe shop. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	successful operation	-
404	The entered license key was not found.	-

getLicenseInfo

public LicenseInfo getLicenseInfo(String licenseKey)
                           throws ApiException

Get information from given license key.

Parameters:

licenseKey - License obtained from the https://irisnet.de/subscribe shop. (required)

Returns:

LicenseInfo

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	successful operation	-
404	The entered license key was not found.	-

getLicenseInfoWithHttpInfo

public ApiResponse<LicenseInfo> getLicenseInfoWithHttpInfo(String licenseKey)
                                                    throws ApiException

Get information from given license key.

Parameters:

licenseKey - License obtained from the https://irisnet.de/subscribe shop. (required)

Returns:

ApiResponse<LicenseInfo>

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	successful operation	-
404	The entered license key was not found.	-

getLicenseInfoAsync

public okhttp3.Call getLicenseInfoAsync(String licenseKey,
                                        ApiCallback<LicenseInfo> _callback)
                                 throws ApiException

Get information from given license key. (asynchronously)

Parameters:

licenseKey - License obtained from the https://irisnet.de/subscribe shop. (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:

Status Code	Description	Response Headers
200	successful operation	-
404	The entered license key was not found.	-