Package com.oracle.bmc.delegateaccesscontrol

Class DelegateAccessControlAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.delegateaccesscontrol.DelegateAccessControlAsyncClient

All Implemented Interfaces:

DelegateAccessControlAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230801")
public class DelegateAccessControlAsyncClient
extends BaseAsyncClient
implements DelegateAccessControlAsync

Async client implementation for DelegateAccessControl 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	Description
static class	DelegateAccessControlAsyncClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	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 DelegateAccessControl.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Future<ApproveDelegatedResourceAccessRequestResponse>	approveDelegatedResourceAccessRequest(ApproveDelegatedResourceAccessRequestRequest request, AsyncHandler<ApproveDelegatedResourceAccessRequestRequest,ApproveDelegatedResourceAccessRequestResponse> handler)	Approves a Delegated Resource Access Request.
static DelegateAccessControlAsyncClient.Builder	builder()	Create a builder for this client.
Future<ChangeDelegationControlCompartmentResponse>	changeDelegationControlCompartment(ChangeDelegationControlCompartmentRequest request, AsyncHandler<ChangeDelegationControlCompartmentRequest,ChangeDelegationControlCompartmentResponse> handler)	Moves the Delegation Control resource into a different compartment.
Future<ChangeDelegationSubscriptionCompartmentResponse>	changeDelegationSubscriptionCompartment(ChangeDelegationSubscriptionCompartmentRequest request, AsyncHandler<ChangeDelegationSubscriptionCompartmentRequest,ChangeDelegationSubscriptionCompartmentResponse> handler)	Moves the Delegation Subscription resource into a different compartment.
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<CreateDelegationControlResponse>	createDelegationControl(CreateDelegationControlRequest request, AsyncHandler<CreateDelegationControlRequest,CreateDelegationControlResponse> handler)	Creates a Delegation Control.
Future<CreateDelegationSubscriptionResponse>	createDelegationSubscription(CreateDelegationSubscriptionRequest request, AsyncHandler<CreateDelegationSubscriptionRequest,CreateDelegationSubscriptionResponse> handler)	Creates Delegation Subscription in Delegation Control.
Future<DeleteDelegationControlResponse>	deleteDelegationControl(DeleteDelegationControlRequest request, AsyncHandler<DeleteDelegationControlRequest,DeleteDelegationControlResponse> handler)	Deletes a Delegation Control.
Future<DeleteDelegationSubscriptionResponse>	deleteDelegationSubscription(DeleteDelegationSubscriptionRequest request, AsyncHandler<DeleteDelegationSubscriptionRequest,DeleteDelegationSubscriptionResponse> handler)	eletes an Delegation Subscription in Delegation Control.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
Future<GetDelegatedResourceAccessRequestResponse>	getDelegatedResourceAccessRequest(GetDelegatedResourceAccessRequestRequest request, AsyncHandler<GetDelegatedResourceAccessRequestRequest,GetDelegatedResourceAccessRequestResponse> handler)	Gets details of a Delegated Resource Access Request.
Future<GetDelegatedResourceAccessRequestAuditLogReportResponse>	getDelegatedResourceAccessRequestAuditLogReport(GetDelegatedResourceAccessRequestAuditLogReportRequest request, AsyncHandler<GetDelegatedResourceAccessRequestAuditLogReportRequest,GetDelegatedResourceAccessRequestAuditLogReportResponse> handler)	Gets the audit log report for the given Delegated Resource Access Request.
Future<GetDelegationControlResponse>	getDelegationControl(GetDelegationControlRequest request, AsyncHandler<GetDelegationControlRequest,GetDelegationControlResponse> handler)	Gets the Delegation Control associated with the specified Delegation Control ID.
Future<GetDelegationSubscriptionResponse>	getDelegationSubscription(GetDelegationSubscriptionRequest request, AsyncHandler<GetDelegationSubscriptionRequest,GetDelegationSubscriptionResponse> handler)	Gets a DelegationSubscription by identifier
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetServiceProviderResponse>	getServiceProvider(GetServiceProviderRequest request, AsyncHandler<GetServiceProviderRequest,GetServiceProviderResponse> handler)	Gets a ServiceProvider by identifier
Future<GetServiceProviderActionResponse>	getServiceProviderAction(GetServiceProviderActionRequest request, AsyncHandler<GetServiceProviderActionRequest,GetServiceProviderActionResponse> handler)	Gets the Service Provider Action associated with the specified Service Provider Action ID.
Future<ListDelegatedResourceAccessRequestHistoriesResponse>	listDelegatedResourceAccessRequestHistories(ListDelegatedResourceAccessRequestHistoriesRequest request, AsyncHandler<ListDelegatedResourceAccessRequestHistoriesRequest,ListDelegatedResourceAccessRequestHistoriesResponse> handler)	Returns a history of all status associated with the Delegated Resource Access RequestId.
Future<ListDelegatedResourceAccessRequestsResponse>	listDelegatedResourceAccessRequests(ListDelegatedResourceAccessRequestsRequest request, AsyncHandler<ListDelegatedResourceAccessRequestsRequest,ListDelegatedResourceAccessRequestsResponse> handler)	Lists all Delegated Resource Access Requests in the compartment.
Future<ListDelegationControlResourcesResponse>	listDelegationControlResources(ListDelegationControlResourcesRequest request, AsyncHandler<ListDelegationControlResourcesRequest,ListDelegationControlResourcesResponse> handler)	Returns a list of resources associated with the Delegation Control.
Future<ListDelegationControlsResponse>	listDelegationControls(ListDelegationControlsRequest request, AsyncHandler<ListDelegationControlsRequest,ListDelegationControlsResponse> handler)	Lists the Delegation Controls in the compartment.
Future<ListDelegationSubscriptionsResponse>	listDelegationSubscriptions(ListDelegationSubscriptionsRequest request, AsyncHandler<ListDelegationSubscriptionsRequest,ListDelegationSubscriptionsResponse> handler)	Lists the Delegation Subscriptions in Delegation Control.
Future<ListServiceProviderActionsResponse>	listServiceProviderActions(ListServiceProviderActionsRequest request, AsyncHandler<ListServiceProviderActionsRequest,ListServiceProviderActionsResponse> handler)	Lists all the ServiceProviderActions available in the system.
Future<ListServiceProviderInteractionsResponse>	listServiceProviderInteractions(ListServiceProviderInteractionsRequest request, AsyncHandler<ListServiceProviderInteractionsRequest,ListServiceProviderInteractionsResponse> handler)	Lists the MoreInformation interaction between customer and support operators.
Future<ListServiceProvidersResponse>	listServiceProviders(ListServiceProvidersRequest request, AsyncHandler<ListServiceProvidersRequest,ListServiceProvidersResponse> handler)	Lists the Service Providers.
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<RejectDelegatedResourceAccessRequestResponse>	rejectDelegatedResourceAccessRequest(RejectDelegatedResourceAccessRequestRequest request, AsyncHandler<RejectDelegatedResourceAccessRequestRequest,RejectDelegatedResourceAccessRequestResponse> handler)	Rejects a Delegated Resource Access Request.
Future<RevokeDelegatedResourceAccessRequestResponse>	revokeDelegatedResourceAccessRequest(RevokeDelegatedResourceAccessRequestRequest request, AsyncHandler<RevokeDelegatedResourceAccessRequestRequest,RevokeDelegatedResourceAccessRequestResponse> handler)	Revokes an already approved Delegated Resource Access Request.
Future<ServiceProviderInteractionRequestResponse>	serviceProviderInteractionRequest(ServiceProviderInteractionRequestRequest request, AsyncHandler<ServiceProviderInteractionRequestRequest,ServiceProviderInteractionRequestResponse> handler)	Posts query for additional information for the given Delegated Resource Access Request.
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<UpdateDelegationControlResponse>	updateDelegationControl(UpdateDelegationControlRequest request, AsyncHandler<UpdateDelegationControlRequest,UpdateDelegationControlResponse> handler)	Updates the existing DelegationControl for a given Delegation Control ID.
Future<UpdateDelegationSubscriptionResponse>	updateDelegationSubscription(UpdateDelegationSubscriptionRequest request, AsyncHandler<UpdateDelegationSubscriptionRequest,UpdateDelegationSubscriptionResponse> handler)	Updates the existing DelegationSubscription for a given Delegation Subscription ID.
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 java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.delegateaccesscontrol.DelegateAccessControlAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for DelegateAccessControl.

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

DelegateAccessControlAsyncClient

@Deprecated
public DelegateAccessControlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

DelegateAccessControlAsyncClient

@Deprecated
public DelegateAccessControlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                        ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

DelegateAccessControlAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

DelegateAccessControlAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DelegateAccessControlAsyncClient

@Deprecated
public DelegateAccessControlAsyncClient(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 DelegateAccessControlAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DelegateAccessControlAsyncClient

@Deprecated
public DelegateAccessControlAsyncClient(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 DelegateAccessControlAsyncClient.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)

DelegateAccessControlAsyncClient

@Deprecated
public DelegateAccessControlAsyncClient(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 DelegateAccessControlAsyncClient.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 DelegateAccessControlAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DelegateAccessControlAsync

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 DelegateAccessControlAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DelegateAccessControlAsync

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 DelegateAccessControlAsync

Parameters:

regionId - The public region ID.

approveDelegatedResourceAccessRequest

public Future<ApproveDelegatedResourceAccessRequestResponse> approveDelegatedResourceAccessRequest(ApproveDelegatedResourceAccessRequestRequest request,
                                                                                                   AsyncHandler<ApproveDelegatedResourceAccessRequestRequest,ApproveDelegatedResourceAccessRequestResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Approves a Delegated Resource Access Request.

Specified by:

approveDelegatedResourceAccessRequest in interface DelegateAccessControlAsync

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.

changeDelegationControlCompartment

public Future<ChangeDelegationControlCompartmentResponse> changeDelegationControlCompartment(ChangeDelegationControlCompartmentRequest request,
                                                                                             AsyncHandler<ChangeDelegationControlCompartmentRequest,ChangeDelegationControlCompartmentResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Moves the Delegation Control resource into a different compartment.

When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.

Specified by:

changeDelegationControlCompartment in interface DelegateAccessControlAsync

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.

changeDelegationSubscriptionCompartment

public Future<ChangeDelegationSubscriptionCompartmentResponse> changeDelegationSubscriptionCompartment(ChangeDelegationSubscriptionCompartmentRequest request,
                                                                                                       AsyncHandler<ChangeDelegationSubscriptionCompartmentRequest,ChangeDelegationSubscriptionCompartmentResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Moves the Delegation Subscription resource into a different compartment.

When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.

Specified by:

changeDelegationSubscriptionCompartment in interface DelegateAccessControlAsync

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.

createDelegationControl

public Future<CreateDelegationControlResponse> createDelegationControl(CreateDelegationControlRequest request,
                                                                       AsyncHandler<CreateDelegationControlRequest,CreateDelegationControlResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Creates a Delegation Control.

Specified by:

createDelegationControl in interface DelegateAccessControlAsync

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.

createDelegationSubscription

public Future<CreateDelegationSubscriptionResponse> createDelegationSubscription(CreateDelegationSubscriptionRequest request,
                                                                                 AsyncHandler<CreateDelegationSubscriptionRequest,CreateDelegationSubscriptionResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Creates Delegation Subscription in Delegation Control.

Specified by:

createDelegationSubscription in interface DelegateAccessControlAsync

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.

deleteDelegationControl

public Future<DeleteDelegationControlResponse> deleteDelegationControl(DeleteDelegationControlRequest request,
                                                                       AsyncHandler<DeleteDelegationControlRequest,DeleteDelegationControlResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Deletes a Delegation Control.

You cannot delete a Delegation Control if it is assigned to govern any target resource currently or in the future. In that case, first, delete all of the current and future assignments before deleting the Delegation Control. A Delegation Control that was previously assigned to a target resource is marked as DELETED following a successful deletion. However, it is not completely deleted from the system. This is to ensure auditing information for the accesses done under the Delegation Control is preserved for future needs. The system purges the deleted Delegation Control only when all of the audit data associated with the Delegation Control are also deleted. Therefore, you cannot reuse the name of the deleted Delegation Control until the system purges the Delegation Control.

Specified by:

deleteDelegationControl in interface DelegateAccessControlAsync

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.

deleteDelegationSubscription

public Future<DeleteDelegationSubscriptionResponse> deleteDelegationSubscription(DeleteDelegationSubscriptionRequest request,
                                                                                 AsyncHandler<DeleteDelegationSubscriptionRequest,DeleteDelegationSubscriptionResponse> handler)

Description copied from interface: DelegateAccessControlAsync

eletes an Delegation Subscription in Delegation Control.

Specified by:

deleteDelegationSubscription in interface DelegateAccessControlAsync

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.

getDelegatedResourceAccessRequest

public Future<GetDelegatedResourceAccessRequestResponse> getDelegatedResourceAccessRequest(GetDelegatedResourceAccessRequestRequest request,
                                                                                           AsyncHandler<GetDelegatedResourceAccessRequestRequest,GetDelegatedResourceAccessRequestResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Gets details of a Delegated Resource Access Request.

Specified by:

getDelegatedResourceAccessRequest in interface DelegateAccessControlAsync

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.

getDelegatedResourceAccessRequestAuditLogReport

public Future<GetDelegatedResourceAccessRequestAuditLogReportResponse> getDelegatedResourceAccessRequestAuditLogReport(GetDelegatedResourceAccessRequestAuditLogReportRequest request,
                                                                                                                       AsyncHandler<GetDelegatedResourceAccessRequestAuditLogReportRequest,GetDelegatedResourceAccessRequestAuditLogReportResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Gets the audit log report for the given Delegated Resource Access Request.

Specified by:

getDelegatedResourceAccessRequestAuditLogReport in interface DelegateAccessControlAsync

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.

getDelegationControl

public Future<GetDelegationControlResponse> getDelegationControl(GetDelegationControlRequest request,
                                                                 AsyncHandler<GetDelegationControlRequest,GetDelegationControlResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Gets the Delegation Control associated with the specified Delegation Control ID.

Specified by:

getDelegationControl in interface DelegateAccessControlAsync

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.

getDelegationSubscription

public Future<GetDelegationSubscriptionResponse> getDelegationSubscription(GetDelegationSubscriptionRequest request,
                                                                           AsyncHandler<GetDelegationSubscriptionRequest,GetDelegationSubscriptionResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Gets a DelegationSubscription by identifier

Specified by:

getDelegationSubscription in interface DelegateAccessControlAsync

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.

getServiceProvider

public Future<GetServiceProviderResponse> getServiceProvider(GetServiceProviderRequest request,
                                                             AsyncHandler<GetServiceProviderRequest,GetServiceProviderResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Gets a ServiceProvider by identifier

Specified by:

getServiceProvider in interface DelegateAccessControlAsync

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.

getServiceProviderAction

public Future<GetServiceProviderActionResponse> getServiceProviderAction(GetServiceProviderActionRequest request,
                                                                         AsyncHandler<GetServiceProviderActionRequest,GetServiceProviderActionResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Gets the Service Provider Action associated with the specified Service Provider Action ID.

Specified by:

getServiceProviderAction in interface DelegateAccessControlAsync

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.

listDelegatedResourceAccessRequestHistories

public Future<ListDelegatedResourceAccessRequestHistoriesResponse> listDelegatedResourceAccessRequestHistories(ListDelegatedResourceAccessRequestHistoriesRequest request,
                                                                                                               AsyncHandler<ListDelegatedResourceAccessRequestHistoriesRequest,ListDelegatedResourceAccessRequestHistoriesResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Returns a history of all status associated with the Delegated Resource Access RequestId.

Specified by:

listDelegatedResourceAccessRequestHistories in interface DelegateAccessControlAsync

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.

listDelegatedResourceAccessRequests

public Future<ListDelegatedResourceAccessRequestsResponse> listDelegatedResourceAccessRequests(ListDelegatedResourceAccessRequestsRequest request,
                                                                                               AsyncHandler<ListDelegatedResourceAccessRequestsRequest,ListDelegatedResourceAccessRequestsResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Lists all Delegated Resource Access Requests in the compartment.

Note that only one of lifecycleState or requestStatus query parameter can be used.

Specified by:

listDelegatedResourceAccessRequests in interface DelegateAccessControlAsync

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.

listDelegationControlResources

public Future<ListDelegationControlResourcesResponse> listDelegationControlResources(ListDelegationControlResourcesRequest request,
                                                                                     AsyncHandler<ListDelegationControlResourcesRequest,ListDelegationControlResourcesResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Returns a list of resources associated with the Delegation Control.

Specified by:

listDelegationControlResources in interface DelegateAccessControlAsync

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.

listDelegationControls

public Future<ListDelegationControlsResponse> listDelegationControls(ListDelegationControlsRequest request,
                                                                     AsyncHandler<ListDelegationControlsRequest,ListDelegationControlsResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Lists the Delegation Controls in the compartment.

Specified by:

listDelegationControls in interface DelegateAccessControlAsync

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.

listDelegationSubscriptions

public Future<ListDelegationSubscriptionsResponse> listDelegationSubscriptions(ListDelegationSubscriptionsRequest request,
                                                                               AsyncHandler<ListDelegationSubscriptionsRequest,ListDelegationSubscriptionsResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Lists the Delegation Subscriptions in Delegation Control.

Specified by:

listDelegationSubscriptions in interface DelegateAccessControlAsync

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.

listServiceProviderActions

public Future<ListServiceProviderActionsResponse> listServiceProviderActions(ListServiceProviderActionsRequest request,
                                                                             AsyncHandler<ListServiceProviderActionsRequest,ListServiceProviderActionsResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Lists all the ServiceProviderActions available in the system.

Specified by:

listServiceProviderActions in interface DelegateAccessControlAsync

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.

listServiceProviderInteractions

public Future<ListServiceProviderInteractionsResponse> listServiceProviderInteractions(ListServiceProviderInteractionsRequest request,
                                                                                       AsyncHandler<ListServiceProviderInteractionsRequest,ListServiceProviderInteractionsResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Lists the MoreInformation interaction between customer and support operators.

Specified by:

listServiceProviderInteractions in interface DelegateAccessControlAsync

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.

listServiceProviders

public Future<ListServiceProvidersResponse> listServiceProviders(ListServiceProvidersRequest request,
                                                                 AsyncHandler<ListServiceProvidersRequest,ListServiceProvidersResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Lists the Service Providers.

Specified by:

listServiceProviders in interface DelegateAccessControlAsync

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.

rejectDelegatedResourceAccessRequest

public Future<RejectDelegatedResourceAccessRequestResponse> rejectDelegatedResourceAccessRequest(RejectDelegatedResourceAccessRequestRequest request,
                                                                                                 AsyncHandler<RejectDelegatedResourceAccessRequestRequest,RejectDelegatedResourceAccessRequestResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Rejects a Delegated Resource Access Request.

Specified by:

rejectDelegatedResourceAccessRequest in interface DelegateAccessControlAsync

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.

revokeDelegatedResourceAccessRequest

public Future<RevokeDelegatedResourceAccessRequestResponse> revokeDelegatedResourceAccessRequest(RevokeDelegatedResourceAccessRequestRequest request,
                                                                                                 AsyncHandler<RevokeDelegatedResourceAccessRequestRequest,RevokeDelegatedResourceAccessRequestResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Revokes an already approved Delegated Resource Access Request.

Specified by:

revokeDelegatedResourceAccessRequest in interface DelegateAccessControlAsync

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.

serviceProviderInteractionRequest

public Future<ServiceProviderInteractionRequestResponse> serviceProviderInteractionRequest(ServiceProviderInteractionRequestRequest request,
                                                                                           AsyncHandler<ServiceProviderInteractionRequestRequest,ServiceProviderInteractionRequestResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Posts query for additional information for the given Delegated Resource Access Request.

Specified by:

serviceProviderInteractionRequest in interface DelegateAccessControlAsync

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.

updateDelegationControl

public Future<UpdateDelegationControlResponse> updateDelegationControl(UpdateDelegationControlRequest request,
                                                                       AsyncHandler<UpdateDelegationControlRequest,UpdateDelegationControlResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Updates the existing DelegationControl for a given Delegation Control ID.

Specified by:

updateDelegationControl in interface DelegateAccessControlAsync

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.

updateDelegationSubscription

public Future<UpdateDelegationSubscriptionResponse> updateDelegationSubscription(UpdateDelegationSubscriptionRequest request,
                                                                                 AsyncHandler<UpdateDelegationSubscriptionRequest,UpdateDelegationSubscriptionResponse> handler)

Description copied from interface: DelegateAccessControlAsync

Updates the existing DelegationSubscription for a given Delegation Subscription ID.

Specified by:

updateDelegationSubscription in interface DelegateAccessControlAsync

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)