org.openapitools.client.api

Class PolicyApi

java.lang.Object

org.openapitools.client.api.PolicyApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-02-10T11:07:35.698-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.PolicyApi")
public class PolicyApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PolicyApi()
PolicyApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	activatePolicy(String policyId) Activate a Policy Activates a policy
void	activatePolicyRule(String policyId, String ruleId) Activate a Policy Rule Activates a policy rule
Policy	clonePolicy(String policyId) Clone an existing policy Clones an existing policy
PagedList	clonePolicyWithPaginationInfo(String policyId) Clone an existing policy Clones an existing policy
<T> T	createPolicy(Class<?> T, Policy policy, Boolean activate) Create a Policy Creates a policy
Policy	createPolicy(Policy policy, Boolean activate) Create a Policy Creates a policy
<T> T	createPolicyRule(Class<?> T, String policyId, PolicyRule policyRule) Create a Policy Rule Creates a policy rule
PolicyRule	createPolicyRule(String policyId, PolicyRule policyRule) Create a Policy Rule Creates a policy rule
PagedList	createPolicyRuleWithPaginationInfo(String policyId, PolicyRule policyRule) Create a Policy Rule Creates a policy rule
PagedList	createPolicyWithPaginationInfo(Policy policy, Boolean activate) Create a Policy Creates a policy
void	deactivatePolicy(String policyId) Deactivate a Policy Deactivates a policy
void	deactivatePolicyRule(String policyId, String ruleId) Deactivate a Policy Rule Deactivates a policy rule
void	deletePolicy(String policyId) Delete a Policy Deletes a policy
void	deletePolicyRule(String policyId, String ruleId) Delete a Policy Rule Deletes a policy rule
ApiClient	getApiClient()
Policy	getPolicy(String policyId, String expand) Retrieve a Policy Retrieves a policy
PolicyRule	getPolicyRule(String policyId, String ruleId) Retrieve a Policy Rule Retrieves a policy rule
PagedList	getPolicyRuleWithPaginationInfo(String policyId, String ruleId) Retrieve a Policy Rule Retrieves a policy rule
PagedList	getPolicyWithPaginationInfo(String policyId, String expand) Retrieve a Policy Retrieves a policy
List<Policy>	listPolicies(String type, String status, String expand) List all Policies Lists all policies with the specified type
PagedList	listPoliciesWithPaginationInfo(String type, String status, String expand) List all Policies Lists all policies with the specified type
List<PolicyRule>	listPolicyRules(String policyId) List all Policy Rules Lists all policy rules
PagedList	listPolicyRulesWithPaginationInfo(String policyId) List all Policy Rules Lists all policy rules
<T> T	replacePolicy(Class<?> T, String policyId, Policy policy) Replace a Policy Replaces a policy
Policy	replacePolicy(String policyId, Policy policy) Replace a Policy Replaces a policy
<T> T	replacePolicyRule(Class<?> T, String policyId, String ruleId, PolicyRule policyRule) Replace a Policy Rule Replaces a policy rules
PolicyRule	replacePolicyRule(String policyId, String ruleId, PolicyRule policyRule) Replace a Policy Rule Replaces a policy rules
PagedList	replacePolicyRuleWithPaginationInfo(String policyId, String ruleId, PolicyRule policyRule) Replace a Policy Rule Replaces a policy rules
PagedList	replacePolicyWithPaginationInfo(String policyId, Policy policy) Replace a Policy Replaces a policy
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

PolicyApi

public PolicyApi()

PolicyApi

@Autowired
public PolicyApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activatePolicy

public void activatePolicy(String policyId)
                    throws org.springframework.web.client.RestClientException

Activate a Policy Activates a policy

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

activatePolicyRule

public void activatePolicyRule(String policyId,
                               String ruleId)
                        throws org.springframework.web.client.RestClientException

Activate a Policy Rule Activates a policy rule

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

ruleId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

clonePolicy

public Policy clonePolicy(String policyId)
                   throws org.springframework.web.client.RestClientException

Clone an existing policy Clones an existing policy

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

Returns:

Policy

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

clonePolicyWithPaginationInfo

public PagedList clonePolicyWithPaginationInfo(String policyId)
                                        throws org.springframework.web.client.RestClientException

Clone an existing policy Clones an existing policy

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

Returns:

ResponseEntity<Policy>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createPolicy

public Policy createPolicy(Policy policy,
                           Boolean activate)
                    throws org.springframework.web.client.RestClientException

Create a Policy Creates a policy

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

policy - (required)

activate - (optional, default to true)

Returns:

Policy

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createPolicy

public <T> T createPolicy(Class<?> T,
                          Policy policy,
                          Boolean activate)
                   throws org.springframework.web.client.RestClientException

Create a Policy Creates a policy

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

policy - (required)

activate - (optional, default to true)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createPolicyWithPaginationInfo

public PagedList createPolicyWithPaginationInfo(Policy policy,
                                                Boolean activate)
                                         throws org.springframework.web.client.RestClientException

Create a Policy Creates a policy

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

policy - (required)

activate - (optional, default to true)

Returns:

ResponseEntity<Policy>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createPolicyRule

public PolicyRule createPolicyRule(String policyId,
                                   PolicyRule policyRule)
                            throws org.springframework.web.client.RestClientException

Create a Policy Rule Creates a policy rule

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

policyRule - (required)

Returns:

PolicyRule

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createPolicyRule

public <T> T createPolicyRule(Class<?> T,
                              String policyId,
                              PolicyRule policyRule)
                       throws org.springframework.web.client.RestClientException

Create a Policy Rule Creates a policy rule

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

policyId - (required)

policyRule - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createPolicyRuleWithPaginationInfo

public PagedList createPolicyRuleWithPaginationInfo(String policyId,
                                                    PolicyRule policyRule)
                                             throws org.springframework.web.client.RestClientException

Create a Policy Rule Creates a policy rule

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

policyRule - (required)

Returns:

ResponseEntity<PolicyRule>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deactivatePolicy

public void deactivatePolicy(String policyId)
                      throws org.springframework.web.client.RestClientException

Deactivate a Policy Deactivates a policy

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deactivatePolicyRule

public void deactivatePolicyRule(String policyId,
                                 String ruleId)
                          throws org.springframework.web.client.RestClientException

Deactivate a Policy Rule Deactivates a policy rule

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

ruleId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deletePolicy

public void deletePolicy(String policyId)
                  throws org.springframework.web.client.RestClientException

Delete a Policy Deletes a policy

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deletePolicyRule

public void deletePolicyRule(String policyId,
                             String ruleId)
                      throws org.springframework.web.client.RestClientException

Delete a Policy Rule Deletes a policy rule

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

ruleId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getPolicy

public Policy getPolicy(String policyId,
                        String expand)
                 throws org.springframework.web.client.RestClientException

Retrieve a Policy Retrieves a policy

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

expand - (optional, default to )

Returns:

Policy

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getPolicyWithPaginationInfo

public PagedList getPolicyWithPaginationInfo(String policyId,
                                             String expand)
                                      throws org.springframework.web.client.RestClientException

Retrieve a Policy Retrieves a policy

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

expand - (optional, default to )

Returns:

ResponseEntity<Policy>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getPolicyRule

public PolicyRule getPolicyRule(String policyId,
                                String ruleId)
                         throws org.springframework.web.client.RestClientException

Retrieve a Policy Rule Retrieves a policy rule

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

ruleId - (required)

Returns:

PolicyRule

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getPolicyRuleWithPaginationInfo

public PagedList getPolicyRuleWithPaginationInfo(String policyId,
                                                 String ruleId)
                                          throws org.springframework.web.client.RestClientException

Retrieve a Policy Rule Retrieves a policy rule

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

ruleId - (required)

Returns:

ResponseEntity<PolicyRule>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listPolicies

public List<Policy> listPolicies(String type,
                                 String status,
                                 String expand)
                          throws org.springframework.web.client.RestClientException

List all Policies Lists all policies with the specified type

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

type - (required)

status - (optional)

expand - (optional, default to )

Returns:

List<Policy>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listPoliciesWithPaginationInfo

public PagedList listPoliciesWithPaginationInfo(String type,
                                                String status,
                                                String expand)
                                         throws org.springframework.web.client.RestClientException

List all Policies Lists all policies with the specified type

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

type - (required)

status - (optional)

expand - (optional, default to )

Returns:

ResponseEntity<List<Policy>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listPolicyRules

public List<PolicyRule> listPolicyRules(String policyId)
                                 throws org.springframework.web.client.RestClientException

List all Policy Rules Lists all policy rules

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

Returns:

List<PolicyRule>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listPolicyRulesWithPaginationInfo

public PagedList listPolicyRulesWithPaginationInfo(String policyId)
                                            throws org.springframework.web.client.RestClientException

List all Policy Rules Lists all policy rules

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

Returns:

ResponseEntity<List<PolicyRule>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replacePolicy

public Policy replacePolicy(String policyId,
                            Policy policy)
                     throws org.springframework.web.client.RestClientException

Replace a Policy Replaces a policy

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

policy - (required)

Returns:

Policy

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replacePolicy

public <T> T replacePolicy(Class<?> T,
                           String policyId,
                           Policy policy)
                    throws org.springframework.web.client.RestClientException

Replace a Policy Replaces a policy

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

policyId - (required)

policy - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replacePolicyWithPaginationInfo

public PagedList replacePolicyWithPaginationInfo(String policyId,
                                                 Policy policy)
                                          throws org.springframework.web.client.RestClientException

Replace a Policy Replaces a policy

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

policy - (required)

Returns:

ResponseEntity<Policy>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replacePolicyRule

public PolicyRule replacePolicyRule(String policyId,
                                    String ruleId,
                                    PolicyRule policyRule)
                             throws org.springframework.web.client.RestClientException

Replace a Policy Rule Replaces a policy rules

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

ruleId - (required)

policyRule - (required)

Returns:

PolicyRule

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replacePolicyRule

public <T> T replacePolicyRule(Class<?> T,
                               String policyId,
                               String ruleId,
                               PolicyRule policyRule)
                        throws org.springframework.web.client.RestClientException

Replace a Policy Rule Replaces a policy rules

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

policyId - (required)

ruleId - (required)

policyRule - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replacePolicyRuleWithPaginationInfo

public PagedList replacePolicyRuleWithPaginationInfo(String policyId,
                                                     String ruleId,
                                                     PolicyRule policyRule)
                                              throws org.springframework.web.client.RestClientException

Replace a Policy Rule Replaces a policy rules

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

policyId - (required)

ruleId - (required)

policyRule - (required)

Returns:

ResponseEntity<PolicyRule>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API