com.codedx.client.api

Class AnalysisApi

java.lang.Object

com.codedx.client.api.AnalysisApi

public class AnalysisApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AnalysisApi()
AnalysisApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
AnalysisPrepResponse	createAnalysisPrep(ProjectId projectId) Create Analysis Prep Create a new Analysis Prep associated with a particular project.
com.squareup.okhttp.Call	createAnalysisPrepAsync(ProjectId projectId, ApiCallback<AnalysisPrepResponse> callback) Create Analysis Prep (asynchronously) Create a new Analysis Prep associated with a particular project.
com.squareup.okhttp.Call	createAnalysisPrepCall(ProjectId projectId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createAnalysisPrep
ApiResponse<AnalysisPrepResponse>	createAnalysisPrepWithHttpInfo(ProjectId projectId) Create Analysis Prep Create a new Analysis Prep associated with a particular project.
void	deleteInput(java.lang.String prepId, java.lang.String inputId) Delete Input Note that depending on the timing of the deletion, one of two different endpoints should be used.
com.squareup.okhttp.Call	deleteInputAsync(java.lang.String prepId, java.lang.String inputId, ApiCallback<java.lang.Void> callback) Delete Input (asynchronously) Note that depending on the timing of the deletion, one of two different endpoints should be used.
com.squareup.okhttp.Call	deleteInputCall(java.lang.String prepId, java.lang.String inputId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteInput
ApiResponse<java.lang.Void>	deleteInputWithHttpInfo(java.lang.String prepId, java.lang.String inputId) Delete Input Note that depending on the timing of the deletion, one of two different endpoints should be used.
void	deletePendingInput(java.lang.String prepId, java.lang.String xClientRequestId) Delete Input (pending) Note that depending on the timing of the deletion, one of two different endpoints should be used.
com.squareup.okhttp.Call	deletePendingInputAsync(java.lang.String prepId, java.lang.String xClientRequestId, ApiCallback<java.lang.Void> callback) Delete Input (pending) (asynchronously) Note that depending on the timing of the deletion, one of two different endpoints should be used.
com.squareup.okhttp.Call	deletePendingInputCall(java.lang.String prepId, java.lang.String xClientRequestId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deletePendingInput
ApiResponse<java.lang.Void>	deletePendingInputWithHttpInfo(java.lang.String prepId, java.lang.String xClientRequestId) Delete Input (pending) Note that depending on the timing of the deletion, one of two different endpoints should be used.
java.util.List<AnalysisDetails>	getAllAnalysisDetails(java.lang.Integer projectId) Get All Analysis Details Obtain analysis details for a project, such as start and finish times
com.squareup.okhttp.Call	getAllAnalysisDetailsAsync(java.lang.Integer projectId, ApiCallback<java.util.List<AnalysisDetails>> callback) Get All Analysis Details (asynchronously) Obtain analysis details for a project, such as start and finish times
com.squareup.okhttp.Call	getAllAnalysisDetailsCall(java.lang.Integer projectId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAllAnalysisDetails
ApiResponse<java.util.List<AnalysisDetails>>	getAllAnalysisDetailsWithHttpInfo(java.lang.Integer projectId) Get All Analysis Details Obtain analysis details for a project, such as start and finish times
AnalysisDetails	getAnalysisDetails(java.lang.Integer projectId, java.lang.Integer analysisId) Get Analysis Details Obtain analysis details, such as start and finish times
com.squareup.okhttp.Call	getAnalysisDetailsAsync(java.lang.Integer projectId, java.lang.Integer analysisId, ApiCallback<AnalysisDetails> callback) Get Analysis Details (asynchronously) Obtain analysis details, such as start and finish times
com.squareup.okhttp.Call	getAnalysisDetailsCall(java.lang.Integer projectId, java.lang.Integer analysisId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAnalysisDetails
ApiResponse<AnalysisDetails>	getAnalysisDetailsWithHttpInfo(java.lang.Integer projectId, java.lang.Integer analysisId) Get Analysis Details Obtain analysis details, such as start and finish times
ApiClient	getApiClient()
InputDisplayInfo	getInputMetadata(java.lang.String prepId, java.lang.String inputId) Get Input Metadata Get metadata for a particular input associated with an Analysis Prep.
com.squareup.okhttp.Call	getInputMetadataAsync(java.lang.String prepId, java.lang.String inputId, ApiCallback<InputDisplayInfo> callback) Get Input Metadata (asynchronously) Get metadata for a particular input associated with an Analysis Prep.
com.squareup.okhttp.Call	getInputMetadataCall(java.lang.String prepId, java.lang.String inputId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getInputMetadata
ApiResponse<InputDisplayInfo>	getInputMetadataWithHttpInfo(java.lang.String prepId, java.lang.String inputId) Get Input Metadata Get metadata for a particular input associated with an Analysis Prep.
AnalysisQueryResponse	queryAnalysisPrepState(java.lang.String prepId) Query Analysis Prep State Get a list of Input IDs and Verification Errors for an Analysis Prep.
com.squareup.okhttp.Call	queryAnalysisPrepStateAsync(java.lang.String prepId, ApiCallback<AnalysisQueryResponse> callback) Query Analysis Prep State (asynchronously) Get a list of Input IDs and Verification Errors for an Analysis Prep.
com.squareup.okhttp.Call	queryAnalysisPrepStateCall(java.lang.String prepId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for queryAnalysisPrepState
ApiResponse<AnalysisQueryResponse>	queryAnalysisPrepStateWithHttpInfo(java.lang.String prepId) Query Analysis Prep State Get a list of Input IDs and Verification Errors for an Analysis Prep.
Analysis	runPreparedAnalysis(java.lang.String prepId) Run Prepared Analysis Once all of the verificationErrors in an Analysis Prep are addressed, an analysis can be started.
com.squareup.okhttp.Call	runPreparedAnalysisAsync(java.lang.String prepId, ApiCallback<Analysis> callback) Run Prepared Analysis (asynchronously) Once all of the verificationErrors in an Analysis Prep are addressed, an analysis can be started.
com.squareup.okhttp.Call	runPreparedAnalysisCall(java.lang.String prepId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for runPreparedAnalysis
ApiResponse<Analysis>	runPreparedAnalysisWithHttpInfo(java.lang.String prepId) Run Prepared Analysis Once all of the verificationErrors in an Analysis Prep are addressed, an analysis can be started.
void	setAnalysisName(java.lang.Integer projectId, java.lang.Integer analysisId, AnalysisName analysisName) Name Analysis Set a name for a specific analysis
com.squareup.okhttp.Call	setAnalysisNameAsync(java.lang.Integer projectId, java.lang.Integer analysisId, AnalysisName analysisName, ApiCallback<java.lang.Void> callback) Name Analysis (asynchronously) Set a name for a specific analysis
com.squareup.okhttp.Call	setAnalysisNameCall(java.lang.Integer projectId, java.lang.Integer analysisId, AnalysisName analysisName, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for setAnalysisName
ApiResponse<java.lang.Void>	setAnalysisNameWithHttpInfo(java.lang.Integer projectId, java.lang.Integer analysisId, AnalysisName analysisName) Name Analysis Set a name for a specific analysis
void	setApiClient(ApiClient apiClient)
InputDisplayInfo	setDisplayTag(java.lang.String prepId, java.lang.String inputId, java.lang.String tagId, Enabled enabled) Enable/Disable Display Tag Enable and disable individual display tags on individual prop inputs.
com.squareup.okhttp.Call	setDisplayTagAsync(java.lang.String prepId, java.lang.String inputId, java.lang.String tagId, Enabled enabled, ApiCallback<InputDisplayInfo> callback) Enable/Disable Display Tag (asynchronously) Enable and disable individual display tags on individual prop inputs.
com.squareup.okhttp.Call	setDisplayTagCall(java.lang.String prepId, java.lang.String inputId, java.lang.String tagId, Enabled enabled, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for setDisplayTag
ApiResponse<InputDisplayInfo>	setDisplayTagWithHttpInfo(java.lang.String prepId, java.lang.String inputId, java.lang.String tagId, Enabled enabled) Enable/Disable Display Tag Enable and disable individual display tags on individual prop inputs.
FileUploadResponse	uploadFile(java.lang.String prepId, java.io.File file, java.lang.String xClientRequestId) Upload File to Analysis Prep Analysis Preps should be populated by uploading files to Code Dx (or by configuring Git on a project, causing the source to be automatically added to the prep).
com.squareup.okhttp.Call	uploadFileAsync(java.lang.String prepId, java.io.File file, java.lang.String xClientRequestId, ApiCallback<FileUploadResponse> callback) Upload File to Analysis Prep (asynchronously) Analysis Preps should be populated by uploading files to Code Dx (or by configuring Git on a project, causing the source to be automatically added to the prep).
com.squareup.okhttp.Call	uploadFileCall(java.lang.String prepId, java.io.File file, java.lang.String xClientRequestId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for uploadFile
ApiResponse<FileUploadResponse>	uploadFileWithHttpInfo(java.lang.String prepId, java.io.File file, java.lang.String xClientRequestId) Upload File to Analysis Prep Analysis Preps should be populated by uploading files to Code Dx (or by configuring Git on a project, causing the source to be automatically added to the prep).

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalysisApi

public AnalysisApi()

AnalysisApi

public AnalysisApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createAnalysisPrepCall

public com.squareup.okhttp.Call createAnalysisPrepCall(ProjectId projectId,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for createAnalysisPrep

Parameters:

projectId - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createAnalysisPrep

public AnalysisPrepResponse createAnalysisPrep(ProjectId projectId)
                                        throws ApiException

Create Analysis Prep Create a new Analysis Prep associated with a particular project. If Git is configured on that project, the new Analysis Prep will automatically initialize an input corresponding to that configuration.

Parameters:

projectId - (required)

Returns:

AnalysisPrepResponse

Throws:

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

createAnalysisPrepWithHttpInfo

public ApiResponse<AnalysisPrepResponse> createAnalysisPrepWithHttpInfo(ProjectId projectId)
                                                                 throws ApiException

Create Analysis Prep Create a new Analysis Prep associated with a particular project. If Git is configured on that project, the new Analysis Prep will automatically initialize an input corresponding to that configuration.

Parameters:

projectId - (required)

Returns:

ApiResponse<AnalysisPrepResponse>

Throws:

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

createAnalysisPrepAsync

public com.squareup.okhttp.Call createAnalysisPrepAsync(ProjectId projectId,
                                                        ApiCallback<AnalysisPrepResponse> callback)
                                                 throws ApiException

Create Analysis Prep (asynchronously) Create a new Analysis Prep associated with a particular project. If Git is configured on that project, the new Analysis Prep will automatically initialize an input corresponding to that configuration.

Parameters:

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

deleteInputCall

public com.squareup.okhttp.Call deleteInputCall(java.lang.String prepId,
                                                java.lang.String inputId,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for deleteInput

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

inputId - The ID of the prep input. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteInput

public void deleteInput(java.lang.String prepId,
                        java.lang.String inputId)
                 throws ApiException

Delete Input Note that depending on the timing of the deletion, one of two different endpoints should be used. If an input file has just begun to upload, but that request has not completed and returned an inputId, use the \"pending\" URL (this requires the input upload request to have specified a X-Client-Request-Id header). If the inputId is known (this will be the case most of the time), use the URL that includes an input-id parameter.

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

inputId - The ID of the prep input. (required)

Throws:

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

deleteInputWithHttpInfo

public ApiResponse<java.lang.Void> deleteInputWithHttpInfo(java.lang.String prepId,
                                                           java.lang.String inputId)
                                                    throws ApiException

Delete Input Note that depending on the timing of the deletion, one of two different endpoints should be used. If an input file has just begun to upload, but that request has not completed and returned an inputId, use the \"pending\" URL (this requires the input upload request to have specified a X-Client-Request-Id header). If the inputId is known (this will be the case most of the time), use the URL that includes an input-id parameter.

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

inputId - The ID of the prep input. (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteInputAsync

public com.squareup.okhttp.Call deleteInputAsync(java.lang.String prepId,
                                                 java.lang.String inputId,
                                                 ApiCallback<java.lang.Void> callback)
                                          throws ApiException

Delete Input (asynchronously) Note that depending on the timing of the deletion, one of two different endpoints should be used. If an input file has just begun to upload, but that request has not completed and returned an inputId, use the \"pending\" URL (this requires the input upload request to have specified a X-Client-Request-Id header). If the inputId is known (this will be the case most of the time), use the URL that includes an input-id parameter.

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

inputId - The ID of the prep input. (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

deletePendingInputCall

public com.squareup.okhttp.Call deletePendingInputCall(java.lang.String prepId,
                                                       java.lang.String xClientRequestId,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for deletePendingInput

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

xClientRequestId - If the input-id is not known, and the \"pending\" URL is being used, this header should be set to the value used by the requrest which initiated the input file upload. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deletePendingInput

public void deletePendingInput(java.lang.String prepId,
                               java.lang.String xClientRequestId)
                        throws ApiException

Delete Input (pending) Note that depending on the timing of the deletion, one of two different endpoints should be used. If an input file has just begun to upload, but that request has not completed and returned an inputId, use the \"pending\" URL (this requires the input upload request to have specified a X-Client-Request-Id header). If the inputId is known (this will be the case most of the time), use the URL that include an input-id parameter.

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

xClientRequestId - If the input-id is not known, and the \"pending\" URL is being used, this header should be set to the value used by the requrest which initiated the input file upload. (required)

Throws:

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

deletePendingInputWithHttpInfo

public ApiResponse<java.lang.Void> deletePendingInputWithHttpInfo(java.lang.String prepId,
                                                                  java.lang.String xClientRequestId)
                                                           throws ApiException

Delete Input (pending) Note that depending on the timing of the deletion, one of two different endpoints should be used. If an input file has just begun to upload, but that request has not completed and returned an inputId, use the \"pending\" URL (this requires the input upload request to have specified a X-Client-Request-Id header). If the inputId is known (this will be the case most of the time), use the URL that include an input-id parameter.

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

xClientRequestId - If the input-id is not known, and the \"pending\" URL is being used, this header should be set to the value used by the requrest which initiated the input file upload. (required)

Returns:

ApiResponse<Void>

Throws:

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

deletePendingInputAsync

public com.squareup.okhttp.Call deletePendingInputAsync(java.lang.String prepId,
                                                        java.lang.String xClientRequestId,
                                                        ApiCallback<java.lang.Void> callback)
                                                 throws ApiException

Delete Input (pending) (asynchronously) Note that depending on the timing of the deletion, one of two different endpoints should be used. If an input file has just begun to upload, but that request has not completed and returned an inputId, use the \"pending\" URL (this requires the input upload request to have specified a X-Client-Request-Id header). If the inputId is known (this will be the case most of the time), use the URL that include an input-id parameter.

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

xClientRequestId - If the input-id is not known, and the \"pending\" URL is being used, this header should be set to the value used by the requrest which initiated the input file upload. (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

getAllAnalysisDetailsCall

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

Build call for getAllAnalysisDetails

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

getAllAnalysisDetails

public java.util.List<AnalysisDetails> getAllAnalysisDetails(java.lang.Integer projectId)
                                                      throws ApiException

Get All Analysis Details Obtain analysis details for a project, such as start and finish times

Parameters:

projectId - The ID of the project. (required)

Returns:

List<AnalysisDetails>

Throws:

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

getAllAnalysisDetailsWithHttpInfo

public ApiResponse<java.util.List<AnalysisDetails>> getAllAnalysisDetailsWithHttpInfo(java.lang.Integer projectId)
                                                                               throws ApiException

Get All Analysis Details Obtain analysis details for a project, such as start and finish times

Parameters:

projectId - The ID of the project. (required)

Returns:

ApiResponse<List<AnalysisDetails>>

Throws:

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

getAllAnalysisDetailsAsync

public com.squareup.okhttp.Call getAllAnalysisDetailsAsync(java.lang.Integer projectId,
                                                           ApiCallback<java.util.List<AnalysisDetails>> callback)
                                                    throws ApiException

Get All Analysis Details (asynchronously) Obtain analysis details for a project, such as start and finish times

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

getAnalysisDetailsCall

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

Build call for getAnalysisDetails

Parameters:

projectId - The ID of the project. (required)

analysisId - The ID of the analysis (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAnalysisDetails

public AnalysisDetails getAnalysisDetails(java.lang.Integer projectId,
                                          java.lang.Integer analysisId)
                                   throws ApiException

Get Analysis Details Obtain analysis details, such as start and finish times

Parameters:

projectId - The ID of the project. (required)

analysisId - The ID of the analysis (required)

Returns:

AnalysisDetails

Throws:

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

getAnalysisDetailsWithHttpInfo

public ApiResponse<AnalysisDetails> getAnalysisDetailsWithHttpInfo(java.lang.Integer projectId,
                                                                   java.lang.Integer analysisId)
                                                            throws ApiException

Get Analysis Details Obtain analysis details, such as start and finish times

Parameters:

projectId - The ID of the project. (required)

analysisId - The ID of the analysis (required)

Returns:

ApiResponse<AnalysisDetails>

Throws:

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

getAnalysisDetailsAsync

public com.squareup.okhttp.Call getAnalysisDetailsAsync(java.lang.Integer projectId,
                                                        java.lang.Integer analysisId,
                                                        ApiCallback<AnalysisDetails> callback)
                                                 throws ApiException

Get Analysis Details (asynchronously) Obtain analysis details, such as start and finish times

Parameters:

projectId - The ID of the project. (required)

analysisId - The ID of the analysis (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

getInputMetadataCall

public com.squareup.okhttp.Call getInputMetadataCall(java.lang.String prepId,
                                                     java.lang.String inputId,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for getInputMetadata

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

inputId - The ID of the prep input. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getInputMetadata

public InputDisplayInfo getInputMetadata(java.lang.String prepId,
                                         java.lang.String inputId)
                                  throws ApiException

Get Input Metadata Get metadata for a particular input associated with an Analysis Prep.

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

inputId - The ID of the prep input. (required)

Returns:

InputDisplayInfo

Throws:

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

getInputMetadataWithHttpInfo

public ApiResponse<InputDisplayInfo> getInputMetadataWithHttpInfo(java.lang.String prepId,
                                                                  java.lang.String inputId)
                                                           throws ApiException

Get Input Metadata Get metadata for a particular input associated with an Analysis Prep.

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

inputId - The ID of the prep input. (required)

Returns:

ApiResponse<InputDisplayInfo>

Throws:

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

getInputMetadataAsync

public com.squareup.okhttp.Call getInputMetadataAsync(java.lang.String prepId,
                                                      java.lang.String inputId,
                                                      ApiCallback<InputDisplayInfo> callback)
                                               throws ApiException

Get Input Metadata (asynchronously) Get metadata for a particular input associated with an Analysis Prep.

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

inputId - The ID of the prep input. (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

queryAnalysisPrepStateCall

public com.squareup.okhttp.Call queryAnalysisPrepStateCall(java.lang.String prepId,
                                                           ProgressResponseBody.ProgressListener progressListener,
                                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                    throws ApiException

Build call for queryAnalysisPrepState

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

queryAnalysisPrepState

public AnalysisQueryResponse queryAnalysisPrepState(java.lang.String prepId)
                                             throws ApiException

Query Analysis Prep State Get a list of Input IDs and Verification Errors for an Analysis Prep.

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

Returns:

AnalysisQueryResponse

Throws:

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

queryAnalysisPrepStateWithHttpInfo

public ApiResponse<AnalysisQueryResponse> queryAnalysisPrepStateWithHttpInfo(java.lang.String prepId)
                                                                      throws ApiException

Query Analysis Prep State Get a list of Input IDs and Verification Errors for an Analysis Prep.

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

Returns:

ApiResponse<AnalysisQueryResponse>

Throws:

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

queryAnalysisPrepStateAsync

public com.squareup.okhttp.Call queryAnalysisPrepStateAsync(java.lang.String prepId,
                                                            ApiCallback<AnalysisQueryResponse> callback)
                                                     throws ApiException

Query Analysis Prep State (asynchronously) Get a list of Input IDs and Verification Errors for an Analysis Prep.

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (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

runPreparedAnalysisCall

public com.squareup.okhttp.Call runPreparedAnalysisCall(java.lang.String prepId,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for runPreparedAnalysis

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

runPreparedAnalysis

public Analysis runPreparedAnalysis(java.lang.String prepId)
                             throws ApiException

Run Prepared Analysis Once all of the verificationErrors in an Analysis Prep are addressed, an analysis can be started.

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

Returns:

Analysis

Throws:

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

runPreparedAnalysisWithHttpInfo

public ApiResponse<Analysis> runPreparedAnalysisWithHttpInfo(java.lang.String prepId)
                                                      throws ApiException

Run Prepared Analysis Once all of the verificationErrors in an Analysis Prep are addressed, an analysis can be started.

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

Returns:

ApiResponse<Analysis>

Throws:

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

runPreparedAnalysisAsync

public com.squareup.okhttp.Call runPreparedAnalysisAsync(java.lang.String prepId,
                                                         ApiCallback<Analysis> callback)
                                                  throws ApiException

Run Prepared Analysis (asynchronously) Once all of the verificationErrors in an Analysis Prep are addressed, an analysis can be started.

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (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

setAnalysisNameCall

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

Build call for setAnalysisName

Parameters:

projectId - The ID of the project. (required)

analysisId - The ID of the analysis (required)

analysisName - An object containing the name of the analysis (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

setAnalysisName

public void setAnalysisName(java.lang.Integer projectId,
                            java.lang.Integer analysisId,
                            AnalysisName analysisName)
                     throws ApiException

Name Analysis Set a name for a specific analysis

Parameters:

projectId - The ID of the project. (required)

analysisId - The ID of the analysis (required)

analysisName - An object containing the name of the analysis (optional)

Throws:

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

setAnalysisNameWithHttpInfo

public ApiResponse<java.lang.Void> setAnalysisNameWithHttpInfo(java.lang.Integer projectId,
                                                               java.lang.Integer analysisId,
                                                               AnalysisName analysisName)
                                                        throws ApiException

Name Analysis Set a name for a specific analysis

Parameters:

projectId - The ID of the project. (required)

analysisId - The ID of the analysis (required)

analysisName - An object containing the name of the analysis (optional)

Returns:

ApiResponse<Void>

Throws:

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

setAnalysisNameAsync

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

Name Analysis (asynchronously) Set a name for a specific analysis

Parameters:

projectId - The ID of the project. (required)

analysisId - The ID of the analysis (required)

analysisName - An object containing the name of the analysis (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

setDisplayTagCall

public com.squareup.okhttp.Call setDisplayTagCall(java.lang.String prepId,
                                                  java.lang.String inputId,
                                                  java.lang.String tagId,
                                                  Enabled enabled,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for setDisplayTag

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

inputId - The ID of the prep input. (required)

tagId - The ID of a Display Tag State object which would have been returned by the Get Input Metadata endpoint (required)

enabled - A boolean indicating whether the tag should be enabled or disabled (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

setDisplayTag

public InputDisplayInfo setDisplayTag(java.lang.String prepId,
                                      java.lang.String inputId,
                                      java.lang.String tagId,
                                      Enabled enabled)
                               throws ApiException

Enable/Disable Display Tag Enable and disable individual display tags on individual prop inputs. Disabled tags will cause a file to be treated as if that tag were not there, for analysis purposes. For example, if the `{ \"source\"&#58; \"Java\" } tag was disabled for a file when the analysis was started, that file would be treated as if there were no Java sources at all. This could mean that certain tools would not be run on that file.

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

inputId - The ID of the prep input. (required)

tagId - The ID of a Display Tag State object which would have been returned by the Get Input Metadata endpoint (required)

enabled - A boolean indicating whether the tag should be enabled or disabled (optional)

Returns:

InputDisplayInfo

Throws:

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

setDisplayTagWithHttpInfo

public ApiResponse<InputDisplayInfo> setDisplayTagWithHttpInfo(java.lang.String prepId,
                                                               java.lang.String inputId,
                                                               java.lang.String tagId,
                                                               Enabled enabled)
                                                        throws ApiException

Enable/Disable Display Tag Enable and disable individual display tags on individual prop inputs. Disabled tags will cause a file to be treated as if that tag were not there, for analysis purposes. For example, if the `{ \"source\"&#58; \"Java\" } tag was disabled for a file when the analysis was started, that file would be treated as if there were no Java sources at all. This could mean that certain tools would not be run on that file.

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

inputId - The ID of the prep input. (required)

tagId - The ID of a Display Tag State object which would have been returned by the Get Input Metadata endpoint (required)

enabled - A boolean indicating whether the tag should be enabled or disabled (optional)

Returns:

ApiResponse<InputDisplayInfo>

Throws:

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

setDisplayTagAsync

public com.squareup.okhttp.Call setDisplayTagAsync(java.lang.String prepId,
                                                   java.lang.String inputId,
                                                   java.lang.String tagId,
                                                   Enabled enabled,
                                                   ApiCallback<InputDisplayInfo> callback)
                                            throws ApiException

Enable/Disable Display Tag (asynchronously) Enable and disable individual display tags on individual prop inputs. Disabled tags will cause a file to be treated as if that tag were not there, for analysis purposes. For example, if the `{ \"source\"&#58; \"Java\" } tag was disabled for a file when the analysis was started, that file would be treated as if there were no Java sources at all. This could mean that certain tools would not be run on that file.

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

inputId - The ID of the prep input. (required)

tagId - The ID of a Display Tag State object which would have been returned by the Get Input Metadata endpoint (required)

enabled - A boolean indicating whether the tag should be enabled or disabled (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

uploadFileCall

public com.squareup.okhttp.Call uploadFileCall(java.lang.String prepId,
                                               java.io.File file,
                                               java.lang.String xClientRequestId,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for uploadFile

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

file - The file to be uploaded (required)

xClientRequestId - Clients may choose an arbitrary identifier (a random string will suffice) to associate with the upload. This is done to enable deletion of an input before its file upload is fully complete. For more info, see Delete Input. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

uploadFile

public FileUploadResponse uploadFile(java.lang.String prepId,
                                     java.io.File file,
                                     java.lang.String xClientRequestId)
                              throws ApiException

Upload File to Analysis Prep Analysis Preps should be populated by uploading files to Code Dx (or by configuring Git on a project, causing the source to be automatically added to the prep).

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

file - The file to be uploaded (required)

xClientRequestId - Clients may choose an arbitrary identifier (a random string will suffice) to associate with the upload. This is done to enable deletion of an input before its file upload is fully complete. For more info, see Delete Input. (optional)

Returns:

FileUploadResponse

Throws:

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

uploadFileWithHttpInfo

public ApiResponse<FileUploadResponse> uploadFileWithHttpInfo(java.lang.String prepId,
                                                              java.io.File file,
                                                              java.lang.String xClientRequestId)
                                                       throws ApiException

Upload File to Analysis Prep Analysis Preps should be populated by uploading files to Code Dx (or by configuring Git on a project, causing the source to be automatically added to the prep).

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

file - The file to be uploaded (required)

xClientRequestId - Clients may choose an arbitrary identifier (a random string will suffice) to associate with the upload. This is done to enable deletion of an input before its file upload is fully complete. For more info, see Delete Input. (optional)

Returns:

ApiResponse<FileUploadResponse>

Throws:

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

uploadFileAsync

public com.squareup.okhttp.Call uploadFileAsync(java.lang.String prepId,
                                                java.io.File file,
                                                java.lang.String xClientRequestId,
                                                ApiCallback<FileUploadResponse> callback)
                                         throws ApiException

Upload File to Analysis Prep (asynchronously) Analysis Preps should be populated by uploading files to Code Dx (or by configuring Git on a project, causing the source to be automatically added to the prep).

Parameters:

prepId - The ID of the Analysis Prep. This should come from the Create Analysis Prep response. (required)

file - The file to be uploaded (required)

xClientRequestId - Clients may choose an arbitrary identifier (a random string will suffice) to associate with the upload. This is done to enable deletion of an input before its file upload is fully complete. For more info, see Delete Input. (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