Package ai.reveng.api

Class AnalysesCommentsApi

java.lang.Object

ai.reveng.api.AnalysesCommentsApi

public class AnalysesCommentsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
AnalysesCommentsApi()
AnalysesCommentsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
BaseResponseCommentResponse	createAnalysisComment(Integer analysisId, CommentBase commentBase)	Create a comment for this analysis Creates a comment associated with a specified analysis).
okhttp3.Call	createAnalysisCommentAsync(Integer analysisId, CommentBase commentBase, ApiCallback<BaseResponseCommentResponse> _callback)	Create a comment for this analysis (asynchronously) Creates a comment associated with a specified analysis).
okhttp3.Call	createAnalysisCommentCall(Integer analysisId, CommentBase commentBase, ApiCallback _callback)	Build call for createAnalysisComment
ApiResponse<BaseResponseCommentResponse>	createAnalysisCommentWithHttpInfo(Integer analysisId, CommentBase commentBase)	Create a comment for this analysis Creates a comment associated with a specified analysis).
BaseResponseBool	deleteAnalysisComment(Integer commentId, Integer analysisId)	Delete a comment Deletes an existing comment.
okhttp3.Call	deleteAnalysisCommentAsync(Integer commentId, Integer analysisId, ApiCallback<BaseResponseBool> _callback)	Delete a comment (asynchronously) Deletes an existing comment.
okhttp3.Call	deleteAnalysisCommentCall(Integer commentId, Integer analysisId, ApiCallback _callback)	Build call for deleteAnalysisComment
ApiResponse<BaseResponseBool>	deleteAnalysisCommentWithHttpInfo(Integer commentId, Integer analysisId)	Delete a comment Deletes an existing comment.
BaseResponseListCommentResponse	getAnalysisComments(Integer analysisId)	Get comments for this analysis Retrieves all comments created for a specific analysis.
okhttp3.Call	getAnalysisCommentsAsync(Integer analysisId, ApiCallback<BaseResponseListCommentResponse> _callback)	Get comments for this analysis (asynchronously) Retrieves all comments created for a specific analysis.
okhttp3.Call	getAnalysisCommentsCall(Integer analysisId, ApiCallback _callback)	Build call for getAnalysisComments
ApiResponse<BaseResponseListCommentResponse>	getAnalysisCommentsWithHttpInfo(Integer analysisId)	Get comments for this analysis Retrieves all comments created for a specific analysis.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
BaseResponseCommentResponse	updateAnalysisComment(Integer commentId, Integer analysisId, CommentUpdateRequest commentUpdateRequest)	Update a comment Updates the content of an existing comment.
okhttp3.Call	updateAnalysisCommentAsync(Integer commentId, Integer analysisId, CommentUpdateRequest commentUpdateRequest, ApiCallback<BaseResponseCommentResponse> _callback)	Update a comment (asynchronously) Updates the content of an existing comment.
okhttp3.Call	updateAnalysisCommentCall(Integer commentId, Integer analysisId, CommentUpdateRequest commentUpdateRequest, ApiCallback _callback)	Build call for updateAnalysisComment
ApiResponse<BaseResponseCommentResponse>	updateAnalysisCommentWithHttpInfo(Integer commentId, Integer analysisId, CommentUpdateRequest commentUpdateRequest)	Update a comment Updates the content of an existing comment.

Methods inherited from class java.lang.Object

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

Constructor Details

AnalysesCommentsApi

public AnalysesCommentsApi()

AnalysesCommentsApi

public AnalysesCommentsApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createAnalysisCommentCall

public okhttp3.Call createAnalysisCommentCall(@Nonnull
 Integer analysisId,
 @Nonnull
 CommentBase commentBase,
 ApiCallback _callback)
                                       throws ApiException

Build call for createAnalysisComment

Parameters:

analysisId - (required)

commentBase - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
201	Successful Response	-
422	Invalid request parameters	-
400	Bad Request	-

createAnalysisComment

public BaseResponseCommentResponse createAnalysisComment(@Nonnull
 Integer analysisId,
 @Nonnull
 CommentBase commentBase)
                                                  throws ApiException

Create a comment for this analysis Creates a comment associated with a specified analysis).

Parameters:

analysisId - (required)

commentBase - (required)

Returns:

BaseResponseCommentResponse

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
201	Successful Response	-
422	Invalid request parameters	-
400	Bad Request	-

createAnalysisCommentWithHttpInfo

public ApiResponse<BaseResponseCommentResponse> createAnalysisCommentWithHttpInfo(@Nonnull
 Integer analysisId,
 @Nonnull
 CommentBase commentBase)
                                                                           throws ApiException

Create a comment for this analysis Creates a comment associated with a specified analysis).

Parameters:

analysisId - (required)

commentBase - (required)

Returns:

ApiResponse<BaseResponseCommentResponse>

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
201	Successful Response	-
422	Invalid request parameters	-
400	Bad Request	-

createAnalysisCommentAsync

public okhttp3.Call createAnalysisCommentAsync(@Nonnull
 Integer analysisId,
 @Nonnull
 CommentBase commentBase,
 ApiCallback<BaseResponseCommentResponse> _callback)
                                        throws ApiException

Create a comment for this analysis (asynchronously) Creates a comment associated with a specified analysis).

Parameters:

analysisId - (required)

commentBase - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
201	Successful Response	-
422	Invalid request parameters	-
400	Bad Request	-

deleteAnalysisCommentCall

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

Build call for deleteAnalysisComment

Parameters:

commentId - (required)

analysisId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-
403	You can only delete your own comments	-
400	Bad Request	-

deleteAnalysisComment

public BaseResponseBool deleteAnalysisComment(@Nonnull
 Integer commentId,
 @Nonnull
 Integer analysisId)
                                       throws ApiException

Delete a comment Deletes an existing comment. Users can only delete their own comments.

Parameters:

commentId - (required)

analysisId - (required)

Returns:

BaseResponseBool

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-
403	You can only delete your own comments	-
400	Bad Request	-

deleteAnalysisCommentWithHttpInfo

public ApiResponse<BaseResponseBool> deleteAnalysisCommentWithHttpInfo(@Nonnull
 Integer commentId,
 @Nonnull
 Integer analysisId)
                                                                throws ApiException

Delete a comment Deletes an existing comment. Users can only delete their own comments.

Parameters:

commentId - (required)

analysisId - (required)

Returns:

ApiResponse<BaseResponseBool>

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-
403	You can only delete your own comments	-
400	Bad Request	-

deleteAnalysisCommentAsync

public okhttp3.Call deleteAnalysisCommentAsync(@Nonnull
 Integer commentId,
 @Nonnull
 Integer analysisId,
 ApiCallback<BaseResponseBool> _callback)
                                        throws ApiException

Delete a comment (asynchronously) Deletes an existing comment. Users can only delete their own comments.

Parameters:

commentId - (required)

analysisId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-
403	You can only delete your own comments	-
400	Bad Request	-

getAnalysisCommentsCall

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

Build call for getAnalysisComments

Parameters:

analysisId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

getAnalysisComments

public BaseResponseListCommentResponse getAnalysisComments(@Nonnull
 Integer analysisId)
                                                    throws ApiException

Get comments for this analysis Retrieves all comments created for a specific analysis. Only returns comments for resources the requesting user has access to.

Parameters:

analysisId - (required)

Returns:

BaseResponseListCommentResponse

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

getAnalysisCommentsWithHttpInfo

public ApiResponse<BaseResponseListCommentResponse> getAnalysisCommentsWithHttpInfo(@Nonnull
 Integer analysisId)
                                                                             throws ApiException

Get comments for this analysis Retrieves all comments created for a specific analysis. Only returns comments for resources the requesting user has access to.

Parameters:

analysisId - (required)

Returns:

ApiResponse<BaseResponseListCommentResponse>

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

getAnalysisCommentsAsync

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

Get comments for this analysis (asynchronously) Retrieves all comments created for a specific analysis. Only returns comments for resources the requesting user has access to.

Parameters:

analysisId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

updateAnalysisCommentCall

public okhttp3.Call updateAnalysisCommentCall(@Nonnull
 Integer commentId,
 @Nonnull
 Integer analysisId,
 @Nonnull
 CommentUpdateRequest commentUpdateRequest,
 ApiCallback _callback)
                                       throws ApiException

Build call for updateAnalysisComment

Parameters:

commentId - (required)

analysisId - (required)

commentUpdateRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-
403	You can only update your own comments	-
400	Bad Request	-

updateAnalysisComment

public BaseResponseCommentResponse updateAnalysisComment(@Nonnull
 Integer commentId,
 @Nonnull
 Integer analysisId,
 @Nonnull
 CommentUpdateRequest commentUpdateRequest)
                                                  throws ApiException

Update a comment Updates the content of an existing comment. Users can only update their own comments.

Parameters:

commentId - (required)

analysisId - (required)

commentUpdateRequest - (required)

Returns:

BaseResponseCommentResponse

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-
403	You can only update your own comments	-
400	Bad Request	-

updateAnalysisCommentWithHttpInfo

public ApiResponse<BaseResponseCommentResponse> updateAnalysisCommentWithHttpInfo(@Nonnull
 Integer commentId,
 @Nonnull
 Integer analysisId,
 @Nonnull
 CommentUpdateRequest commentUpdateRequest)
                                                                           throws ApiException

Update a comment Updates the content of an existing comment. Users can only update their own comments.

Parameters:

commentId - (required)

analysisId - (required)

commentUpdateRequest - (required)

Returns:

ApiResponse<BaseResponseCommentResponse>

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-
403	You can only update your own comments	-
400	Bad Request	-

updateAnalysisCommentAsync

public okhttp3.Call updateAnalysisCommentAsync(@Nonnull
 Integer commentId,
 @Nonnull
 Integer analysisId,
 @Nonnull
 CommentUpdateRequest commentUpdateRequest,
 ApiCallback<BaseResponseCommentResponse> _callback)
                                        throws ApiException

Update a comment (asynchronously) Updates the content of an existing comment. Users can only update their own comments.

Parameters:

commentId - (required)

analysisId - (required)

commentUpdateRequest - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-
403	You can only update your own comments	-
400	Bad Request	-