com.oracle.bmc.integration

Class IntegrationInstanceAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.integration.IntegrationInstanceAsyncClient

All Implemented Interfaces:

IntegrationInstanceAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190131")
public class IntegrationInstanceAsyncClient
extends BaseAsyncClient
implements IntegrationInstanceAsync

Async client implementation for IntegrationInstance 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	IntegrationInstanceAsyncClient.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 IntegrationInstance.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Future<AddOracleManagedCustomEndpointResponse>	addOracleManagedCustomEndpoint(AddOracleManagedCustomEndpointRequest request, AsyncHandler<AddOracleManagedCustomEndpointRequest,AddOracleManagedCustomEndpointResponse> handler) Enable Oracle Managed Custom Endpoint for given integration instance.
static IntegrationInstanceAsyncClient.Builder	builder() Create a builder for this client.
Future<ChangeIntegrationInstanceCompartmentResponse>	changeIntegrationInstanceCompartment(ChangeIntegrationInstanceCompartmentRequest request, AsyncHandler<ChangeIntegrationInstanceCompartmentRequest,ChangeIntegrationInstanceCompartmentResponse> handler) Change the compartment for an integration instance
Future<ChangeIntegrationInstanceNetworkEndpointResponse>	changeIntegrationInstanceNetworkEndpoint(ChangeIntegrationInstanceNetworkEndpointRequest request, AsyncHandler<ChangeIntegrationInstanceNetworkEndpointRequest,ChangeIntegrationInstanceNetworkEndpointResponse> handler) Change an Integration instance network endpoint.
Future<ChangePrivateEndpointOutboundConnectionResponse>	changePrivateEndpointOutboundConnection(ChangePrivateEndpointOutboundConnectionRequest request, AsyncHandler<ChangePrivateEndpointOutboundConnectionRequest,ChangePrivateEndpointOutboundConnectionResponse> handler) Change private endpoint outbound connection for given Integration instance.
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<CreateIntegrationInstanceResponse>	createIntegrationInstance(CreateIntegrationInstanceRequest request, AsyncHandler<CreateIntegrationInstanceRequest,CreateIntegrationInstanceResponse> handler) Creates a new Integration Instance.
Future<DeleteIntegrationInstanceResponse>	deleteIntegrationInstance(DeleteIntegrationInstanceRequest request, AsyncHandler<DeleteIntegrationInstanceRequest,DeleteIntegrationInstanceResponse> handler) Deletes an Integration Instance resource by identifier.
Future<DisasterRecoveryFailoverResponse>	disasterRecoveryFailover(DisasterRecoveryFailoverRequest request, AsyncHandler<DisasterRecoveryFailoverRequest,DisasterRecoveryFailoverResponse> handler) Allows failover for disaster recovery.
Future<EnableProcessAutomationResponse>	enableProcessAutomation(EnableProcessAutomationRequest request, AsyncHandler<EnableProcessAutomationRequest,EnableProcessAutomationResponse> handler) Enable Process Automation for given Integration Instance
Future<ExtendDataRetentionResponse>	extendDataRetention(ExtendDataRetentionRequest request, AsyncHandler<ExtendDataRetentionRequest,ExtendDataRetentionResponse> handler) Extend Data Retention period for given Integration Instance
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetIntegrationInstanceResponse>	getIntegrationInstance(GetIntegrationInstanceRequest request, AsyncHandler<GetIntegrationInstanceRequest,GetIntegrationInstanceResponse> handler) Gets a IntegrationInstance by identifier
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Gets the status of the work request with the given ID.
Future<ListIntegrationInstancesResponse>	listIntegrationInstances(ListIntegrationInstancesRequest request, AsyncHandler<ListIntegrationInstancesRequest,ListIntegrationInstancesResponse> handler) Returns a list of Integration Instances.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Get the errors of a work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Get the logs of a work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) Lists the work requests in a compartment.
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<RemoveOracleManagedCustomEndpointResponse>	removeOracleManagedCustomEndpoint(RemoveOracleManagedCustomEndpointRequest request, AsyncHandler<RemoveOracleManagedCustomEndpointRequest,RemoveOracleManagedCustomEndpointResponse> handler) Remove Oracle Managed Custom Endpoint for given integration instance that was previously enabled.
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’).
Future<StartIntegrationInstanceResponse>	startIntegrationInstance(StartIntegrationInstanceRequest request, AsyncHandler<StartIntegrationInstanceRequest,StartIntegrationInstanceResponse> handler) Start an integration instance that was previously in an INACTIVE state
Future<StopIntegrationInstanceResponse>	stopIntegrationInstance(StopIntegrationInstanceRequest request, AsyncHandler<StopIntegrationInstanceRequest,StopIntegrationInstanceResponse> handler) Stop an integration instance that was previously in an ACTIVE state
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateIntegrationInstanceResponse>	updateIntegrationInstance(UpdateIntegrationInstanceRequest request, AsyncHandler<UpdateIntegrationInstanceRequest,UpdateIntegrationInstanceResponse> handler) Updates the Integration Instance.
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.integration.IntegrationInstanceAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for IntegrationInstance.

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

IntegrationInstanceAsyncClient

@Deprecated
public IntegrationInstanceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

IntegrationInstanceAsyncClient

@Deprecated
public IntegrationInstanceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                  ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

IntegrationInstanceAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

IntegrationInstanceAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

IntegrationInstanceAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

IntegrationInstanceAsyncClient

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

IntegrationInstanceAsyncClient

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

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: IntegrationInstanceAsync

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 IntegrationInstanceAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: IntegrationInstanceAsync

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 IntegrationInstanceAsync

Parameters:

regionId - The public region ID.

addOracleManagedCustomEndpoint

public Future<AddOracleManagedCustomEndpointResponse> addOracleManagedCustomEndpoint(AddOracleManagedCustomEndpointRequest request,
                                                                                     AsyncHandler<AddOracleManagedCustomEndpointRequest,AddOracleManagedCustomEndpointResponse> handler)

Description copied from interface: IntegrationInstanceAsync

Enable Oracle Managed Custom Endpoint for given integration instance.

Specified by:

addOracleManagedCustomEndpoint in interface IntegrationInstanceAsync

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.

changeIntegrationInstanceCompartment

public Future<ChangeIntegrationInstanceCompartmentResponse> changeIntegrationInstanceCompartment(ChangeIntegrationInstanceCompartmentRequest request,
                                                                                                 AsyncHandler<ChangeIntegrationInstanceCompartmentRequest,ChangeIntegrationInstanceCompartmentResponse> handler)

Description copied from interface: IntegrationInstanceAsync

Change the compartment for an integration instance

Specified by:

changeIntegrationInstanceCompartment in interface IntegrationInstanceAsync

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.

changeIntegrationInstanceNetworkEndpoint

public Future<ChangeIntegrationInstanceNetworkEndpointResponse> changeIntegrationInstanceNetworkEndpoint(ChangeIntegrationInstanceNetworkEndpointRequest request,
                                                                                                         AsyncHandler<ChangeIntegrationInstanceNetworkEndpointRequest,ChangeIntegrationInstanceNetworkEndpointResponse> handler)

Description copied from interface: IntegrationInstanceAsync

Change an Integration instance network endpoint. The operation is long-running and creates a new WorkRequest.

Specified by:

changeIntegrationInstanceNetworkEndpoint in interface IntegrationInstanceAsync

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.

changePrivateEndpointOutboundConnection

public Future<ChangePrivateEndpointOutboundConnectionResponse> changePrivateEndpointOutboundConnection(ChangePrivateEndpointOutboundConnectionRequest request,
                                                                                                       AsyncHandler<ChangePrivateEndpointOutboundConnectionRequest,ChangePrivateEndpointOutboundConnectionResponse> handler)

Description copied from interface: IntegrationInstanceAsync

Change private endpoint outbound connection for given Integration instance. The operation is long-running and creates a new WorkRequest.

Specified by:

changePrivateEndpointOutboundConnection in interface IntegrationInstanceAsync

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.

createIntegrationInstance

public Future<CreateIntegrationInstanceResponse> createIntegrationInstance(CreateIntegrationInstanceRequest request,
                                                                           AsyncHandler<CreateIntegrationInstanceRequest,CreateIntegrationInstanceResponse> handler)

Description copied from interface: IntegrationInstanceAsync

Creates a new Integration Instance.

Specified by:

createIntegrationInstance in interface IntegrationInstanceAsync

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.

deleteIntegrationInstance

public Future<DeleteIntegrationInstanceResponse> deleteIntegrationInstance(DeleteIntegrationInstanceRequest request,
                                                                           AsyncHandler<DeleteIntegrationInstanceRequest,DeleteIntegrationInstanceResponse> handler)

Description copied from interface: IntegrationInstanceAsync

Deletes an Integration Instance resource by identifier.

Specified by:

deleteIntegrationInstance in interface IntegrationInstanceAsync

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.

disasterRecoveryFailover

public Future<DisasterRecoveryFailoverResponse> disasterRecoveryFailover(DisasterRecoveryFailoverRequest request,
                                                                         AsyncHandler<DisasterRecoveryFailoverRequest,DisasterRecoveryFailoverResponse> handler)

Description copied from interface: IntegrationInstanceAsync

Allows failover for disaster recovery. Called in the context of integration instance in that region. Upon calling the failover api in the region where given instance was created, the intigration instance if primary will be switched to standby and crossRegion integration instance will be switched to primary and vice-versa.

Specified by:

disasterRecoveryFailover in interface IntegrationInstanceAsync

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.

enableProcessAutomation

public Future<EnableProcessAutomationResponse> enableProcessAutomation(EnableProcessAutomationRequest request,
                                                                       AsyncHandler<EnableProcessAutomationRequest,EnableProcessAutomationResponse> handler)

Description copied from interface: IntegrationInstanceAsync

Enable Process Automation for given Integration Instance

Specified by:

enableProcessAutomation in interface IntegrationInstanceAsync

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.

extendDataRetention

public Future<ExtendDataRetentionResponse> extendDataRetention(ExtendDataRetentionRequest request,
                                                               AsyncHandler<ExtendDataRetentionRequest,ExtendDataRetentionResponse> handler)

Description copied from interface: IntegrationInstanceAsync

Extend Data Retention period for given Integration Instance

Specified by:

extendDataRetention in interface IntegrationInstanceAsync

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.

getIntegrationInstance

public Future<GetIntegrationInstanceResponse> getIntegrationInstance(GetIntegrationInstanceRequest request,
                                                                     AsyncHandler<GetIntegrationInstanceRequest,GetIntegrationInstanceResponse> handler)

Description copied from interface: IntegrationInstanceAsync

Gets a IntegrationInstance by identifier

Specified by:

getIntegrationInstance in interface IntegrationInstanceAsync

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.

getWorkRequest

public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Description copied from interface: IntegrationInstanceAsync

Gets the status of the work request with the given ID.

Specified by:

getWorkRequest in interface IntegrationInstanceAsync

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.

listIntegrationInstances

public Future<ListIntegrationInstancesResponse> listIntegrationInstances(ListIntegrationInstancesRequest request,
                                                                         AsyncHandler<ListIntegrationInstancesRequest,ListIntegrationInstancesResponse> handler)

Description copied from interface: IntegrationInstanceAsync

Returns a list of Integration Instances.

Specified by:

listIntegrationInstances in interface IntegrationInstanceAsync

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.

listWorkRequestErrors

public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Description copied from interface: IntegrationInstanceAsync

Get the errors of a work request.

Specified by:

listWorkRequestErrors in interface IntegrationInstanceAsync

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.

listWorkRequestLogs

public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Description copied from interface: IntegrationInstanceAsync

Get the logs of a work request.

Specified by:

listWorkRequestLogs in interface IntegrationInstanceAsync

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.

listWorkRequests

public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Description copied from interface: IntegrationInstanceAsync

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface IntegrationInstanceAsync

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.

removeOracleManagedCustomEndpoint

public Future<RemoveOracleManagedCustomEndpointResponse> removeOracleManagedCustomEndpoint(RemoveOracleManagedCustomEndpointRequest request,
                                                                                           AsyncHandler<RemoveOracleManagedCustomEndpointRequest,RemoveOracleManagedCustomEndpointResponse> handler)

Description copied from interface: IntegrationInstanceAsync

Remove Oracle Managed Custom Endpoint for given integration instance that was previously enabled.

Specified by:

removeOracleManagedCustomEndpoint in interface IntegrationInstanceAsync

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.

startIntegrationInstance

public Future<StartIntegrationInstanceResponse> startIntegrationInstance(StartIntegrationInstanceRequest request,
                                                                         AsyncHandler<StartIntegrationInstanceRequest,StartIntegrationInstanceResponse> handler)

Description copied from interface: IntegrationInstanceAsync

Start an integration instance that was previously in an INACTIVE state

Specified by:

startIntegrationInstance in interface IntegrationInstanceAsync

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.

stopIntegrationInstance

public Future<StopIntegrationInstanceResponse> stopIntegrationInstance(StopIntegrationInstanceRequest request,
                                                                       AsyncHandler<StopIntegrationInstanceRequest,StopIntegrationInstanceResponse> handler)

Description copied from interface: IntegrationInstanceAsync

Stop an integration instance that was previously in an ACTIVE state

Specified by:

stopIntegrationInstance in interface IntegrationInstanceAsync

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.

updateIntegrationInstance

public Future<UpdateIntegrationInstanceResponse> updateIntegrationInstance(UpdateIntegrationInstanceRequest request,
                                                                           AsyncHandler<UpdateIntegrationInstanceRequest,UpdateIntegrationInstanceResponse> handler)

Description copied from interface: IntegrationInstanceAsync

Updates the Integration Instance.

Specified by:

updateIntegrationInstance in interface IntegrationInstanceAsync

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)