com.codedx.client.api

Class FindingDataMaintenanceApi

java.lang.Object

com.codedx.client.api.FindingDataMaintenanceApi

public class FindingDataMaintenanceApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
FindingDataMaintenanceApi()
FindingDataMaintenanceApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
DisabledToolResultsCount	getDisabledToolResultCount(java.lang.Integer projectId) Disabled Tool Result Count Query Returns a count of disabled findings present within a project.
com.squareup.okhttp.Call	getDisabledToolResultCountAsync(java.lang.Integer projectId, ApiCallback<DisabledToolResultsCount> callback) Disabled Tool Result Count Query (asynchronously) Returns a count of disabled findings present within a project.
com.squareup.okhttp.Call	getDisabledToolResultCountCall(java.lang.Integer projectId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getDisabledToolResultCount
ApiResponse<DisabledToolResultsCount>	getDisabledToolResultCountWithHttpInfo(java.lang.Integer projectId) Disabled Tool Result Count Query Returns a count of disabled findings present within a project.
void	purgeDisabledToolResults(java.lang.Integer projectId) Purge Disabled Tool Results Executes a purge/cleanup operation on the finding data for the project.
com.squareup.okhttp.Call	purgeDisabledToolResultsAsync(java.lang.Integer projectId, ApiCallback<java.lang.Void> callback) Purge Disabled Tool Results (asynchronously) Executes a purge/cleanup operation on the finding data for the project.
com.squareup.okhttp.Call	purgeDisabledToolResultsCall(java.lang.Integer projectId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for purgeDisabledToolResults
ApiResponse<java.lang.Void>	purgeDisabledToolResultsWithHttpInfo(java.lang.Integer projectId) Purge Disabled Tool Results Executes a purge/cleanup operation on the finding data for the project.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

FindingDataMaintenanceApi

public FindingDataMaintenanceApi()

FindingDataMaintenanceApi

public FindingDataMaintenanceApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getDisabledToolResultCountCall

public com.squareup.okhttp.Call getDisabledToolResultCountCall(java.lang.Integer projectId,
                                                               ProgressResponseBody.ProgressListener progressListener,
                                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                        throws ApiException

Build call for getDisabledToolResultCount

Parameters:

projectId - The ID of the project. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getDisabledToolResultCount

public DisabledToolResultsCount getDisabledToolResultCount(java.lang.Integer projectId)
                                                    throws ApiException

Disabled Tool Result Count Query Returns a count of disabled findings present within a project. These are findings that match rules that are currently disabled, will not be ingested in new analyses, and would be removed by a purge task.

Parameters:

projectId - The ID of the project. (required)

Returns:

DisabledToolResultsCount

Throws:

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

getDisabledToolResultCountWithHttpInfo

public ApiResponse<DisabledToolResultsCount> getDisabledToolResultCountWithHttpInfo(java.lang.Integer projectId)
                                                                             throws ApiException

Disabled Tool Result Count Query Returns a count of disabled findings present within a project. These are findings that match rules that are currently disabled, will not be ingested in new analyses, and would be removed by a purge task.

Parameters:

projectId - The ID of the project. (required)

Returns:

ApiResponse<DisabledToolResultsCount>

Throws:

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

getDisabledToolResultCountAsync

public com.squareup.okhttp.Call getDisabledToolResultCountAsync(java.lang.Integer projectId,
                                                                ApiCallback<DisabledToolResultsCount> callback)
                                                         throws ApiException

Disabled Tool Result Count Query (asynchronously) Returns a count of disabled findings present within a project. These are findings that match rules that are currently disabled, will not be ingested in new analyses, and would be removed by a purge task.

Parameters:

projectId - The ID of the project. (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

purgeDisabledToolResultsCall

public com.squareup.okhttp.Call purgeDisabledToolResultsCall(java.lang.Integer projectId,
                                                             ProgressResponseBody.ProgressListener progressListener,
                                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                      throws ApiException

Build call for purgeDisabledToolResults

Parameters:

projectId - The ID of the project. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

purgeDisabledToolResults

public void purgeDisabledToolResults(java.lang.Integer projectId)
                              throws ApiException

Purge Disabled Tool Results Executes a purge/cleanup operation on the finding data for the project. Any findings that match disabled rules will immediately be marked for removal, and, at some future point, be actually removed from the database by an automatic garbage collection task.

Parameters:

projectId - The ID of the project. (required)

Throws:

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

purgeDisabledToolResultsWithHttpInfo

public ApiResponse<java.lang.Void> purgeDisabledToolResultsWithHttpInfo(java.lang.Integer projectId)
                                                                 throws ApiException

Purge Disabled Tool Results Executes a purge/cleanup operation on the finding data for the project. Any findings that match disabled rules will immediately be marked for removal, and, at some future point, be actually removed from the database by an automatic garbage collection task.

Parameters:

projectId - The ID of the project. (required)

Returns:

ApiResponse<Void>

Throws:

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

purgeDisabledToolResultsAsync

public com.squareup.okhttp.Call purgeDisabledToolResultsAsync(java.lang.Integer projectId,
                                                              ApiCallback<java.lang.Void> callback)
                                                       throws ApiException

Purge Disabled Tool Results (asynchronously) Executes a purge/cleanup operation on the finding data for the project. Any findings that match disabled rules will immediately be marked for removal, and, at some future point, be actually removed from the database by an automatic garbage collection task.

Parameters:

projectId - The ID of the project. (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