com.oracle.bmc.governancerulescontrolplane

Class GovernanceRuleAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.governancerulescontrolplane.GovernanceRuleAsyncClient

All Implemented Interfaces:

GovernanceRuleAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220504")
public class GovernanceRuleAsyncClient
extends BaseAsyncClient
implements GovernanceRuleAsync

Async client implementation for GovernanceRule service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GovernanceRuleAsyncClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for GovernanceRule.

Constructor Summary

Constructors

Constructor and Description
GovernanceRuleAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
GovernanceRuleAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
GovernanceRuleAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
GovernanceRuleAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
GovernanceRuleAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
GovernanceRuleAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
GovernanceRuleAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static GovernanceRuleAsyncClient.Builder	builder() Create a builder for this client.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
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	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
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.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
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)
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’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateGovernanceRuleResponse>	updateGovernanceRule(UpdateGovernanceRuleRequest request, AsyncHandler<UpdateGovernanceRuleRequest,UpdateGovernanceRuleResponse> handler) Update the specified governance rule.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.bmc.governancerulescontrolplane.GovernanceRuleAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for GovernanceRule.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

GovernanceRuleAsyncClient

@Deprecated
public GovernanceRuleAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GovernanceRuleAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

GovernanceRuleAsyncClient

@Deprecated
public GovernanceRuleAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                             ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GovernanceRuleAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

GovernanceRuleAsyncClient

@Deprecated
public GovernanceRuleAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                             ClientConfiguration configuration,
                                             ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GovernanceRuleAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

GovernanceRuleAsyncClient

@Deprecated
public GovernanceRuleAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                             ClientConfiguration configuration,
                                             ClientConfigurator clientConfigurator,
                                             RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GovernanceRuleAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

GovernanceRuleAsyncClient

@Deprecated
public GovernanceRuleAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                             ClientConfiguration configuration,
                                             ClientConfigurator clientConfigurator,
                                             RequestSignerFactory defaultRequestSignerFactory,
                                             List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GovernanceRuleAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

GovernanceRuleAsyncClient

@Deprecated
public GovernanceRuleAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                             ClientConfiguration configuration,
                                             ClientConfigurator clientConfigurator,
                                             RequestSignerFactory defaultRequestSignerFactory,
                                             List<ClientConfigurator> additionalClientConfigurators,
                                             String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GovernanceRuleAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

GovernanceRuleAsyncClient

@Deprecated
public GovernanceRuleAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                             ClientConfiguration configuration,
                                             ClientConfigurator clientConfigurator,
                                             RequestSignerFactory defaultRequestSignerFactory,
                                             Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                             List<ClientConfigurator> additionalClientConfigurators,
                                             String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GovernanceRuleAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static GovernanceRuleAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: GovernanceRuleAsync

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.

Specified by:

setRegion in interface GovernanceRuleAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: GovernanceRuleAsync

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.

Specified by:

setRegion in interface GovernanceRuleAsync

Parameters:

regionId - The public region ID.

createGovernanceRule

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

Description copied from interface: GovernanceRuleAsync

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

Specified by:

createGovernanceRule in interface GovernanceRuleAsync

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

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

Description copied from interface: GovernanceRuleAsync

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

Specified by:

createInclusionCriterion in interface GovernanceRuleAsync

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

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

Description copied from interface: GovernanceRuleAsync

Delete the specified governance rule.

Specified by:

deleteGovernanceRule in interface GovernanceRuleAsync

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

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

Description copied from interface: GovernanceRuleAsync

Delete the specified inclusion criterion.

Specified by:

deleteInclusionCriterion in interface GovernanceRuleAsync

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

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

Description copied from interface: GovernanceRuleAsync

Get the specified enforced governance rule’s information.

Specified by:

getEnforcedGovernanceRule in interface GovernanceRuleAsync

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

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

Description copied from interface: GovernanceRuleAsync

Get the specified governance rule’s information.

Specified by:

getGovernanceRule in interface GovernanceRuleAsync

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

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

Description copied from interface: GovernanceRuleAsync

Get the specified inclusion criterion’s information.

Specified by:

getInclusionCriterion in interface GovernanceRuleAsync

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

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

Description copied from interface: GovernanceRuleAsync

Get the specified tenancy attachment’s information.

Specified by:

getTenancyAttachment in interface GovernanceRuleAsync

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

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

Description copied from interface: GovernanceRuleAsync

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.

Specified by:

listEnforcedGovernanceRules in interface GovernanceRuleAsync

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

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

Description copied from interface: GovernanceRuleAsync

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.

Specified by:

listGovernanceRules in interface GovernanceRuleAsync

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

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

Description copied from interface: GovernanceRuleAsync

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.

Specified by:

listInclusionCriteria in interface GovernanceRuleAsync

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

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

Description copied from interface: GovernanceRuleAsync

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.

Specified by:

listTenancyAttachments in interface GovernanceRuleAsync

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

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

Description copied from interface: GovernanceRuleAsync

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.

Specified by:

retryGovernanceRule in interface GovernanceRuleAsync

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

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

Description copied from interface: GovernanceRuleAsync

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

Specified by:

retryTenancyAttachment in interface GovernanceRuleAsync

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

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

Description copied from interface: GovernanceRuleAsync

Update the specified governance rule.

Specified by:

updateGovernanceRule in interface GovernanceRuleAsync

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.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                           Supplier<RESP_BUILDER> responseBuilder)