Package com.oracle.bmc.dbmulticloud

Class OracleDBAzureConnectorClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.dbmulticloud.OracleDBAzureConnectorClient

All Implemented Interfaces:

OracleDBAzureConnector, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240501")
public class OracleDBAzureConnectorClient
extends BaseSyncClient
implements OracleDBAzureConnector

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OracleDBAzureConnectorClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	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 OracleDBAzureConnector.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static OracleDBAzureConnectorClient.Builder	builder()	Create a builder for this client.
ChangeOracleDbAzureConnectorCompartmentResponse	changeOracleDbAzureConnectorCompartment(ChangeOracleDbAzureConnectorCompartmentRequest request)	Moves the Oracle DB Azure Connector resource into a different compartment.
void	close()
CreateOracleDbAzureConnectorResponse	createOracleDbAzureConnector(CreateOracleDbAzureConnectorRequest request)	Creates Oracle DB Azure Connector resource and configured Azure Identity in Oracle Database resource.
DeleteOracleDbAzureConnectorResponse	deleteOracleDbAzureConnector(DeleteOracleDbAzureConnectorRequest request)	Deletes the Oracle DB Azure Identity Connector resource.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
GetOracleDbAzureConnectorResponse	getOracleDbAzureConnector(GetOracleDbAzureConnectorRequest request)	Retrieves the Oracle DB Azure Identity Connector for a specified resource OCID.
OracleDBAzureConnectorPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
OracleDBAzureConnectorWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListOracleDbAzureConnectorsResponse	listOracleDbAzureConnectors(ListOracleDbAzureConnectorsRequest request)	Lists all Oracle DB Azure Connector resources based on the specified filters.
PatchOracleDbAzureConnectorResponse	patchOracleDbAzureConnector(PatchOracleDbAzureConnectorRequest request)	Patch Azure Arc Agent on Oracle Cloud VM Cluster with new version.
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.
RefreshOracleDbAzureConnectorResponse	refreshOracleDbAzureConnector(RefreshOracleDbAzureConnectorRequest request)	Refreshes the Oracle DB Azure Connector resource.
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.
UpdateOracleDbAzureConnectorResponse	updateOracleDbAzureConnector(UpdateOracleDbAzureConnectorRequest request)	Modifies the existing Oracle DB Azure Connector resource for a given OCID.
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 java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.dbmulticloud.OracleDBAzureConnector

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for OracleDBAzureConnector.

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

OracleDBAzureConnectorClient

@Deprecated
public OracleDBAzureConnectorClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

OracleDBAzureConnectorClient

@Deprecated
public OracleDBAzureConnectorClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

OracleDBAzureConnectorClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

OracleDBAzureConnectorClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

OracleDBAzureConnectorClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

OracleDBAzureConnectorClient

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

OracleDBAzureConnectorClient

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

OracleDBAzureConnectorClient

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

Method Detail

builder

public static OracleDBAzureConnectorClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: OracleDBAzureConnector

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 OracleDBAzureConnector

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: OracleDBAzureConnector

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 OracleDBAzureConnector

Parameters:

regionId - The public region ID.

changeOracleDbAzureConnectorCompartment

public ChangeOracleDbAzureConnectorCompartmentResponse changeOracleDbAzureConnectorCompartment(ChangeOracleDbAzureConnectorCompartmentRequest request)

Description copied from interface: OracleDBAzureConnector

Moves the Oracle DB Azure Connector resource into a different compartment.

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

Specified by:

changeOracleDbAzureConnectorCompartment in interface OracleDBAzureConnector

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createOracleDbAzureConnector

public CreateOracleDbAzureConnectorResponse createOracleDbAzureConnector(CreateOracleDbAzureConnectorRequest request)

Description copied from interface: OracleDBAzureConnector

Creates Oracle DB Azure Connector resource and configured Azure Identity in Oracle Database resource.

Specified by:

createOracleDbAzureConnector in interface OracleDBAzureConnector

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteOracleDbAzureConnector

public DeleteOracleDbAzureConnectorResponse deleteOracleDbAzureConnector(DeleteOracleDbAzureConnectorRequest request)

Description copied from interface: OracleDBAzureConnector

Deletes the Oracle DB Azure Identity Connector resource.

Specified by:

deleteOracleDbAzureConnector in interface OracleDBAzureConnector

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getOracleDbAzureConnector

public GetOracleDbAzureConnectorResponse getOracleDbAzureConnector(GetOracleDbAzureConnectorRequest request)

Description copied from interface: OracleDBAzureConnector

Retrieves the Oracle DB Azure Identity Connector for a specified resource OCID.

Specified by:

getOracleDbAzureConnector in interface OracleDBAzureConnector

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOracleDbAzureConnectors

public ListOracleDbAzureConnectorsResponse listOracleDbAzureConnectors(ListOracleDbAzureConnectorsRequest request)

Description copied from interface: OracleDBAzureConnector

Lists all Oracle DB Azure Connector resources based on the specified filters.

Specified by:

listOracleDbAzureConnectors in interface OracleDBAzureConnector

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

patchOracleDbAzureConnector

public PatchOracleDbAzureConnectorResponse patchOracleDbAzureConnector(PatchOracleDbAzureConnectorRequest request)

Description copied from interface: OracleDBAzureConnector

Patch Azure Arc Agent on Oracle Cloud VM Cluster with new version.

Specified by:

patchOracleDbAzureConnector in interface OracleDBAzureConnector

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

refreshOracleDbAzureConnector

public RefreshOracleDbAzureConnectorResponse refreshOracleDbAzureConnector(RefreshOracleDbAzureConnectorRequest request)

Description copied from interface: OracleDBAzureConnector

Refreshes the Oracle DB Azure Connector resource.

Specified by:

refreshOracleDbAzureConnector in interface OracleDBAzureConnector

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateOracleDbAzureConnector

public UpdateOracleDbAzureConnectorResponse updateOracleDbAzureConnector(UpdateOracleDbAzureConnectorRequest request)

Description copied from interface: OracleDBAzureConnector

Modifies the existing Oracle DB Azure Connector resource for a given OCID.

Specified by:

updateOracleDbAzureConnector in interface OracleDBAzureConnector

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public OracleDBAzureConnectorWaiters getWaiters()

Description copied from interface: OracleDBAzureConnector

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

Specified by:

getWaiters in interface OracleDBAzureConnector

Returns:

The service waiters.

getPaginators

public OracleDBAzureConnectorPaginators getPaginators()

Description copied from interface: OracleDBAzureConnector

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 OracleDBAzureConnector

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