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

Class PolicyAdherenceApi

java.lang.Object

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

public class PolicyAdherenceApi
extends Object

Constructor Summary

Constructors

Constructor	Description
PolicyAdherenceApi()
PolicyAdherenceApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
PolicyAdherenceDetailsDTO	getPolicyAdherenceByPolicyId(String policyId)	Retrieve adherence details for a specific policy Retrieve adherence details associated with a specific governance policy within the organization using its unique ID.
okhttp3.Call	getPolicyAdherenceByPolicyIdAsync(String policyId, ApiCallback<PolicyAdherenceDetailsDTO> _callback)	Retrieve adherence details for a specific policy (asynchronously) Retrieve adherence details associated with a specific governance policy within the organization using its unique ID.
okhttp3.Call	getPolicyAdherenceByPolicyIdCall(String policyId, ApiCallback _callback)	Build call for getPolicyAdherenceByPolicyId
ApiResponse<PolicyAdherenceDetailsDTO>	getPolicyAdherenceByPolicyIdWithHttpInfo(String policyId)	Retrieve adherence details for a specific policy Retrieve adherence details associated with a specific governance policy within the organization using its unique ID.
PolicyAdherenceListDTO	getPolicyAdherenceForAllPolicies(Integer limit, Integer offset)	Retrieve adherence status for all policies Retrieve adherence status of all governance policies within the organization.
okhttp3.Call	getPolicyAdherenceForAllPoliciesAsync(Integer limit, Integer offset, ApiCallback<PolicyAdherenceListDTO> _callback)	Retrieve adherence status for all policies (asynchronously) Retrieve adherence status of all governance policies within the organization.
okhttp3.Call	getPolicyAdherenceForAllPoliciesCall(Integer limit, Integer offset, ApiCallback _callback)	Build call for getPolicyAdherenceForAllPolicies
ApiResponse<PolicyAdherenceListDTO>	getPolicyAdherenceForAllPoliciesWithHttpInfo(Integer limit, Integer offset)	Retrieve adherence status for all policies Retrieve adherence status of all governance policies within the organization.
PolicyAdherenceSummaryDTO	getPolicyAdherenceSummary()	Retrieves the summary of adherence for all policies Retrieves the summary of adherence for all governance policies within the organization.
okhttp3.Call	getPolicyAdherenceSummaryAsync(ApiCallback<PolicyAdherenceSummaryDTO> _callback)	Retrieves the summary of adherence for all policies (asynchronously) Retrieves the summary of adherence for all governance policies within the organization.
okhttp3.Call	getPolicyAdherenceSummaryCall(ApiCallback _callback)	Build call for getPolicyAdherenceSummary
ApiResponse<PolicyAdherenceSummaryDTO>	getPolicyAdherenceSummaryWithHttpInfo()	Retrieves the summary of adherence for all policies Retrieves the summary of adherence for all governance policies within the organization.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

PolicyAdherenceApi

public PolicyAdherenceApi()

PolicyAdherenceApi

public PolicyAdherenceApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getPolicyAdherenceByPolicyIdCall

public okhttp3.Call getPolicyAdherenceByPolicyIdCall(String policyId,
                                                     ApiCallback _callback)
                                              throws ApiException

Build call for getPolicyAdherenceByPolicyId

Parameters:

policyId - **UUID** of the Policy. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getPolicyAdherenceByPolicyId

public PolicyAdherenceDetailsDTO getPolicyAdherenceByPolicyId(String policyId)
                                                       throws ApiException

Retrieve adherence details for a specific policy Retrieve adherence details associated with a specific governance policy within the organization using its unique ID. The list of artifacts under the policy will only contain the artifacts visible to user

Parameters:

policyId - **UUID** of the Policy. (required)

Returns:

PolicyAdherenceDetailsDTO

Throws:

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

getPolicyAdherenceByPolicyIdWithHttpInfo

public ApiResponse<PolicyAdherenceDetailsDTO> getPolicyAdherenceByPolicyIdWithHttpInfo(String policyId)
                                                                                throws ApiException

Retrieve adherence details for a specific policy Retrieve adherence details associated with a specific governance policy within the organization using its unique ID. The list of artifacts under the policy will only contain the artifacts visible to user

Parameters:

policyId - **UUID** of the Policy. (required)

Returns:

ApiResponse<PolicyAdherenceDetailsDTO>

Throws:

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

getPolicyAdherenceByPolicyIdAsync

public okhttp3.Call getPolicyAdherenceByPolicyIdAsync(String policyId,
                                                      ApiCallback<PolicyAdherenceDetailsDTO> _callback)
                                               throws ApiException

Retrieve adherence details for a specific policy (asynchronously) Retrieve adherence details associated with a specific governance policy within the organization using its unique ID. The list of artifacts under the policy will only contain the artifacts visible to user

Parameters:

policyId - **UUID** of the Policy. (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

getPolicyAdherenceForAllPoliciesCall

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

Build call for getPolicyAdherenceForAllPolicies

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

getPolicyAdherenceForAllPolicies

public PolicyAdherenceListDTO getPolicyAdherenceForAllPolicies(Integer limit,
                                                               Integer offset)
                                                        throws ApiException

Retrieve adherence status for all policies Retrieve adherence status of all governance policies within the organization.

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:

PolicyAdherenceListDTO

Throws:

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

getPolicyAdherenceForAllPoliciesWithHttpInfo

public ApiResponse<PolicyAdherenceListDTO> getPolicyAdherenceForAllPoliciesWithHttpInfo(Integer limit,
                                                                                        Integer offset)
                                                                                 throws ApiException

Retrieve adherence status for all policies Retrieve adherence status of all governance policies within the organization.

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<PolicyAdherenceListDTO>

Throws:

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

getPolicyAdherenceForAllPoliciesAsync

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

Retrieve adherence status for all policies (asynchronously) Retrieve adherence status of all governance policies within the organization.

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

getPolicyAdherenceSummaryCall

public okhttp3.Call getPolicyAdherenceSummaryCall(ApiCallback _callback)
                                           throws ApiException

Build call for getPolicyAdherenceSummary

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getPolicyAdherenceSummary

public PolicyAdherenceSummaryDTO getPolicyAdherenceSummary()
                                                    throws ApiException

Retrieves the summary of adherence for all policies Retrieves the summary of adherence for all governance policies within the organization.

Returns:

PolicyAdherenceSummaryDTO

Throws:

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

getPolicyAdherenceSummaryWithHttpInfo

public ApiResponse<PolicyAdherenceSummaryDTO> getPolicyAdherenceSummaryWithHttpInfo()
                                                                             throws ApiException

Retrieves the summary of adherence for all policies Retrieves the summary of adherence for all governance policies within the organization.

Returns:

ApiResponse<PolicyAdherenceSummaryDTO>

Throws:

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

getPolicyAdherenceSummaryAsync

public okhttp3.Call getPolicyAdherenceSummaryAsync(ApiCallback<PolicyAdherenceSummaryDTO> _callback)
                                            throws ApiException

Retrieves the summary of adherence for all policies (asynchronously) Retrieves the summary of adherence for all governance policies within the organization.

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