de.irisnet.java.client

Class EndpointsForAiChecksApi

java.lang.Object

de.irisnet.java.client.EndpointsForAiChecksApi

public class EndpointsForAiChecksApi
extends Object

Constructor Summary

Constructors

Constructor and Description
EndpointsForAiChecksApi()
EndpointsForAiChecksApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
IrisNet	checkImage(String licenseKey, File file, Integer detail, Boolean imageEncode) Upload and check image against previously chosen configuration.
okhttp3.Call	checkImageAsync(String licenseKey, File file, Integer detail, Boolean imageEncode, ApiCallback<IrisNet> _callback) Upload and check image against previously chosen configuration.
okhttp3.Call	checkImageCall(String licenseKey, File file, Integer detail, Boolean imageEncode, ApiCallback _callback) Build call for checkImage
IrisNet	checkImageUrl(String url, String licenseKey, Integer detail, Boolean imageEncode) Check image url against previously chosen configuration.
okhttp3.Call	checkImageUrlAsync(String url, String licenseKey, Integer detail, Boolean imageEncode, ApiCallback<IrisNet> _callback) Check image url against previously chosen configuration.
okhttp3.Call	checkImageUrlCall(String url, String licenseKey, Integer detail, Boolean imageEncode, ApiCallback _callback) Build call for checkImageUrl
ApiResponse<IrisNet>	checkImageUrlWithHttpInfo(String url, String licenseKey, Integer detail, Boolean imageEncode) Check image url against previously chosen configuration.
ApiResponse<IrisNet>	checkImageWithHttpInfo(String licenseKey, File file, Integer detail, Boolean imageEncode) Upload and check image against previously chosen configuration.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointsForAiChecksApi

public EndpointsForAiChecksApi()

EndpointsForAiChecksApi

public EndpointsForAiChecksApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

checkImageCall

public okhttp3.Call checkImageCall(String licenseKey,
                                   File file,
                                   Integer detail,
                                   Boolean imageEncode,
                                   ApiCallback _callback)
                            throws ApiException

Build call for checkImage

Parameters:

licenseKey - License obtained from irisnet.de shop. (required)

file - (required)

detail - Sets the response details. * _1_ - The response body informs you if the image is ok or not ok (better API performance) * _2_ - In addition the response body lists all broken rules. * _3_ - In addition to the first two options, this will show all objects with positional information. (optional, default to 1)

imageEncode - Specifies whether or not to draw an output image that can be downloaded afterwards. (optional, default to false)

_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	-
402	Not enough credits	-

checkImage

public IrisNet checkImage(String licenseKey,
                          File file,
                          Integer detail,
                          Boolean imageEncode)
                   throws ApiException

Upload and check image against previously chosen configuration.

Parameters:

licenseKey - License obtained from irisnet.de shop. (required)

file - (required)

detail - Sets the response details. * _1_ - The response body informs you if the image is ok or not ok (better API performance) * _2_ - In addition the response body lists all broken rules. * _3_ - In addition to the first two options, this will show all objects with positional information. (optional, default to 1)

imageEncode - Specifies whether or not to draw an output image that can be downloaded afterwards. (optional, default to false)

Returns:

IrisNet

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	-
402	Not enough credits	-

checkImageWithHttpInfo

public ApiResponse<IrisNet> checkImageWithHttpInfo(String licenseKey,
                                                   File file,
                                                   Integer detail,
                                                   Boolean imageEncode)
                                            throws ApiException

Upload and check image against previously chosen configuration.

Parameters:

licenseKey - License obtained from irisnet.de shop. (required)

file - (required)

detail - Sets the response details. * _1_ - The response body informs you if the image is ok or not ok (better API performance) * _2_ - In addition the response body lists all broken rules. * _3_ - In addition to the first two options, this will show all objects with positional information. (optional, default to 1)

imageEncode - Specifies whether or not to draw an output image that can be downloaded afterwards. (optional, default to false)

Returns:

ApiResponse<IrisNet>

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	-
402	Not enough credits	-

checkImageAsync

public okhttp3.Call checkImageAsync(String licenseKey,
                                    File file,
                                    Integer detail,
                                    Boolean imageEncode,
                                    ApiCallback<IrisNet> _callback)
                             throws ApiException

Upload and check image against previously chosen configuration. (asynchronously)

Parameters:

licenseKey - License obtained from irisnet.de shop. (required)

file - (required)

detail - Sets the response details. * _1_ - The response body informs you if the image is ok or not ok (better API performance) * _2_ - In addition the response body lists all broken rules. * _3_ - In addition to the first two options, this will show all objects with positional information. (optional, default to 1)

imageEncode - Specifies whether or not to draw an output image that can be downloaded afterwards. (optional, default to false)

_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	-
402	Not enough credits	-

checkImageUrlCall

public okhttp3.Call checkImageUrlCall(String url,
                                      String licenseKey,
                                      Integer detail,
                                      Boolean imageEncode,
                                      ApiCallback _callback)
                               throws ApiException

Build call for checkImageUrl

Parameters:

url - (required)

licenseKey - License obtained from irisnet.de shop. (required)

detail - Sets the response details. * _1_ - The response body informs you if the image is ok or not ok (better API performance) * _2_ - In addition the response body lists all broken rules. * _3_ - In addition to the first two options, this will show all objects with positional information. (optional, default to 1)

imageEncode - Specifies whether or not to draw an output image that can be downloaded afterwards. (optional, default to false)

_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	-
402	Not enough credits	-

checkImageUrl

public IrisNet checkImageUrl(String url,
                             String licenseKey,
                             Integer detail,
                             Boolean imageEncode)
                      throws ApiException

Check image url against previously chosen configuration.

Parameters:

url - (required)

licenseKey - License obtained from irisnet.de shop. (required)

detail - Sets the response details. * _1_ - The response body informs you if the image is ok or not ok (better API performance) * _2_ - In addition the response body lists all broken rules. * _3_ - In addition to the first two options, this will show all objects with positional information. (optional, default to 1)

imageEncode - Specifies whether or not to draw an output image that can be downloaded afterwards. (optional, default to false)

Returns:

IrisNet

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	-
402	Not enough credits	-

checkImageUrlWithHttpInfo

public ApiResponse<IrisNet> checkImageUrlWithHttpInfo(String url,
                                                      String licenseKey,
                                                      Integer detail,
                                                      Boolean imageEncode)
                                               throws ApiException

Check image url against previously chosen configuration.

Parameters:

url - (required)

licenseKey - License obtained from irisnet.de shop. (required)

detail - Sets the response details. * _1_ - The response body informs you if the image is ok or not ok (better API performance) * _2_ - In addition the response body lists all broken rules. * _3_ - In addition to the first two options, this will show all objects with positional information. (optional, default to 1)

imageEncode - Specifies whether or not to draw an output image that can be downloaded afterwards. (optional, default to false)

Returns:

ApiResponse<IrisNet>

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	-
402	Not enough credits	-

checkImageUrlAsync

public okhttp3.Call checkImageUrlAsync(String url,
                                       String licenseKey,
                                       Integer detail,
                                       Boolean imageEncode,
                                       ApiCallback<IrisNet> _callback)
                                throws ApiException

Check image url against previously chosen configuration. (asynchronously)

Parameters:

url - (required)

licenseKey - License obtained from irisnet.de shop. (required)

detail - Sets the response details. * _1_ - The response body informs you if the image is ok or not ok (better API performance) * _2_ - In addition the response body lists all broken rules. * _3_ - In addition to the first two options, this will show all objects with positional information. (optional, default to 1)

imageEncode - Specifies whether or not to draw an output image that can be downloaded afterwards. (optional, default to false)

_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	-
402	Not enough credits	-