com.codedx.client.api

Class FindingDataApi

java.lang.Object

com.codedx.client.api.FindingDataApi

public class FindingDataApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
FindingDataApi()
FindingDataApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
Finding	getFindingData(java.lang.Integer findingId, java.util.List<java.lang.String> expand) Finding Data Returns metadata for the given finding
com.squareup.okhttp.Call	getFindingDataAsync(java.lang.Integer findingId, java.util.List<java.lang.String> expand, ApiCallback<Finding> callback) Finding Data (asynchronously) Returns metadata for the given finding
com.squareup.okhttp.Call	getFindingDataCall(java.lang.Integer findingId, java.util.List<java.lang.String> expand, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getFindingData
ApiResponse<Finding>	getFindingDataWithHttpInfo(java.lang.Integer findingId, java.util.List<java.lang.String> expand) Finding Data Returns metadata for the given finding
FindingDescription	getFindingDescription(java.lang.Integer findingId) Finding Descriptions Returns the descriptions for the given finding from all available sources.
com.squareup.okhttp.Call	getFindingDescriptionAsync(java.lang.Integer findingId, ApiCallback<FindingDescription> callback) Finding Descriptions (asynchronously) Returns the descriptions for the given finding from all available sources.
com.squareup.okhttp.Call	getFindingDescriptionCall(java.lang.Integer findingId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getFindingDescription
ApiResponse<FindingDescription>	getFindingDescriptionWithHttpInfo(java.lang.Integer findingId) Finding Descriptions Returns the descriptions for the given finding from all available sources.
java.util.List<FlowData>	getFindingFlow(java.lang.Integer projectId, FlowRequest flowRequest) Finding Flow Data Returns filtered finding flow data.
com.squareup.okhttp.Call	getFindingFlowAsync(java.lang.Integer projectId, FlowRequest flowRequest, ApiCallback<java.util.List<FlowData>> callback) Finding Flow Data (asynchronously) Returns filtered finding flow data.
com.squareup.okhttp.Call	getFindingFlowCall(java.lang.Integer projectId, FlowRequest flowRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getFindingFlow
ApiResponse<java.util.List<FlowData>>	getFindingFlowWithHttpInfo(java.lang.Integer projectId, FlowRequest flowRequest) Finding Flow Data Returns filtered finding flow data.
java.util.List<ActivityEvent>	getFindingHistory(java.lang.Integer findingId) Finding History Responds with an array of \"activity event\" objects in JSON.
com.squareup.okhttp.Call	getFindingHistoryAsync(java.lang.Integer findingId, ApiCallback<java.util.List<ActivityEvent>> callback) Finding History (asynchronously) Responds with an array of \"activity event\" objects in JSON.
com.squareup.okhttp.Call	getFindingHistoryCall(java.lang.Integer findingId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getFindingHistory
ApiResponse<java.util.List<ActivityEvent>>	getFindingHistoryWithHttpInfo(java.lang.Integer findingId) Finding History Responds with an array of \"activity event\" objects in JSON.
Count	getFindingsCount(java.lang.Integer projectId, Query query) Finding Count Returns the count of all findings in the project matching the given filter.
com.squareup.okhttp.Call	getFindingsCountAsync(java.lang.Integer projectId, Query query, ApiCallback<Count> callback) Finding Count (asynchronously) Returns the count of all findings in the project matching the given filter.
com.squareup.okhttp.Call	getFindingsCountCall(java.lang.Integer projectId, Query query, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getFindingsCount
ApiResponse<Count>	getFindingsCountWithHttpInfo(java.lang.Integer projectId, Query query) Finding Count Returns the count of all findings in the project matching the given filter.
java.util.List<GroupedCount>	getFindingsGroupCount(java.lang.Integer projectId, GroupedCountsRequest groupedCountRequest) Findings Grouped Count Returns filtered finding counts, grouped by the specified field.
com.squareup.okhttp.Call	getFindingsGroupCountAsync(java.lang.Integer projectId, GroupedCountsRequest groupedCountRequest, ApiCallback<java.util.List<GroupedCount>> callback) Findings Grouped Count (asynchronously) Returns filtered finding counts, grouped by the specified field.
com.squareup.okhttp.Call	getFindingsGroupCountCall(java.lang.Integer projectId, GroupedCountsRequest groupedCountRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getFindingsGroupCount
ApiResponse<java.util.List<GroupedCount>>	getFindingsGroupCountWithHttpInfo(java.lang.Integer projectId, GroupedCountsRequest groupedCountRequest) Findings Grouped Count Returns filtered finding counts, grouped by the specified field.
java.util.List<Finding>	getFindingsTable(java.lang.Integer projectId, Query query, java.util.List<java.lang.String> expand) Finding Table Data Returns filtered finding table data.
com.squareup.okhttp.Call	getFindingsTableAsync(java.lang.Integer projectId, Query query, java.util.List<java.lang.String> expand, ApiCallback<java.util.List<Finding>> callback) Finding Table Data (asynchronously) Returns filtered finding table data.
com.squareup.okhttp.Call	getFindingsTableCall(java.lang.Integer projectId, Query query, java.util.List<java.lang.String> expand, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getFindingsTable
ApiResponse<java.util.List<Finding>>	getFindingsTableWithHttpInfo(java.lang.Integer projectId, Query query, java.util.List<java.lang.String> expand) Finding Table Data Returns filtered finding table data.
java.lang.String	getSourceFileContents(java.lang.Integer projectId, java.lang.Integer pathId) Source File Contents Returns the contents of a given file, as long as it is a text file.
com.squareup.okhttp.Call	getSourceFileContentsAsync(java.lang.Integer projectId, java.lang.Integer pathId, ApiCallback<java.lang.String> callback) Source File Contents (asynchronously) Returns the contents of a given file, as long as it is a text file.
com.squareup.okhttp.Call	getSourceFileContentsCall(java.lang.Integer projectId, java.lang.Integer pathId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getSourceFileContents
java.lang.String	getSourceFileContentsFromPath(java.lang.Integer projectId, java.lang.String path) Source File Contents (tree) Returns the contents of a given file, as long as it is a text file.
com.squareup.okhttp.Call	getSourceFileContentsFromPathAsync(java.lang.Integer projectId, java.lang.String path, ApiCallback<java.lang.String> callback) Source File Contents (tree) (asynchronously) Returns the contents of a given file, as long as it is a text file.
com.squareup.okhttp.Call	getSourceFileContentsFromPathCall(java.lang.Integer projectId, java.lang.String path, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getSourceFileContentsFromPath
ApiResponse<java.lang.String>	getSourceFileContentsFromPathWithHttpInfo(java.lang.Integer projectId, java.lang.String path) Source File Contents (tree) Returns the contents of a given file, as long as it is a text file.
ApiResponse<java.lang.String>	getSourceFileContentsWithHttpInfo(java.lang.Integer projectId, java.lang.Integer pathId) Source File Contents Returns the contents of a given file, as long as it is a text file.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

FindingDataApi

public FindingDataApi()

FindingDataApi

public FindingDataApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getFindingDataCall

public com.squareup.okhttp.Call getFindingDataCall(java.lang.Integer findingId,
                                                   java.util.List<java.lang.String> expand,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for getFindingData

Parameters:

findingId - The finding ID. (required)

expand - The expand parameter is a comma seperated list. Each value included in the list has the potential to modify the response's Finding objects. The available values and their effects are: - `descriptions` - an additional property named `descriptions` is added to the Finding objects. It is a Description object that contains the tool/rule description for the finding - `descriptor` - adds additional content to the `descriptor` property of the Finding object. - `issue` - an additional property named `issue` is added to the Finding objects. `issue` will be an Issue object. - `triage-time` - an additional property named `triageTime` is added to the Finding objects. It is a date time that corresponds to the most recent time the status of the finding was updated. - `results` - an additional property named `results` is added to the Finding objects. It is an array of ToolResult objects that relate to the finding. - `results.descriptions` - does the same thing as `results` as well as adds an additional property named `descriptions` to the ToolResult objects. This property is a Description object and will contain the tool and contextual descriptions for the result. - `results.descriptor` - does the same thing as `results` as well as adds additional properties to the ToolResults' `descriptor` properties. - `results.metadata` - does the same thing as `results` as well as adds an additional property to the ToolResult object named `metadata`. `metadata` is an object that contains key values pairs, usually some additional information reported by a tool. - `results.variants` - does the same thing as `results` as well as adds an additional property to the the ToolResult object named `variants`. `variants` is an array of Variant objects. A Variant typically contains http/https request and response information. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getFindingData

public Finding getFindingData(java.lang.Integer findingId,
                              java.util.List<java.lang.String> expand)
                       throws ApiException

Finding Data Returns metadata for the given finding

Parameters:

findingId - The finding ID. (required)

expand - The expand parameter is a comma seperated list. Each value included in the list has the potential to modify the response's Finding objects. The available values and their effects are: - `descriptions` - an additional property named `descriptions` is added to the Finding objects. It is a Description object that contains the tool/rule description for the finding - `descriptor` - adds additional content to the `descriptor` property of the Finding object. - `issue` - an additional property named `issue` is added to the Finding objects. `issue` will be an Issue object. - `triage-time` - an additional property named `triageTime` is added to the Finding objects. It is a date time that corresponds to the most recent time the status of the finding was updated. - `results` - an additional property named `results` is added to the Finding objects. It is an array of ToolResult objects that relate to the finding. - `results.descriptions` - does the same thing as `results` as well as adds an additional property named `descriptions` to the ToolResult objects. This property is a Description object and will contain the tool and contextual descriptions for the result. - `results.descriptor` - does the same thing as `results` as well as adds additional properties to the ToolResults' `descriptor` properties. - `results.metadata` - does the same thing as `results` as well as adds an additional property to the ToolResult object named `metadata`. `metadata` is an object that contains key values pairs, usually some additional information reported by a tool. - `results.variants` - does the same thing as `results` as well as adds an additional property to the the ToolResult object named `variants`. `variants` is an array of Variant objects. A Variant typically contains http/https request and response information. (optional)

Returns:

Finding

Throws:

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

getFindingDataWithHttpInfo

public ApiResponse<Finding> getFindingDataWithHttpInfo(java.lang.Integer findingId,
                                                       java.util.List<java.lang.String> expand)
                                                throws ApiException

Finding Data Returns metadata for the given finding

Parameters:

findingId - The finding ID. (required)

expand - The expand parameter is a comma seperated list. Each value included in the list has the potential to modify the response's Finding objects. The available values and their effects are: - `descriptions` - an additional property named `descriptions` is added to the Finding objects. It is a Description object that contains the tool/rule description for the finding - `descriptor` - adds additional content to the `descriptor` property of the Finding object. - `issue` - an additional property named `issue` is added to the Finding objects. `issue` will be an Issue object. - `triage-time` - an additional property named `triageTime` is added to the Finding objects. It is a date time that corresponds to the most recent time the status of the finding was updated. - `results` - an additional property named `results` is added to the Finding objects. It is an array of ToolResult objects that relate to the finding. - `results.descriptions` - does the same thing as `results` as well as adds an additional property named `descriptions` to the ToolResult objects. This property is a Description object and will contain the tool and contextual descriptions for the result. - `results.descriptor` - does the same thing as `results` as well as adds additional properties to the ToolResults' `descriptor` properties. - `results.metadata` - does the same thing as `results` as well as adds an additional property to the ToolResult object named `metadata`. `metadata` is an object that contains key values pairs, usually some additional information reported by a tool. - `results.variants` - does the same thing as `results` as well as adds an additional property to the the ToolResult object named `variants`. `variants` is an array of Variant objects. A Variant typically contains http/https request and response information. (optional)

Returns:

ApiResponse<Finding>

Throws:

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

getFindingDataAsync

public com.squareup.okhttp.Call getFindingDataAsync(java.lang.Integer findingId,
                                                    java.util.List<java.lang.String> expand,
                                                    ApiCallback<Finding> callback)
                                             throws ApiException

Finding Data (asynchronously) Returns metadata for the given finding

Parameters:

findingId - The finding ID. (required)

expand - The expand parameter is a comma seperated list. Each value included in the list has the potential to modify the response's Finding objects. The available values and their effects are&#58; - `descriptions` - an additional property named `descriptions` is added to the Finding objects. It is a Description object that contains the tool/rule description for the finding - `descriptor` - adds additional content to the `descriptor` property of the Finding object. - `issue` - an additional property named `issue` is added to the Finding objects. `issue` will be an Issue object. - `triage-time` - an additional property named `triageTime` is added to the Finding objects. It is a date time that corresponds to the most recent time the status of the finding was updated. - `results` - an additional property named `results` is added to the Finding objects. It is an array of ToolResult objects that relate to the finding. - `results.descriptions` - does the same thing as `results` as well as adds an additional property named `descriptions` to the ToolResult objects. This property is a Description object and will contain the tool and contextual descriptions for the result. - `results.descriptor` - does the same thing as `results` as well as adds additional properties to the ToolResults' `descriptor` properties. - `results.metadata` - does the same thing as `results` as well as adds an additional property to the ToolResult object named `metadata`. `metadata` is an object that contains key values pairs, usually some additional information reported by a tool. - `results.variants` - does the same thing as `results` as well as adds an additional property to the the ToolResult object named `variants`. `variants` is an array of Variant objects. A Variant typically contains http/https request and response information. (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

getFindingDescriptionCall

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

Build call for getFindingDescription

Parameters:

findingId - The finding ID. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getFindingDescription

public FindingDescription getFindingDescription(java.lang.Integer findingId)
                                         throws ApiException

Finding Descriptions Returns the descriptions for the given finding from all available sources.

Parameters:

findingId - The finding ID. (required)

Returns:

FindingDescription

Throws:

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

getFindingDescriptionWithHttpInfo

public ApiResponse<FindingDescription> getFindingDescriptionWithHttpInfo(java.lang.Integer findingId)
                                                                  throws ApiException

Finding Descriptions Returns the descriptions for the given finding from all available sources.

Parameters:

findingId - The finding ID. (required)

Returns:

ApiResponse<FindingDescription>

Throws:

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

getFindingDescriptionAsync

public com.squareup.okhttp.Call getFindingDescriptionAsync(java.lang.Integer findingId,
                                                           ApiCallback<FindingDescription> callback)
                                                    throws ApiException

Finding Descriptions (asynchronously) Returns the descriptions for the given finding from all available sources.

Parameters:

findingId - The finding ID. (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

getFindingFlowCall

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

Build call for getFindingFlow

Parameters:

projectId - The ID of the project. (required)

flowRequest - (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getFindingFlow

public java.util.List<FlowData> getFindingFlow(java.lang.Integer projectId,
                                               FlowRequest flowRequest)
                                        throws ApiException

Finding Flow Data Returns filtered finding flow data. This endpoint is a candidate to be absorbed by a more generic querying API; presently it just returns the data required for the finding flow as it exists today.

Parameters:

projectId - The ID of the project. (required)

flowRequest - (optional)

Returns:

List<FlowData>

Throws:

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

getFindingFlowWithHttpInfo

public ApiResponse<java.util.List<FlowData>> getFindingFlowWithHttpInfo(java.lang.Integer projectId,
                                                                        FlowRequest flowRequest)
                                                                 throws ApiException

Finding Flow Data Returns filtered finding flow data. This endpoint is a candidate to be absorbed by a more generic querying API; presently it just returns the data required for the finding flow as it exists today.

Parameters:

projectId - The ID of the project. (required)

flowRequest - (optional)

Returns:

ApiResponse<List<FlowData>>

Throws:

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

getFindingFlowAsync

public com.squareup.okhttp.Call getFindingFlowAsync(java.lang.Integer projectId,
                                                    FlowRequest flowRequest,
                                                    ApiCallback<java.util.List<FlowData>> callback)
                                             throws ApiException

Finding Flow Data (asynchronously) Returns filtered finding flow data. This endpoint is a candidate to be absorbed by a more generic querying API; presently it just returns the data required for the finding flow as it exists today.

Parameters:

projectId - The ID of the project. (required)

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

getFindingHistoryCall

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

Build call for getFindingHistory

Parameters:

findingId - The finding ID. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getFindingHistory

public java.util.List<ActivityEvent> getFindingHistory(java.lang.Integer findingId)
                                                throws ApiException

Finding History Responds with an array of \"activity event\" objects in JSON.

Parameters:

findingId - The finding ID. (required)

Returns:

List<ActivityEvent>

Throws:

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

getFindingHistoryWithHttpInfo

public ApiResponse<java.util.List<ActivityEvent>> getFindingHistoryWithHttpInfo(java.lang.Integer findingId)
                                                                         throws ApiException

Finding History Responds with an array of \"activity event\" objects in JSON.

Parameters:

findingId - The finding ID. (required)

Returns:

ApiResponse<List<ActivityEvent>>

Throws:

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

getFindingHistoryAsync

public com.squareup.okhttp.Call getFindingHistoryAsync(java.lang.Integer findingId,
                                                       ApiCallback<java.util.List<ActivityEvent>> callback)
                                                throws ApiException

Finding History (asynchronously) Responds with an array of \"activity event\" objects in JSON.

Parameters:

findingId - The finding ID. (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

getFindingsCountCall

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

Build call for getFindingsCount

Parameters:

projectId - The ID of the project. (required)

query - (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getFindingsCount

public Count getFindingsCount(java.lang.Integer projectId,
                              Query query)
                       throws ApiException

Finding Count Returns the count of all findings in the project matching the given filter.

Parameters:

projectId - The ID of the project. (required)

query - (optional)

Returns:

Count

Throws:

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

getFindingsCountWithHttpInfo

public ApiResponse<Count> getFindingsCountWithHttpInfo(java.lang.Integer projectId,
                                                       Query query)
                                                throws ApiException

Finding Count Returns the count of all findings in the project matching the given filter.

Parameters:

projectId - The ID of the project. (required)

query - (optional)

Returns:

ApiResponse<Count>

Throws:

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

getFindingsCountAsync

public com.squareup.okhttp.Call getFindingsCountAsync(java.lang.Integer projectId,
                                                      Query query,
                                                      ApiCallback<Count> callback)
                                               throws ApiException

Finding Count (asynchronously) Returns the count of all findings in the project matching the given filter.

Parameters:

projectId - The ID of the project. (required)

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

getFindingsGroupCountCall

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

Build call for getFindingsGroupCount

Parameters:

projectId - The ID of the project. (required)

groupedCountRequest - (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getFindingsGroupCount

public java.util.List<GroupedCount> getFindingsGroupCount(java.lang.Integer projectId,
                                                          GroupedCountsRequest groupedCountRequest)
                                                   throws ApiException

Findings Grouped Count Returns filtered finding counts, grouped by the specified field.

Parameters:

projectId - The ID of the project. (required)

groupedCountRequest - (optional)

Returns:

List<GroupedCount>

Throws:

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

getFindingsGroupCountWithHttpInfo

public ApiResponse<java.util.List<GroupedCount>> getFindingsGroupCountWithHttpInfo(java.lang.Integer projectId,
                                                                                   GroupedCountsRequest groupedCountRequest)
                                                                            throws ApiException

Findings Grouped Count Returns filtered finding counts, grouped by the specified field.

Parameters:

projectId - The ID of the project. (required)

groupedCountRequest - (optional)

Returns:

ApiResponse<List<GroupedCount>>

Throws:

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

getFindingsGroupCountAsync

public com.squareup.okhttp.Call getFindingsGroupCountAsync(java.lang.Integer projectId,
                                                           GroupedCountsRequest groupedCountRequest,
                                                           ApiCallback<java.util.List<GroupedCount>> callback)
                                                    throws ApiException

Findings Grouped Count (asynchronously) Returns filtered finding counts, grouped by the specified field.

Parameters:

projectId - The ID of the project. (required)

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

getFindingsTableCall

public com.squareup.okhttp.Call getFindingsTableCall(java.lang.Integer projectId,
                                                     Query query,
                                                     java.util.List<java.lang.String> expand,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for getFindingsTable

Parameters:

projectId - The ID of the project. (required)

query - (optional)

expand - The expand parameter is a comma seperated list. Each value included in the list has the potential to modify the response's Finding objects. The available values and their effects are&#58; - `descriptions` - an additional property named `descriptions` is added to the Finding objects. It is a Description object that contains the tool/rule description for the finding - `descriptor` - adds additional content to the `descriptor` property of the Finding object. - `issue` - an additional property named `issue` is added to the Finding objects. `issue` will be an Issue object. - `triage-time` - an additional property named `triageTime` is added to the Finding objects. It is a date time that corresponds to the most recent time the status of the finding was updated. - `results` - an additional property named `results` is added to the Finding objects. It is an array of ToolResult objects that relate to the finding. - `results.descriptions` - does the same thing as `results` as well as adds an additional property named `descriptions` to the ToolResult objects. This property is a Description object and will contain the tool and contextual descriptions for the result. - `results.descriptor` - does the same thing as `results` as well as adds additional properties to the ToolResults' `descriptor` properties. - `results.metadata` - does the same thing as `results` as well as adds an additional property to the ToolResult object named `metadata`. `metadata` is an object that contains key values pairs, usually some additional information reported by a tool. - `results.variants` - does the same thing as `results` as well as adds an additional property to the the ToolResult object named `variants`. `variants` is an array of Variant objects. A Variant typically contains http/https request and response information. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getFindingsTable

public java.util.List<Finding> getFindingsTable(java.lang.Integer projectId,
                                                Query query,
                                                java.util.List<java.lang.String> expand)
                                         throws ApiException

Finding Table Data Returns filtered finding table data. This endpoint is a candidate to become a more generic querying API; presently it just returns the data required for the findings table as it exists today.

Parameters:

projectId - The ID of the project. (required)

query - (optional)

expand - The expand parameter is a comma seperated list. Each value included in the list has the potential to modify the response's Finding objects. The available values and their effects are&#58; - `descriptions` - an additional property named `descriptions` is added to the Finding objects. It is a Description object that contains the tool/rule description for the finding - `descriptor` - adds additional content to the `descriptor` property of the Finding object. - `issue` - an additional property named `issue` is added to the Finding objects. `issue` will be an Issue object. - `triage-time` - an additional property named `triageTime` is added to the Finding objects. It is a date time that corresponds to the most recent time the status of the finding was updated. - `results` - an additional property named `results` is added to the Finding objects. It is an array of ToolResult objects that relate to the finding. - `results.descriptions` - does the same thing as `results` as well as adds an additional property named `descriptions` to the ToolResult objects. This property is a Description object and will contain the tool and contextual descriptions for the result. - `results.descriptor` - does the same thing as `results` as well as adds additional properties to the ToolResults' `descriptor` properties. - `results.metadata` - does the same thing as `results` as well as adds an additional property to the ToolResult object named `metadata`. `metadata` is an object that contains key values pairs, usually some additional information reported by a tool. - `results.variants` - does the same thing as `results` as well as adds an additional property to the the ToolResult object named `variants`. `variants` is an array of Variant objects. A Variant typically contains http/https request and response information. (optional)

Returns:

List<Finding>

Throws:

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

getFindingsTableWithHttpInfo

public ApiResponse<java.util.List<Finding>> getFindingsTableWithHttpInfo(java.lang.Integer projectId,
                                                                         Query query,
                                                                         java.util.List<java.lang.String> expand)
                                                                  throws ApiException

Finding Table Data Returns filtered finding table data. This endpoint is a candidate to become a more generic querying API; presently it just returns the data required for the findings table as it exists today.

Parameters:

projectId - The ID of the project. (required)

query - (optional)

expand - The expand parameter is a comma seperated list. Each value included in the list has the potential to modify the response's Finding objects. The available values and their effects are&#58; - `descriptions` - an additional property named `descriptions` is added to the Finding objects. It is a Description object that contains the tool/rule description for the finding - `descriptor` - adds additional content to the `descriptor` property of the Finding object. - `issue` - an additional property named `issue` is added to the Finding objects. `issue` will be an Issue object. - `triage-time` - an additional property named `triageTime` is added to the Finding objects. It is a date time that corresponds to the most recent time the status of the finding was updated. - `results` - an additional property named `results` is added to the Finding objects. It is an array of ToolResult objects that relate to the finding. - `results.descriptions` - does the same thing as `results` as well as adds an additional property named `descriptions` to the ToolResult objects. This property is a Description object and will contain the tool and contextual descriptions for the result. - `results.descriptor` - does the same thing as `results` as well as adds additional properties to the ToolResults' `descriptor` properties. - `results.metadata` - does the same thing as `results` as well as adds an additional property to the ToolResult object named `metadata`. `metadata` is an object that contains key values pairs, usually some additional information reported by a tool. - `results.variants` - does the same thing as `results` as well as adds an additional property to the the ToolResult object named `variants`. `variants` is an array of Variant objects. A Variant typically contains http/https request and response information. (optional)

Returns:

ApiResponse<List<Finding>>

Throws:

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

getFindingsTableAsync

public com.squareup.okhttp.Call getFindingsTableAsync(java.lang.Integer projectId,
                                                      Query query,
                                                      java.util.List<java.lang.String> expand,
                                                      ApiCallback<java.util.List<Finding>> callback)
                                               throws ApiException

Finding Table Data (asynchronously) Returns filtered finding table data. This endpoint is a candidate to become a more generic querying API; presently it just returns the data required for the findings table as it exists today.

Parameters:

projectId - The ID of the project. (required)

query - (optional)

expand - The expand parameter is a comma seperated list. Each value included in the list has the potential to modify the response's Finding objects. The available values and their effects are&#58; - `descriptions` - an additional property named `descriptions` is added to the Finding objects. It is a Description object that contains the tool/rule description for the finding - `descriptor` - adds additional content to the `descriptor` property of the Finding object. - `issue` - an additional property named `issue` is added to the Finding objects. `issue` will be an Issue object. - `triage-time` - an additional property named `triageTime` is added to the Finding objects. It is a date time that corresponds to the most recent time the status of the finding was updated. - `results` - an additional property named `results` is added to the Finding objects. It is an array of ToolResult objects that relate to the finding. - `results.descriptions` - does the same thing as `results` as well as adds an additional property named `descriptions` to the ToolResult objects. This property is a Description object and will contain the tool and contextual descriptions for the result. - `results.descriptor` - does the same thing as `results` as well as adds additional properties to the ToolResults' `descriptor` properties. - `results.metadata` - does the same thing as `results` as well as adds an additional property to the ToolResult object named `metadata`. `metadata` is an object that contains key values pairs, usually some additional information reported by a tool. - `results.variants` - does the same thing as `results` as well as adds an additional property to the the ToolResult object named `variants`. `variants` is an array of Variant objects. A Variant typically contains http/https request and response information. (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

getSourceFileContentsCall

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

Build call for getSourceFileContents

Parameters:

projectId - The ID of the project. (required)

pathId - The ID of the path (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSourceFileContents

public java.lang.String getSourceFileContents(java.lang.Integer projectId,
                                              java.lang.Integer pathId)
                                       throws ApiException

Source File Contents Returns the contents of a given file, as long as it is a text file.

Parameters:

projectId - The ID of the project. (required)

pathId - The ID of the path (required)

Returns:

String

Throws:

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

getSourceFileContentsWithHttpInfo

public ApiResponse<java.lang.String> getSourceFileContentsWithHttpInfo(java.lang.Integer projectId,
                                                                       java.lang.Integer pathId)
                                                                throws ApiException

Source File Contents Returns the contents of a given file, as long as it is a text file.

Parameters:

projectId - The ID of the project. (required)

pathId - The ID of the path (required)

Returns:

ApiResponse<String>

Throws:

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

getSourceFileContentsAsync

public com.squareup.okhttp.Call getSourceFileContentsAsync(java.lang.Integer projectId,
                                                           java.lang.Integer pathId,
                                                           ApiCallback<java.lang.String> callback)
                                                    throws ApiException

Source File Contents (asynchronously) Returns the contents of a given file, as long as it is a text file.

Parameters:

projectId - The ID of the project. (required)

pathId - The ID of the path (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

getSourceFileContentsFromPathCall

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

Build call for getSourceFileContentsFromPath

Parameters:

projectId - The ID of the project. (required)

path - The literal path to the file (e.g., \"com/foo/bar/Baz.java\") (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSourceFileContentsFromPath

public java.lang.String getSourceFileContentsFromPath(java.lang.Integer projectId,
                                                      java.lang.String path)
                                               throws ApiException

Source File Contents (tree) Returns the contents of a given file, as long as it is a text file.

Parameters:

projectId - The ID of the project. (required)

path - The literal path to the file (e.g., \"com/foo/bar/Baz.java\") (required)

Returns:

String

Throws:

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

getSourceFileContentsFromPathWithHttpInfo

public ApiResponse<java.lang.String> getSourceFileContentsFromPathWithHttpInfo(java.lang.Integer projectId,
                                                                               java.lang.String path)
                                                                        throws ApiException

Source File Contents (tree) Returns the contents of a given file, as long as it is a text file.

Parameters:

projectId - The ID of the project. (required)

path - The literal path to the file (e.g., \"com/foo/bar/Baz.java\") (required)

Returns:

ApiResponse<String>

Throws:

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

getSourceFileContentsFromPathAsync

public com.squareup.okhttp.Call getSourceFileContentsFromPathAsync(java.lang.Integer projectId,
                                                                   java.lang.String path,
                                                                   ApiCallback<java.lang.String> callback)
                                                            throws ApiException

Source File Contents (tree) (asynchronously) Returns the contents of a given file, as long as it is a text file.

Parameters:

projectId - The ID of the project. (required)

path - The literal path to the file (e.g., \"com/foo/bar/Baz.java\") (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