Package com.oracle.bmc.distributeddatabase

Class DistributedDbPrivateEndpointServiceClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.distributeddatabase.DistributedDbPrivateEndpointServiceClient

All Implemented Interfaces:

DistributedDbPrivateEndpointService, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20250101")
public class DistributedDbPrivateEndpointServiceClient
extends BaseSyncClient
implements DistributedDbPrivateEndpointService

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static DistributedDbPrivateEndpointServiceClient.Builder	builder()	Create a builder for this client.
ChangeDistributedDatabasePrivateEndpointCompartmentResponse	changeDistributedDatabasePrivateEndpointCompartment(ChangeDistributedDatabasePrivateEndpointCompartmentRequest request)	Moves the DistributedDatabasePrivateEndpoint to the specified compartment.
void	close()
CreateDistributedDatabasePrivateEndpointResponse	createDistributedDatabasePrivateEndpoint(CreateDistributedDatabasePrivateEndpointRequest request)	Creates a DistributedDatabasePrivateEndpoint.
DeleteDistributedDatabasePrivateEndpointResponse	deleteDistributedDatabasePrivateEndpoint(DeleteDistributedDatabasePrivateEndpointRequest request)	Deletes the given DistributedDatabasePrivateEndpoint.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
GetDistributedDatabasePrivateEndpointResponse	getDistributedDatabasePrivateEndpoint(GetDistributedDatabasePrivateEndpointRequest request)	Get the DistributedDatabasePrivateEndpoint resource.
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
DistributedDbPrivateEndpointServicePaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
DistributedDbPrivateEndpointServiceWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListDistributedDatabasePrivateEndpointsResponse	listDistributedDatabasePrivateEndpoints(ListDistributedDatabasePrivateEndpointsRequest request)	List of DistributedDatabasePrivateEndpoints.
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.
ReinstateProxyInstanceResponse	reinstateProxyInstance(ReinstateProxyInstanceRequest request)	Reinstates the proxy instance associated with the DistributedDatabasePrivateEndpoint.
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.
UpdateDistributedDatabasePrivateEndpointResponse	updateDistributedDatabasePrivateEndpoint(UpdateDistributedDatabasePrivateEndpointRequest request)	Updates the configuration of DistributedDatabasePrivateEndpoint.
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.distributeddatabase.DistributedDbPrivateEndpointService

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for DistributedDbPrivateEndpointService.

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

DistributedDbPrivateEndpointServiceClient

@Deprecated
public DistributedDbPrivateEndpointServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

DistributedDbPrivateEndpointServiceClient

@Deprecated
public DistributedDbPrivateEndpointServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                 ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

DistributedDbPrivateEndpointServiceClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

DistributedDbPrivateEndpointServiceClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DistributedDbPrivateEndpointServiceClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DistributedDbPrivateEndpointServiceClient

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

DistributedDbPrivateEndpointServiceClient

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

DistributedDbPrivateEndpointServiceClient

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

Method Detail

builder

public static DistributedDbPrivateEndpointServiceClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DistributedDbPrivateEndpointService

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 DistributedDbPrivateEndpointService

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DistributedDbPrivateEndpointService

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 DistributedDbPrivateEndpointService

Parameters:

regionId - The public region ID.

changeDistributedDatabasePrivateEndpointCompartment

public ChangeDistributedDatabasePrivateEndpointCompartmentResponse changeDistributedDatabasePrivateEndpointCompartment(ChangeDistributedDatabasePrivateEndpointCompartmentRequest request)

Description copied from interface: DistributedDbPrivateEndpointService

Moves the DistributedDatabasePrivateEndpoint to the specified compartment.

Specified by:

changeDistributedDatabasePrivateEndpointCompartment in interface DistributedDbPrivateEndpointService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDistributedDatabasePrivateEndpoint

public CreateDistributedDatabasePrivateEndpointResponse createDistributedDatabasePrivateEndpoint(CreateDistributedDatabasePrivateEndpointRequest request)

Description copied from interface: DistributedDbPrivateEndpointService

Creates a DistributedDatabasePrivateEndpoint.

Specified by:

createDistributedDatabasePrivateEndpoint in interface DistributedDbPrivateEndpointService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDistributedDatabasePrivateEndpoint

public DeleteDistributedDatabasePrivateEndpointResponse deleteDistributedDatabasePrivateEndpoint(DeleteDistributedDatabasePrivateEndpointRequest request)

Description copied from interface: DistributedDbPrivateEndpointService

Deletes the given DistributedDatabasePrivateEndpoint.

Specified by:

deleteDistributedDatabasePrivateEndpoint in interface DistributedDbPrivateEndpointService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDistributedDatabasePrivateEndpoint

public GetDistributedDatabasePrivateEndpointResponse getDistributedDatabasePrivateEndpoint(GetDistributedDatabasePrivateEndpointRequest request)

Description copied from interface: DistributedDbPrivateEndpointService

Get the DistributedDatabasePrivateEndpoint resource.

Specified by:

getDistributedDatabasePrivateEndpoint in interface DistributedDbPrivateEndpointService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDistributedDatabasePrivateEndpoints

public ListDistributedDatabasePrivateEndpointsResponse listDistributedDatabasePrivateEndpoints(ListDistributedDatabasePrivateEndpointsRequest request)

Description copied from interface: DistributedDbPrivateEndpointService

List of DistributedDatabasePrivateEndpoints.

Specified by:

listDistributedDatabasePrivateEndpoints in interface DistributedDbPrivateEndpointService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

reinstateProxyInstance

public ReinstateProxyInstanceResponse reinstateProxyInstance(ReinstateProxyInstanceRequest request)

Description copied from interface: DistributedDbPrivateEndpointService

Reinstates the proxy instance associated with the DistributedDatabasePrivateEndpoint.

Specified by:

reinstateProxyInstance in interface DistributedDbPrivateEndpointService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDistributedDatabasePrivateEndpoint

public UpdateDistributedDatabasePrivateEndpointResponse updateDistributedDatabasePrivateEndpoint(UpdateDistributedDatabasePrivateEndpointRequest request)

Description copied from interface: DistributedDbPrivateEndpointService

Updates the configuration of DistributedDatabasePrivateEndpoint.

Specified by:

updateDistributedDatabasePrivateEndpoint in interface DistributedDbPrivateEndpointService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public DistributedDbPrivateEndpointServiceWaiters getWaiters()

Description copied from interface: DistributedDbPrivateEndpointService

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

Specified by:

getWaiters in interface DistributedDbPrivateEndpointService

Returns:

The service waiters.

getPaginators

public DistributedDbPrivateEndpointServicePaginators getPaginators()

Description copied from interface: DistributedDbPrivateEndpointService

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 DistributedDbPrivateEndpointService

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