com.oracle.bmc.governancerulescontrolplane

Interface GovernanceRuleAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

GovernanceRuleAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220504")
public interface GovernanceRuleAsync
extends AutoCloseable

A description of the GovernanceRulesControlPlane API

Method Summary

Modifier and Type	Method and Description
Future<CreateGovernanceRuleResponse>	createGovernanceRule(CreateGovernanceRuleRequest request, AsyncHandler<CreateGovernanceRuleRequest,CreateGovernanceRuleResponse> handler) Create governance rule in the root compartment only.
Future<CreateInclusionCriterionResponse>	createInclusionCriterion(CreateInclusionCriterionRequest request, AsyncHandler<CreateInclusionCriterionRequest,CreateInclusionCriterionResponse> handler) Create inclusion criterion of type tenancy or tag for the governance rule.
Future<DeleteGovernanceRuleResponse>	deleteGovernanceRule(DeleteGovernanceRuleRequest request, AsyncHandler<DeleteGovernanceRuleRequest,DeleteGovernanceRuleResponse> handler) Delete the specified governance rule.
Future<DeleteInclusionCriterionResponse>	deleteInclusionCriterion(DeleteInclusionCriterionRequest request, AsyncHandler<DeleteInclusionCriterionRequest,DeleteInclusionCriterionResponse> handler) Delete the specified inclusion criterion.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetEnforcedGovernanceRuleResponse>	getEnforcedGovernanceRule(GetEnforcedGovernanceRuleRequest request, AsyncHandler<GetEnforcedGovernanceRuleRequest,GetEnforcedGovernanceRuleResponse> handler) Get the specified enforced governance rule’s information.
Future<GetGovernanceRuleResponse>	getGovernanceRule(GetGovernanceRuleRequest request, AsyncHandler<GetGovernanceRuleRequest,GetGovernanceRuleResponse> handler) Get the specified governance rule’s information.
Future<GetInclusionCriterionResponse>	getInclusionCriterion(GetInclusionCriterionRequest request, AsyncHandler<GetInclusionCriterionRequest,GetInclusionCriterionResponse> handler) Get the specified inclusion criterion’s information.
Future<GetTenancyAttachmentResponse>	getTenancyAttachment(GetTenancyAttachmentRequest request, AsyncHandler<GetTenancyAttachmentRequest,GetTenancyAttachmentResponse> handler) Get the specified tenancy attachment’s information.
Future<ListEnforcedGovernanceRulesResponse>	listEnforcedGovernanceRules(ListEnforcedGovernanceRulesRequest request, AsyncHandler<ListEnforcedGovernanceRulesRequest,ListEnforcedGovernanceRulesResponse> handler) List enforced governance rules.
Future<ListGovernanceRulesResponse>	listGovernanceRules(ListGovernanceRulesRequest request, AsyncHandler<ListGovernanceRulesRequest,ListGovernanceRulesResponse> handler) List governance rules.
Future<ListInclusionCriteriaResponse>	listInclusionCriteria(ListInclusionCriteriaRequest request, AsyncHandler<ListInclusionCriteriaRequest,ListInclusionCriteriaResponse> handler) List inclusion criteria associated with a governance rule.
Future<ListTenancyAttachmentsResponse>	listTenancyAttachments(ListTenancyAttachmentsRequest request, AsyncHandler<ListTenancyAttachmentsRequest,ListTenancyAttachmentsResponse> handler) List tenancy attachments.
void	refreshClient() Rebuilds the client from scratch.
Future<RetryGovernanceRuleResponse>	retryGovernanceRule(RetryGovernanceRuleRequest request, AsyncHandler<RetryGovernanceRuleRequest,RetryGovernanceRuleResponse> handler) Retry the creation of the specified governance rule.
Future<RetryTenancyAttachmentResponse>	retryTenancyAttachment(RetryTenancyAttachmentRequest request, AsyncHandler<RetryTenancyAttachmentRequest,RetryTenancyAttachmentResponse> handler) Retry governance rule application for the specified tenancy attachment id.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
Future<UpdateGovernanceRuleResponse>	updateGovernanceRule(UpdateGovernanceRuleRequest request, AsyncHandler<UpdateGovernanceRuleRequest,UpdateGovernanceRuleResponse> handler) Update the specified governance rule.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the serice.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

createGovernanceRule

Future<CreateGovernanceRuleResponse> createGovernanceRule(CreateGovernanceRuleRequest request,
                                                          AsyncHandler<CreateGovernanceRuleRequest,CreateGovernanceRuleResponse> handler)

Create governance rule in the root compartment only. Either relatedResourceId or template must be supplied.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createInclusionCriterion

Future<CreateInclusionCriterionResponse> createInclusionCriterion(CreateInclusionCriterionRequest request,
                                                                  AsyncHandler<CreateInclusionCriterionRequest,CreateInclusionCriterionResponse> handler)

Create inclusion criterion of type tenancy or tag for the governance rule.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteGovernanceRule

Future<DeleteGovernanceRuleResponse> deleteGovernanceRule(DeleteGovernanceRuleRequest request,
                                                          AsyncHandler<DeleteGovernanceRuleRequest,DeleteGovernanceRuleResponse> handler)

Delete the specified governance rule.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteInclusionCriterion

Future<DeleteInclusionCriterionResponse> deleteInclusionCriterion(DeleteInclusionCriterionRequest request,
                                                                  AsyncHandler<DeleteInclusionCriterionRequest,DeleteInclusionCriterionResponse> handler)

Delete the specified inclusion criterion.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getEnforcedGovernanceRule

Future<GetEnforcedGovernanceRuleResponse> getEnforcedGovernanceRule(GetEnforcedGovernanceRuleRequest request,
                                                                    AsyncHandler<GetEnforcedGovernanceRuleRequest,GetEnforcedGovernanceRuleResponse> handler)

Get the specified enforced governance rule’s information.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getGovernanceRule

Future<GetGovernanceRuleResponse> getGovernanceRule(GetGovernanceRuleRequest request,
                                                    AsyncHandler<GetGovernanceRuleRequest,GetGovernanceRuleResponse> handler)

Get the specified governance rule’s information.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getInclusionCriterion

Future<GetInclusionCriterionResponse> getInclusionCriterion(GetInclusionCriterionRequest request,
                                                            AsyncHandler<GetInclusionCriterionRequest,GetInclusionCriterionResponse> handler)

Get the specified inclusion criterion’s information.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getTenancyAttachment

Future<GetTenancyAttachmentResponse> getTenancyAttachment(GetTenancyAttachmentRequest request,
                                                          AsyncHandler<GetTenancyAttachmentRequest,GetTenancyAttachmentResponse> handler)

Get the specified tenancy attachment’s information.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listEnforcedGovernanceRules

Future<ListEnforcedGovernanceRulesResponse> listEnforcedGovernanceRules(ListEnforcedGovernanceRulesRequest request,
                                                                        AsyncHandler<ListEnforcedGovernanceRulesRequest,ListEnforcedGovernanceRulesResponse> handler)

List enforced governance rules. Either compartment id or enforced governance rule id must be supplied. An optional governance rule type or a display name can also be supplied.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listGovernanceRules

Future<ListGovernanceRulesResponse> listGovernanceRules(ListGovernanceRulesRequest request,
                                                        AsyncHandler<ListGovernanceRulesRequest,ListGovernanceRulesResponse> handler)

List governance rules. Either compartment id or governance rule id must be supplied. An optional lifecycle state, display name or a governance rule type can also be supplied.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listInclusionCriteria

Future<ListInclusionCriteriaResponse> listInclusionCriteria(ListInclusionCriteriaRequest request,
                                                            AsyncHandler<ListInclusionCriteriaRequest,ListInclusionCriteriaResponse> handler)

List inclusion criteria associated with a governance rule. Governance rule id must be supplied. An optional inclusion criterion id or a lifecycle state can also be supplied.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listTenancyAttachments

Future<ListTenancyAttachmentsResponse> listTenancyAttachments(ListTenancyAttachmentsRequest request,
                                                              AsyncHandler<ListTenancyAttachmentsRequest,ListTenancyAttachmentsResponse> handler)

List tenancy attachments. Either compartment id, governance rule id or tenancy attachment id must be supplied. An optional lifecycle state or a child tenancy id can also be supplied.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

retryGovernanceRule

Future<RetryGovernanceRuleResponse> retryGovernanceRule(RetryGovernanceRuleRequest request,
                                                        AsyncHandler<RetryGovernanceRuleRequest,RetryGovernanceRuleResponse> handler)

Retry the creation of the specified governance rule. Used by the tenancy admins when all the workflow retries have exhausted. When provided, If-Match is checked against ETag values of the resource.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

retryTenancyAttachment

Future<RetryTenancyAttachmentResponse> retryTenancyAttachment(RetryTenancyAttachmentRequest request,
                                                              AsyncHandler<RetryTenancyAttachmentRequest,RetryTenancyAttachmentResponse> handler)

Retry governance rule application for the specified tenancy attachment id. Used by the tenancy admins when all the workflow retries have exhausted.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateGovernanceRule

Future<UpdateGovernanceRuleResponse> updateGovernanceRule(UpdateGovernanceRuleRequest request,
                                                          AsyncHandler<UpdateGovernanceRuleRequest,UpdateGovernanceRuleResponse> handler)

Update the specified governance rule.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.