Package ai.reveng.api

Class AnalysesSecurityChecksApi

java.lang.Object

ai.reveng.api.AnalysesSecurityChecksApi

public class AnalysesSecurityChecksApi
extends Object

Constructor Summary

Constructors

Constructor	Description
AnalysesSecurityChecksApi()
AnalysesSecurityChecksApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
QueuedSecurityChecksTaskResponse	createScurityChecksTask(Integer analysisId)	Queues a security check process
okhttp3.Call	createScurityChecksTaskAsync(Integer analysisId, ApiCallback<QueuedSecurityChecksTaskResponse> _callback)	Queues a security check process (asynchronously)
okhttp3.Call	createScurityChecksTaskCall(Integer analysisId, ApiCallback _callback)	Build call for createScurityChecksTask
ApiResponse<QueuedSecurityChecksTaskResponse>	createScurityChecksTaskWithHttpInfo(Integer analysisId)	Queues a security check process
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
BaseResponseSecurityChecksResponse	getSecurityChecks(Integer analysisId, Integer page, Integer pageSize)	Get Security Checks Retrieve security checks results with pagination.
okhttp3.Call	getSecurityChecksAsync(Integer analysisId, Integer page, Integer pageSize, ApiCallback<BaseResponseSecurityChecksResponse> _callback)	Get Security Checks (asynchronously) Retrieve security checks results with pagination.
okhttp3.Call	getSecurityChecksCall(Integer analysisId, Integer page, Integer pageSize, ApiCallback _callback)	Build call for getSecurityChecks
CheckSecurityChecksTaskResponse	getSecurityChecksTaskStatus(Integer analysisId)	Check the status of a security check process
okhttp3.Call	getSecurityChecksTaskStatusAsync(Integer analysisId, ApiCallback<CheckSecurityChecksTaskResponse> _callback)	Check the status of a security check process (asynchronously)
okhttp3.Call	getSecurityChecksTaskStatusCall(Integer analysisId, ApiCallback _callback)	Build call for getSecurityChecksTaskStatus
ApiResponse<CheckSecurityChecksTaskResponse>	getSecurityChecksTaskStatusWithHttpInfo(Integer analysisId)	Check the status of a security check process
ApiResponse<BaseResponseSecurityChecksResponse>	getSecurityChecksWithHttpInfo(Integer analysisId, Integer page, Integer pageSize)	Get Security Checks Retrieve security checks results with pagination.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Details

AnalysesSecurityChecksApi

public AnalysesSecurityChecksApi()

AnalysesSecurityChecksApi

public AnalysesSecurityChecksApi(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)

createScurityChecksTaskCall

public okhttp3.Call createScurityChecksTaskCall(@Nonnull
 Integer analysisId,
 ApiCallback _callback)
                                         throws ApiException

Build call for createScurityChecksTask

Parameters:

analysisId - (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
202	Successful Response	-
422	Invalid request parameters	-
409	Security checks already extracted or queued	-

createScurityChecksTask

public QueuedSecurityChecksTaskResponse createScurityChecksTask(@Nonnull
 Integer analysisId)
                                                         throws ApiException

Queues a security check process

Parameters:

analysisId - (required)

Returns:

QueuedSecurityChecksTaskResponse

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
202	Successful Response	-
422	Invalid request parameters	-
409	Security checks already extracted or queued	-

createScurityChecksTaskWithHttpInfo

public ApiResponse<QueuedSecurityChecksTaskResponse> createScurityChecksTaskWithHttpInfo(@Nonnull
 Integer analysisId)
                                                                                  throws ApiException

Queues a security check process

Parameters:

analysisId - (required)

Returns:

ApiResponse<QueuedSecurityChecksTaskResponse>

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
202	Successful Response	-
422	Invalid request parameters	-
409	Security checks already extracted or queued	-

createScurityChecksTaskAsync

public okhttp3.Call createScurityChecksTaskAsync(@Nonnull
 Integer analysisId,
 ApiCallback<QueuedSecurityChecksTaskResponse> _callback)
                                          throws ApiException

Queues a security check process (asynchronously)

Parameters:

analysisId - (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
202	Successful Response	-
422	Invalid request parameters	-
409	Security checks already extracted or queued	-

getSecurityChecksCall

public okhttp3.Call getSecurityChecksCall(@Nonnull
 Integer analysisId,
 @Nonnull
 Integer page,
 @Nonnull
 Integer pageSize,
 ApiCallback _callback)
                                   throws ApiException

Build call for getSecurityChecks

Parameters:

analysisId - (required)

page - The page number to retrieve. (required)

pageSize - Number of items per page. (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	-

getSecurityChecks

public BaseResponseSecurityChecksResponse getSecurityChecks(@Nonnull
 Integer analysisId,
 @Nonnull
 Integer page,
 @Nonnull
 Integer pageSize)
                                                     throws ApiException

Get Security Checks Retrieve security checks results with pagination.

Parameters:

analysisId - (required)

page - The page number to retrieve. (required)

pageSize - Number of items per page. (required)

Returns:

BaseResponseSecurityChecksResponse

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	-

getSecurityChecksWithHttpInfo

public ApiResponse<BaseResponseSecurityChecksResponse> getSecurityChecksWithHttpInfo(@Nonnull
 Integer analysisId,
 @Nonnull
 Integer page,
 @Nonnull
 Integer pageSize)
                                                                              throws ApiException

Get Security Checks Retrieve security checks results with pagination.

Parameters:

analysisId - (required)

page - The page number to retrieve. (required)

pageSize - Number of items per page. (required)

Returns:

ApiResponse<BaseResponseSecurityChecksResponse>

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	-

getSecurityChecksAsync

public okhttp3.Call getSecurityChecksAsync(@Nonnull
 Integer analysisId,
 @Nonnull
 Integer page,
 @Nonnull
 Integer pageSize,
 ApiCallback<BaseResponseSecurityChecksResponse> _callback)
                                    throws ApiException

Get Security Checks (asynchronously) Retrieve security checks results with pagination.

Parameters:

analysisId - (required)

page - The page number to retrieve. (required)

pageSize - Number of items per page. (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	-

getSecurityChecksTaskStatusCall

public okhttp3.Call getSecurityChecksTaskStatusCall(@Nonnull
 Integer analysisId,
 ApiCallback _callback)
                                             throws ApiException

Build call for getSecurityChecksTaskStatus

Parameters:

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

getSecurityChecksTaskStatus

public CheckSecurityChecksTaskResponse getSecurityChecksTaskStatus(@Nonnull
 Integer analysisId)
                                                            throws ApiException

Check the status of a security check process

Parameters:

analysisId - (required)

Returns:

CheckSecurityChecksTaskResponse

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	-

getSecurityChecksTaskStatusWithHttpInfo

public ApiResponse<CheckSecurityChecksTaskResponse> getSecurityChecksTaskStatusWithHttpInfo(@Nonnull
 Integer analysisId)
                                                                                     throws ApiException

Check the status of a security check process

Parameters:

analysisId - (required)

Returns:

ApiResponse<CheckSecurityChecksTaskResponse>

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	-

getSecurityChecksTaskStatusAsync

public okhttp3.Call getSecurityChecksTaskStatusAsync(@Nonnull
 Integer analysisId,
 ApiCallback<CheckSecurityChecksTaskResponse> _callback)
                                              throws ApiException

Check the status of a security check process (asynchronously)

Parameters:

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