com.oracle.bmc.integration

Class IntegrationInstanceClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.integration.IntegrationInstanceClient

All Implemented Interfaces:

IntegrationInstance, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190131")
public class IntegrationInstanceClient
extends BaseSyncClient
implements IntegrationInstance

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IntegrationInstanceClient.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
IntegrationInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
IntegrationInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
IntegrationInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
IntegrationInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
IntegrationInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
IntegrationInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
IntegrationInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
IntegrationInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static IntegrationInstanceClient.Builder	builder() Create a builder for this client.
ChangeIntegrationInstanceCompartmentResponse	changeIntegrationInstanceCompartment(ChangeIntegrationInstanceCompartmentRequest request) Change the compartment for an integration instance
ChangeIntegrationInstanceNetworkEndpointResponse	changeIntegrationInstanceNetworkEndpoint(ChangeIntegrationInstanceNetworkEndpointRequest request) Change an Integration instance network endpoint.
ChangePrivateEndpointOutboundConnectionResponse	changePrivateEndpointOutboundConnection(ChangePrivateEndpointOutboundConnectionRequest request) Change private endpoint outbound connection for given Integration instance.
void	close()
CreateIntegrationInstanceResponse	createIntegrationInstance(CreateIntegrationInstanceRequest request) Creates a new Integration Instance.
DeleteIntegrationInstanceResponse	deleteIntegrationInstance(DeleteIntegrationInstanceRequest request) Deletes an Integration Instance resource by identifier.
EnableProcessAutomationResponse	enableProcessAutomation(EnableProcessAutomationRequest request) Enable Process Automation for given Integration Instance
ExtendDataRetentionResponse	extendDataRetention(ExtendDataRetentionRequest request) Extend Data Retention period for given Integration Instance
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetIntegrationInstanceResponse	getIntegrationInstance(GetIntegrationInstanceRequest request) Gets a IntegrationInstance by identifier
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
IntegrationInstancePaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
IntegrationInstanceWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request) Gets the status of the work request with the given ID.
ListIntegrationInstancesResponse	listIntegrationInstances(ListIntegrationInstancesRequest request) Returns a list of Integration Instances.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request) Get the errors of a work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request) Get the logs of a work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request) 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.
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’).
StartIntegrationInstanceResponse	startIntegrationInstance(StartIntegrationInstanceRequest request) Start an integration instance that was previously in an INACTIVE state
StopIntegrationInstanceResponse	stopIntegrationInstance(StopIntegrationInstanceRequest request) 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.
UpdateIntegrationInstanceResponse	updateIntegrationInstance(UpdateIntegrationInstanceRequest request) 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 com.oracle.bmc.http.internal.BaseSyncClient

clientCall

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.IntegrationInstance

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

IntegrationInstanceClient

@Deprecated
public IntegrationInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

IntegrationInstanceClient

@Deprecated
public IntegrationInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                             ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

IntegrationInstanceClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

IntegrationInstanceClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

IntegrationInstanceClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

IntegrationInstanceClient

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

IntegrationInstanceClient

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

IntegrationInstanceClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see IntegrationInstanceClient.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

executorService - IntegrationInstanceClient.Builder.executorService

Method Detail

builder

public static IntegrationInstanceClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: IntegrationInstance

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 IntegrationInstance

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: IntegrationInstance

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 IntegrationInstance

Parameters:

regionId - The public region ID.

changeIntegrationInstanceCompartment

public ChangeIntegrationInstanceCompartmentResponse changeIntegrationInstanceCompartment(ChangeIntegrationInstanceCompartmentRequest request)

Description copied from interface: IntegrationInstance

Change the compartment for an integration instance

Specified by:

changeIntegrationInstanceCompartment in interface IntegrationInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeIntegrationInstanceNetworkEndpoint

public ChangeIntegrationInstanceNetworkEndpointResponse changeIntegrationInstanceNetworkEndpoint(ChangeIntegrationInstanceNetworkEndpointRequest request)

Description copied from interface: IntegrationInstance

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

Specified by:

changeIntegrationInstanceNetworkEndpoint in interface IntegrationInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changePrivateEndpointOutboundConnection

public ChangePrivateEndpointOutboundConnectionResponse changePrivateEndpointOutboundConnection(ChangePrivateEndpointOutboundConnectionRequest request)

Description copied from interface: IntegrationInstance

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

Specified by:

changePrivateEndpointOutboundConnection in interface IntegrationInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createIntegrationInstance

public CreateIntegrationInstanceResponse createIntegrationInstance(CreateIntegrationInstanceRequest request)

Description copied from interface: IntegrationInstance

Creates a new Integration Instance.

Specified by:

createIntegrationInstance in interface IntegrationInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteIntegrationInstance

public DeleteIntegrationInstanceResponse deleteIntegrationInstance(DeleteIntegrationInstanceRequest request)

Description copied from interface: IntegrationInstance

Deletes an Integration Instance resource by identifier.

Specified by:

deleteIntegrationInstance in interface IntegrationInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

enableProcessAutomation

public EnableProcessAutomationResponse enableProcessAutomation(EnableProcessAutomationRequest request)

Description copied from interface: IntegrationInstance

Enable Process Automation for given Integration Instance

Specified by:

enableProcessAutomation in interface IntegrationInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

extendDataRetention

public ExtendDataRetentionResponse extendDataRetention(ExtendDataRetentionRequest request)

Description copied from interface: IntegrationInstance

Extend Data Retention period for given Integration Instance

Specified by:

extendDataRetention in interface IntegrationInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getIntegrationInstance

public GetIntegrationInstanceResponse getIntegrationInstance(GetIntegrationInstanceRequest request)

Description copied from interface: IntegrationInstance

Gets a IntegrationInstance by identifier

Specified by:

getIntegrationInstance in interface IntegrationInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: IntegrationInstance

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

Specified by:

getWorkRequest in interface IntegrationInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listIntegrationInstances

public ListIntegrationInstancesResponse listIntegrationInstances(ListIntegrationInstancesRequest request)

Description copied from interface: IntegrationInstance

Returns a list of Integration Instances.

Specified by:

listIntegrationInstances in interface IntegrationInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: IntegrationInstance

Get the errors of a work request.

Specified by:

listWorkRequestErrors in interface IntegrationInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: IntegrationInstance

Get the logs of a work request.

Specified by:

listWorkRequestLogs in interface IntegrationInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: IntegrationInstance

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface IntegrationInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

startIntegrationInstance

public StartIntegrationInstanceResponse startIntegrationInstance(StartIntegrationInstanceRequest request)

Description copied from interface: IntegrationInstance

Start an integration instance that was previously in an INACTIVE state

Specified by:

startIntegrationInstance in interface IntegrationInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

stopIntegrationInstance

public StopIntegrationInstanceResponse stopIntegrationInstance(StopIntegrationInstanceRequest request)

Description copied from interface: IntegrationInstance

Stop an integration instance that was previously in an ACTIVE state

Specified by:

stopIntegrationInstance in interface IntegrationInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateIntegrationInstance

public UpdateIntegrationInstanceResponse updateIntegrationInstance(UpdateIntegrationInstanceRequest request)

Description copied from interface: IntegrationInstance

Updates the Integration Instance.

Specified by:

updateIntegrationInstance in interface IntegrationInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public IntegrationInstanceWaiters getWaiters()

Description copied from interface: IntegrationInstance

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface IntegrationInstance

Returns:

The service waiters.

getPaginators

public IntegrationInstancePaginators getPaginators()

Description copied from interface: IntegrationInstance

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface IntegrationInstance

Returns:

The service paginators.

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()