com.oracle.bmc.sch

Class ServiceConnectorClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.sch.ServiceConnectorClient

All Implemented Interfaces:

ServiceConnector, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200909")
public class ServiceConnectorClient
extends BaseSyncClient
implements ServiceConnector

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceConnectorClient.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 ServiceConnector.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ActivateServiceConnectorResponse	activateServiceConnector(ActivateServiceConnectorRequest request) Activates the specified connector.
static ServiceConnectorClient.Builder	builder() Create a builder for this client.
ChangeServiceConnectorCompartmentResponse	changeServiceConnectorCompartment(ChangeServiceConnectorCompartmentRequest request) Moves a connector into a different compartment within the same tenancy.
void	close()
CreateServiceConnectorResponse	createServiceConnector(CreateServiceConnectorRequest request) Creates a new connector in the specified compartment.
DeactivateServiceConnectorResponse	deactivateServiceConnector(DeactivateServiceConnectorRequest request) Deactivates the specified connector.
DeleteServiceConnectorResponse	deleteServiceConnector(DeleteServiceConnectorRequest request) Deletes the specified connector.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
ServiceConnectorPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetServiceConnectorResponse	getServiceConnector(GetServiceConnectorRequest request) Gets the specified connector’s configuration information.
ServiceConnectorWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request) Gets the details of the specified work request.
ListServiceConnectorsResponse	listServiceConnectors(ListServiceConnectorsRequest request) Lists connectors in the specified compartment.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request) Lists work request errors for the specified work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request) Lists logs for the specified work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request) Lists the work requests in the specified 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’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateServiceConnectorResponse	updateServiceConnector(UpdateServiceConnectorRequest request) Updates the configuration information for the specified connector.
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.sch.ServiceConnector

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ServiceConnector.

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

ServiceConnectorClient

@Deprecated
public ServiceConnectorClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

ServiceConnectorClient

@Deprecated
public ServiceConnectorClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                          ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ServiceConnectorClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ServiceConnectorClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ServiceConnectorClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ServiceConnectorClient

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

ServiceConnectorClient

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

ServiceConnectorClient

@Deprecated
public ServiceConnectorClient(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 ServiceConnectorClient.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 - ServiceConnectorClient.Builder.executorService

Method Detail

builder

public static ServiceConnectorClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ServiceConnector

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 ServiceConnector

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ServiceConnector

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 ServiceConnector

Parameters:

regionId - The public region ID.

activateServiceConnector

public ActivateServiceConnectorResponse activateServiceConnector(ActivateServiceConnectorRequest request)

Description copied from interface: ServiceConnector

Activates the specified connector.

After you send your request, the connector's state is temporarily UPDATING. When the state changes to ACTIVE, data begins transferring from the source service to the target service. For more information, see [Activating a Connector](https://docs.cloud.oracle.com/iaas/Content/connector-hub/activate-service-connector.htm).

Specified by:

activateServiceConnector in interface ServiceConnector

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeServiceConnectorCompartment

public ChangeServiceConnectorCompartmentResponse changeServiceConnectorCompartment(ChangeServiceConnectorCompartmentRequest request)

Description copied from interface: ServiceConnector

Moves a connector into a different compartment within the same tenancy. For more information, see Moving a Connector.

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

Specified by:

changeServiceConnectorCompartment in interface ServiceConnector

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createServiceConnector

public CreateServiceConnectorResponse createServiceConnector(CreateServiceConnectorRequest request)

Description copied from interface: ServiceConnector

Creates a new connector in the specified compartment. A connector is a logically defined flow for moving data from a source service to a destination service in Oracle Cloud Infrastructure. For more information, see Creating a Connector. For general information about connectors, see Overview of Connector Hub.

For purposes of access control, you must provide the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the connector to reside. Notice that the connector doesn't have to be in the same compartment as the source or target services. For information about access control and compartments, see [Overview of the IAM Service](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm).

After you send your request, the new connector's state is temporarily CREATING. When the state changes to ACTIVE, data begins transferring from the source service to the target service. For instructions on deactivating and activating connectors, see [Activating a Connector](https://docs.cloud.oracle.com/iaas/Content/connector-hub/activate-service-connector.htm).

Specified by:

createServiceConnector in interface ServiceConnector

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deactivateServiceConnector

public DeactivateServiceConnectorResponse deactivateServiceConnector(DeactivateServiceConnectorRequest request)

Description copied from interface: ServiceConnector

Deactivates the specified connector.

After you send your request, the connector's state is temporarily UPDATING and any data transfer stops. The state then changes to INACTIVE. For more information, see [Deactivating a Connector](https://docs.cloud.oracle.com/iaas/Content/connector-hub/deactivate-service-connector.htm).

Specified by:

deactivateServiceConnector in interface ServiceConnector

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteServiceConnector

public DeleteServiceConnectorResponse deleteServiceConnector(DeleteServiceConnectorRequest request)

Description copied from interface: ServiceConnector

Deletes the specified connector. For more information, see Deleting a Connector.

After you send your request, the connector's state is temporarily DELETING and any data transfer stops. The state then changes to DELETED.

Specified by:

deleteServiceConnector in interface ServiceConnector

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getServiceConnector

public GetServiceConnectorResponse getServiceConnector(GetServiceConnectorRequest request)

Description copied from interface: ServiceConnector

Gets the specified connector’s configuration information. For more information, see Getting a Connector.

Specified by:

getServiceConnector in interface ServiceConnector

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: ServiceConnector

Gets the details of the specified work request. For more information, see Getting a Work Request’s Details.

Specified by:

getWorkRequest in interface ServiceConnector

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listServiceConnectors

public ListServiceConnectorsResponse listServiceConnectors(ListServiceConnectorsRequest request)

Description copied from interface: ServiceConnector

Lists connectors in the specified compartment. For more information, see Listing Connectors.

Specified by:

listServiceConnectors in interface ServiceConnector

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: ServiceConnector

Lists work request errors for the specified work request. Results are paginated. For more information, see Listing Work Request Errors.

Specified by:

listWorkRequestErrors in interface ServiceConnector

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: ServiceConnector

Lists logs for the specified work request. Results are paginated. For more information, see Listing Work Request Log Entries.

Specified by:

listWorkRequestLogs in interface ServiceConnector

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: ServiceConnector

Lists the work requests in the specified compartment. For more information, see Listing Work Requests.

Specified by:

listWorkRequests in interface ServiceConnector

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateServiceConnector

public UpdateServiceConnectorResponse updateServiceConnector(UpdateServiceConnectorRequest request)

Description copied from interface: ServiceConnector

Updates the configuration information for the specified connector. For more information, see Updating a Connector.

After you send your request, the connector's state is temporarily UPDATING and any data transfer pauses. The state then changes back to its original value: if ACTIVE, then data transfer resumes.

Specified by:

updateServiceConnector in interface ServiceConnector

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public ServiceConnectorWaiters getWaiters()

Description copied from interface: ServiceConnector

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

Specified by:

getWaiters in interface ServiceConnector

Returns:

The service waiters.

getPaginators

public ServiceConnectorPaginators getPaginators()

Description copied from interface: ServiceConnector

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 ServiceConnector

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