com.oracle.bmc.integration

Interface IntegrationInstanceAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

IntegrationInstanceAsyncClient

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

Oracle Integration API.

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.
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.
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	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetIntegrationInstanceResponse>	getIntegrationInstance(GetIntegrationInstanceRequest request, AsyncHandler<GetIntegrationInstanceRequest,GetIntegrationInstanceResponse> handler) Gets a IntegrationInstance by identifier
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	refreshClient() Rebuilds the client from scratch.
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) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
Future<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
Future<UpdateIntegrationInstanceResponse>	updateIntegrationInstance(UpdateIntegrationInstanceRequest request, AsyncHandler<UpdateIntegrationInstanceRequest,UpdateIntegrationInstanceResponse> handler) Updates the Integration Instance.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

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

Parameters:

endpoint - The endpoint of the serice.

getEndpoint

String getEndpoint()

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

setRegion

void setRegion(Region region)

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

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

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

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

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

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

Parameters:

regionId - The public region ID.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

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

Parameters:

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

addOracleManagedCustomEndpoint

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

Enable Oracle Managed Custom Endpoint for given integration instance.

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

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

Change the compartment for an integration instance

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

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

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

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

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

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

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

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

Creates a new Integration Instance.

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

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

Deletes an Integration Instance resource by identifier.

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

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

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.

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

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

Enable Process Automation for given Integration Instance

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

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

Extend Data Retention period for given Integration Instance

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

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

Gets a IntegrationInstance by identifier

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

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

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

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

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

Returns a list of Integration Instances.

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

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

Get the errors of a work request.

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

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

Get the logs of a work request.

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

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

Lists the work requests in a compartment.

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

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

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

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

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

Start an integration instance that was previously in an INACTIVE state

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

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

Stop an integration instance that was previously in an ACTIVE state

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

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

Updates the Integration Instance.

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.