Package org.wso2.am.integration.clients.governance.api

Class ArtifactComplianceApi

java.lang.Object

org.wso2.am.integration.clients.governance.api.ArtifactComplianceApi

public class ArtifactComplianceApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ArtifactComplianceApi()
ArtifactComplianceApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
ArtifactComplianceDetailsDTO	getComplianceByAPIId(String apiId)	Retrieve compliance details for a specific API Retrieve compliance details associated with a specific API using its unique UUID.
okhttp3.Call	getComplianceByAPIIdAsync(String apiId, ApiCallback<ArtifactComplianceDetailsDTO> _callback)	Retrieve compliance details for a specific API (asynchronously) Retrieve compliance details associated with a specific API using its unique UUID.
okhttp3.Call	getComplianceByAPIIdCall(String apiId, ApiCallback _callback)	Build call for getComplianceByAPIId
ApiResponse<ArtifactComplianceDetailsDTO>	getComplianceByAPIIdWithHttpInfo(String apiId)	Retrieve compliance details for a specific API Retrieve compliance details associated with a specific API using its unique UUID.
ArtifactComplianceListDTO	getComplianceStatusListOfAPIs(Integer limit, Integer offset)	Retrieves compliance of all API artifacts Retrieves compliance of all API artifacts within the organization visible to logged-in user.
okhttp3.Call	getComplianceStatusListOfAPIsAsync(Integer limit, Integer offset, ApiCallback<ArtifactComplianceListDTO> _callback)	Retrieves compliance of all API artifacts (asynchronously) Retrieves compliance of all API artifacts within the organization visible to logged-in user.
okhttp3.Call	getComplianceStatusListOfAPIsCall(Integer limit, Integer offset, ApiCallback _callback)	Build call for getComplianceStatusListOfAPIs
ApiResponse<ArtifactComplianceListDTO>	getComplianceStatusListOfAPIsWithHttpInfo(Integer limit, Integer offset)	Retrieves compliance of all API artifacts Retrieves compliance of all API artifacts within the organization visible to logged-in user.
ArtifactComplianceSummaryDTO	getComplianceSummaryForAPIs()	Retrieves the summary of compliance of all API artifacts Retrieves the summary of compliance of all API artifacts within the organization visible to logged-in user.
okhttp3.Call	getComplianceSummaryForAPIsAsync(ApiCallback<ArtifactComplianceSummaryDTO> _callback)	Retrieves the summary of compliance of all API artifacts (asynchronously) Retrieves the summary of compliance of all API artifacts within the organization visible to logged-in user.
okhttp3.Call	getComplianceSummaryForAPIsCall(ApiCallback _callback)	Build call for getComplianceSummaryForAPIs
ApiResponse<ArtifactComplianceSummaryDTO>	getComplianceSummaryForAPIsWithHttpInfo()	Retrieves the summary of compliance of all API artifacts Retrieves the summary of compliance of all API artifacts within the organization visible to logged-in user.
RulesetValidationResultDTO	getRulesetValidationResultsByAPIId(String apiId, String rulesetId)	Retrieve ruleset validation results for a specific API Retrieve ruleset validation results associated with a specific API using its unique UUID.
okhttp3.Call	getRulesetValidationResultsByAPIIdAsync(String apiId, String rulesetId, ApiCallback<RulesetValidationResultDTO> _callback)	Retrieve ruleset validation results for a specific API (asynchronously) Retrieve ruleset validation results associated with a specific API using its unique UUID.
okhttp3.Call	getRulesetValidationResultsByAPIIdCall(String apiId, String rulesetId, ApiCallback _callback)	Build call for getRulesetValidationResultsByAPIId
ApiResponse<RulesetValidationResultDTO>	getRulesetValidationResultsByAPIIdWithHttpInfo(String apiId, String rulesetId)	Retrieve ruleset validation results for a specific API Retrieve ruleset validation results associated with a specific API using its unique UUID.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ArtifactComplianceApi

public ArtifactComplianceApi()

ArtifactComplianceApi

public ArtifactComplianceApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getComplianceByAPIIdCall

public okhttp3.Call getComplianceByAPIIdCall(String apiId,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for getComplianceByAPIId

Parameters:

apiId - **UUID** of the API. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getComplianceByAPIId

public ArtifactComplianceDetailsDTO getComplianceByAPIId(String apiId)
                                                  throws ApiException

Retrieve compliance details for a specific API Retrieve compliance details associated with a specific API using its unique UUID.

Parameters:

apiId - **UUID** of the API. (required)

Returns:

ArtifactComplianceDetailsDTO

Throws:

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

getComplianceByAPIIdWithHttpInfo

public ApiResponse<ArtifactComplianceDetailsDTO> getComplianceByAPIIdWithHttpInfo(String apiId)
                                                                           throws ApiException

Retrieve compliance details for a specific API Retrieve compliance details associated with a specific API using its unique UUID.

Parameters:

apiId - **UUID** of the API. (required)

Returns:

ApiResponse<ArtifactComplianceDetailsDTO>

Throws:

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

getComplianceByAPIIdAsync

public okhttp3.Call getComplianceByAPIIdAsync(String apiId,
                                              ApiCallback<ArtifactComplianceDetailsDTO> _callback)
                                       throws ApiException

Retrieve compliance details for a specific API (asynchronously) Retrieve compliance details associated with a specific API using its unique UUID.

Parameters:

apiId - **UUID** of the API. (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

getComplianceStatusListOfAPIsCall

public okhttp3.Call getComplianceStatusListOfAPIsCall(Integer limit,
                                                      Integer offset,
                                                      ApiCallback _callback)
                                               throws ApiException

Build call for getComplianceStatusListOfAPIs

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getComplianceStatusListOfAPIs

public ArtifactComplianceListDTO getComplianceStatusListOfAPIs(Integer limit,
                                                               Integer offset)
                                                        throws ApiException

Retrieves compliance of all API artifacts Retrieves compliance of all API artifacts within the organization visible to logged-in user.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

Returns:

ArtifactComplianceListDTO

Throws:

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

getComplianceStatusListOfAPIsWithHttpInfo

public ApiResponse<ArtifactComplianceListDTO> getComplianceStatusListOfAPIsWithHttpInfo(Integer limit,
                                                                                        Integer offset)
                                                                                 throws ApiException

Retrieves compliance of all API artifacts Retrieves compliance of all API artifacts within the organization visible to logged-in user.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

Returns:

ApiResponse<ArtifactComplianceListDTO>

Throws:

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

getComplianceStatusListOfAPIsAsync

public okhttp3.Call getComplianceStatusListOfAPIsAsync(Integer limit,
                                                       Integer offset,
                                                       ApiCallback<ArtifactComplianceListDTO> _callback)
                                                throws ApiException

Retrieves compliance of all API artifacts (asynchronously) Retrieves compliance of all API artifacts within the organization visible to logged-in user.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

_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

getComplianceSummaryForAPIsCall

public okhttp3.Call getComplianceSummaryForAPIsCall(ApiCallback _callback)
                                             throws ApiException

Build call for getComplianceSummaryForAPIs

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getComplianceSummaryForAPIs

public ArtifactComplianceSummaryDTO getComplianceSummaryForAPIs()
                                                         throws ApiException

Retrieves the summary of compliance of all API artifacts Retrieves the summary of compliance of all API artifacts within the organization visible to logged-in user.

Returns:

ArtifactComplianceSummaryDTO

Throws:

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

getComplianceSummaryForAPIsWithHttpInfo

public ApiResponse<ArtifactComplianceSummaryDTO> getComplianceSummaryForAPIsWithHttpInfo()
                                                                                  throws ApiException

Retrieves the summary of compliance of all API artifacts Retrieves the summary of compliance of all API artifacts within the organization visible to logged-in user.

Returns:

ApiResponse<ArtifactComplianceSummaryDTO>

Throws:

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

getComplianceSummaryForAPIsAsync

public okhttp3.Call getComplianceSummaryForAPIsAsync(ApiCallback<ArtifactComplianceSummaryDTO> _callback)
                                              throws ApiException

Retrieves the summary of compliance of all API artifacts (asynchronously) Retrieves the summary of compliance of all API artifacts within the organization visible to logged-in user.

Parameters:

_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

getRulesetValidationResultsByAPIIdCall

public okhttp3.Call getRulesetValidationResultsByAPIIdCall(String apiId,
                                                           String rulesetId,
                                                           ApiCallback _callback)
                                                    throws ApiException

Build call for getRulesetValidationResultsByAPIId

Parameters:

apiId - **UUID** of the API. (required)

rulesetId - **UUID** of the Ruleset. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getRulesetValidationResultsByAPIId

public RulesetValidationResultDTO getRulesetValidationResultsByAPIId(String apiId,
                                                                     String rulesetId)
                                                              throws ApiException

Retrieve ruleset validation results for a specific API Retrieve ruleset validation results associated with a specific API using its unique UUID.

Parameters:

apiId - **UUID** of the API. (required)

rulesetId - **UUID** of the Ruleset. (required)

Returns:

RulesetValidationResultDTO

Throws:

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

getRulesetValidationResultsByAPIIdWithHttpInfo

public ApiResponse<RulesetValidationResultDTO> getRulesetValidationResultsByAPIIdWithHttpInfo(String apiId,
                                                                                              String rulesetId)
                                                                                       throws ApiException

Retrieve ruleset validation results for a specific API Retrieve ruleset validation results associated with a specific API using its unique UUID.

Parameters:

apiId - **UUID** of the API. (required)

rulesetId - **UUID** of the Ruleset. (required)

Returns:

ApiResponse<RulesetValidationResultDTO>

Throws:

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

getRulesetValidationResultsByAPIIdAsync

public okhttp3.Call getRulesetValidationResultsByAPIIdAsync(String apiId,
                                                            String rulesetId,
                                                            ApiCallback<RulesetValidationResultDTO> _callback)
                                                     throws ApiException

Retrieve ruleset validation results for a specific API (asynchronously) Retrieve ruleset validation results associated with a specific API using its unique UUID.

Parameters:

apiId - **UUID** of the API. (required)

rulesetId - **UUID** of the Ruleset. (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