com.oracle.bmc.integration

Class IntegrationInstanceClient

java.lang.Object

com.oracle.bmc.integration.IntegrationInstanceClient

All Implemented Interfaces:

IntegrationInstance, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190131")
public class IntegrationInstanceClient
extends Object
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
static Service	SERVICE Service instance for IntegrationInstance.

Constructor Summary

Constructors

Modifier	Constructor and Description
	IntegrationInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	IntegrationInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	IntegrationInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
	IntegrationInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
	IntegrationInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Creates a new service instance using the given authentication provider and client configuration.
protected	IntegrationInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder) Creates a new service instance using the given authentication provider and client configuration.
	IntegrationInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	IntegrationInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	IntegrationInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Creates a new service instance using the given authentication provider and client configuration.

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.
void	close()
CreateIntegrationInstanceResponse	createIntegrationInstance(CreateIntegrationInstanceRequest request) Creates a new Integration Instance.
DeleteIntegrationInstanceResponse	deleteIntegrationInstance(DeleteIntegrationInstanceRequest request) Deletes an Integration Instance resource by identifier.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetIntegrationInstanceResponse	getIntegrationInstance(GetIntegrationInstanceRequest request) Gets a IntegrationInstance by identifier
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	refreshClient() Rebuilds the client from scratch.
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’).
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
UpdateIntegrationInstanceResponse	updateIntegrationInstance(UpdateIntegrationInstanceRequest request) Updates the Integration Instance.

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE

public static final Service SERVICE

Service instance for IntegrationInstance.

Constructor Detail

IntegrationInstanceClient

public IntegrationInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

IntegrationInstanceClient

public IntegrationInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration)

Creates a new service instance using the given authentication provider and client configuration.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

IntegrationInstanceClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

IntegrationInstanceClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

IntegrationInstanceClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

IntegrationInstanceClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

IntegrationInstanceClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

IntegrationInstanceClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor

IntegrationInstanceClient

protected IntegrationInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint,
                                    ExecutorService executorService,
                                    RestClientFactoryBuilder restClientFactoryBuilder)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed. Use the IntegrationInstanceClient.Builder to get access to all these parameters.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor

restClientFactoryBuilder - the builder for the RestClientFactory

Method Detail

builder

public static IntegrationInstanceClient.Builder builder()

Create a builder for this client.

Returns:

builder

refreshClient

public void refreshClient()

Description copied from interface: IntegrationInstance

Rebuilds the client from scratch. Useful to refresh certificates.

Specified by:

refreshClient in interface IntegrationInstance

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: IntegrationInstance

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

Specified by:

setEndpoint in interface IntegrationInstance

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: IntegrationInstance

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

Specified by:

getEndpoint in interface IntegrationInstance

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.

close

public void close()

Specified by:

close in interface AutoCloseable

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

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

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.