@Generated(value="OracleSDKGenerator", comments="API Version: 20220915") public class PostgresqlAsyncClient extends BaseAsyncClient implements PostgresqlAsync
Async client implementation for Postgresql service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response
to the call is an InputStream
, like getObject Api in object storage service,
developers need to process the stream in AsyncHandler, and not anywhere else, because the stream
will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done
with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or
the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the
AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine
whether or not the request was completed via Future.isDone/isCancelled.
Please refer to
https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java
Modifier and Type | Class and Description |
---|---|
static class |
PostgresqlAsyncClient.Builder
Builder class for this client.
|
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 Postgresql.
|
Constructor and Description |
---|
PostgresqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
PostgresqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
PostgresqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
PostgresqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
PostgresqlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
PostgresqlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
PostgresqlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for Postgresql.
public final String clientCommonLibraryVersion
@Deprecated public PostgresqlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see PostgresqlAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public PostgresqlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see PostgresqlAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public PostgresqlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see PostgresqlAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public PostgresqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see PostgresqlAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public PostgresqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see PostgresqlAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public PostgresqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see PostgresqlAsyncClient.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)
@Deprecated public PostgresqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see PostgresqlAsyncClient.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
public static PostgresqlAsyncClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
PostgresqlAsync
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.
setRegion
in interface PostgresqlAsync
region
- The region of the service.public void setRegion(String regionId)
PostgresqlAsync
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
.
setRegion
in interface PostgresqlAsync
regionId
- The public region ID.public Future<ChangeBackupCompartmentResponse> changeBackupCompartment(ChangeBackupCompartmentRequest request, AsyncHandler<ChangeBackupCompartmentRequest,ChangeBackupCompartmentResponse> handler)
PostgresqlAsync
Moves a backup from one compartment to another. When provided, If-Match is checked against ETag values of the resource.
changeBackupCompartment
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeConfigurationCompartmentResponse> changeConfigurationCompartment(ChangeConfigurationCompartmentRequest request, AsyncHandler<ChangeConfigurationCompartmentRequest,ChangeConfigurationCompartmentResponse> handler)
PostgresqlAsync
Moves a configuration from one compartment to another. When provided, If-Match is checked against ETag values of the resource.
changeConfigurationCompartment
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeDbSystemCompartmentResponse> changeDbSystemCompartment(ChangeDbSystemCompartmentRequest request, AsyncHandler<ChangeDbSystemCompartmentRequest,ChangeDbSystemCompartmentResponse> handler)
PostgresqlAsync
Moves a database system from one compartment to another. When provided, If-Match is checked against ETag values of the resource.
changeDbSystemCompartment
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateBackupResponse> createBackup(CreateBackupRequest request, AsyncHandler<CreateBackupRequest,CreateBackupResponse> handler)
PostgresqlAsync
Creates a new backup.
createBackup
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateConfigurationResponse> createConfiguration(CreateConfigurationRequest request, AsyncHandler<CreateConfigurationRequest,CreateConfigurationResponse> handler)
PostgresqlAsync
Creates a new configuration.
createConfiguration
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateDbSystemResponse> createDbSystem(CreateDbSystemRequest request, AsyncHandler<CreateDbSystemRequest,CreateDbSystemResponse> handler)
PostgresqlAsync
Creates a new database system.
createDbSystem
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteBackupResponse> deleteBackup(DeleteBackupRequest request, AsyncHandler<DeleteBackupRequest,DeleteBackupResponse> handler)
PostgresqlAsync
Deletes a backup by identifier.
deleteBackup
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteConfigurationResponse> deleteConfiguration(DeleteConfigurationRequest request, AsyncHandler<DeleteConfigurationRequest,DeleteConfigurationResponse> handler)
PostgresqlAsync
Deletes a configuration by identifier.
deleteConfiguration
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteDbSystemResponse> deleteDbSystem(DeleteDbSystemRequest request, AsyncHandler<DeleteDbSystemRequest,DeleteDbSystemResponse> handler)
PostgresqlAsync
Deletes a database system by identifier.
deleteDbSystem
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<FailoverDbSystemResponse> failoverDbSystem(FailoverDbSystemRequest request, AsyncHandler<FailoverDbSystemRequest,FailoverDbSystemResponse> handler)
PostgresqlAsync
Runs a failover operation. Optionally, specify the desired AD for regions with three ADs.
failoverDbSystem
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetBackupResponse> getBackup(GetBackupRequest request, AsyncHandler<GetBackupRequest,GetBackupResponse> handler)
PostgresqlAsync
Gets a backup by identifier.
getBackup
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetConfigurationResponse> getConfiguration(GetConfigurationRequest request, AsyncHandler<GetConfigurationRequest,GetConfigurationResponse> handler)
PostgresqlAsync
Gets a configuration by identifier.
getConfiguration
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetConnectionDetailsResponse> getConnectionDetails(GetConnectionDetailsRequest request, AsyncHandler<GetConnectionDetailsRequest,GetConnectionDetailsResponse> handler)
PostgresqlAsync
Gets the database system connection details.
getConnectionDetails
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetDbSystemResponse> getDbSystem(GetDbSystemRequest request, AsyncHandler<GetDbSystemRequest,GetDbSystemResponse> handler)
PostgresqlAsync
Gets a database system by identifier.
getDbSystem
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetDefaultConfigurationResponse> getDefaultConfiguration(GetDefaultConfigurationRequest request, AsyncHandler<GetDefaultConfigurationRequest,GetDefaultConfigurationResponse> handler)
PostgresqlAsync
Gets a default configuration by identifier.
getDefaultConfiguration
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetPrimaryDbInstanceResponse> getPrimaryDbInstance(GetPrimaryDbInstanceRequest request, AsyncHandler<GetPrimaryDbInstanceRequest,GetPrimaryDbInstanceResponse> handler)
PostgresqlAsync
Gets the primary database instance node details.
getPrimaryDbInstance
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
PostgresqlAsync
Gets details of the work request with the given ID.
getWorkRequest
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListBackupsResponse> listBackups(ListBackupsRequest request, AsyncHandler<ListBackupsRequest,ListBackupsResponse> handler)
PostgresqlAsync
Returns a list of backups.
listBackups
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListConfigurationsResponse> listConfigurations(ListConfigurationsRequest request, AsyncHandler<ListConfigurationsRequest,ListConfigurationsResponse> handler)
PostgresqlAsync
Returns a list of configurations.
listConfigurations
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListDbSystemsResponse> listDbSystems(ListDbSystemsRequest request, AsyncHandler<ListDbSystemsRequest,ListDbSystemsResponse> handler)
PostgresqlAsync
Returns a list of database systems.
listDbSystems
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListDefaultConfigurationsResponse> listDefaultConfigurations(ListDefaultConfigurationsRequest request, AsyncHandler<ListDefaultConfigurationsRequest,ListDefaultConfigurationsResponse> handler)
PostgresqlAsync
Returns a list of default configurations.
listDefaultConfigurations
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListShapesResponse> listShapes(ListShapesRequest request, AsyncHandler<ListShapesRequest,ListShapesResponse> handler)
PostgresqlAsync
Returns the list of shapes allowed in the region.
listShapes
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
PostgresqlAsync
Returns a (paginated) list of errors for the work request with the given ID.
listWorkRequestErrors
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
PostgresqlAsync
Returns a (paginated) list of logs for the work request with the given ID.
listWorkRequestLogs
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
PostgresqlAsync
Lists the work requests in a compartment.
listWorkRequests
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<PatchDbSystemResponse> patchDbSystem(PatchDbSystemRequest request, AsyncHandler<PatchDbSystemRequest,PatchDbSystemResponse> handler)
PostgresqlAsync
Modifies the database system by adding or removing database instance nodes.
patchDbSystem
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ResetMasterUserPasswordResponse> resetMasterUserPassword(ResetMasterUserPasswordRequest request, AsyncHandler<ResetMasterUserPasswordRequest,ResetMasterUserPasswordResponse> handler)
PostgresqlAsync
Resets the database system’s master password.
resetMasterUserPassword
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RestartDbInstanceInDbSystemResponse> restartDbInstanceInDbSystem(RestartDbInstanceInDbSystemRequest request, AsyncHandler<RestartDbInstanceInDbSystemRequest,RestartDbInstanceInDbSystemResponse> handler)
PostgresqlAsync
Restarts the running database instance node.
restartDbInstanceInDbSystem
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RestoreDbSystemResponse> restoreDbSystem(RestoreDbSystemRequest request, AsyncHandler<RestoreDbSystemRequest,RestoreDbSystemResponse> handler)
PostgresqlAsync
Restore the database system.
restoreDbSystem
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateBackupResponse> updateBackup(UpdateBackupRequest request, AsyncHandler<UpdateBackupRequest,UpdateBackupResponse> handler)
PostgresqlAsync
Updates the backup.
updateBackup
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateConfigurationResponse> updateConfiguration(UpdateConfigurationRequest request, AsyncHandler<UpdateConfigurationRequest,UpdateConfigurationResponse> handler)
PostgresqlAsync
Updates a display name or description of the configuration.
updateConfiguration
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateDbSystemResponse> updateDbSystem(UpdateDbSystemRequest request, AsyncHandler<UpdateDbSystemRequest,UpdateDbSystemResponse> handler)
PostgresqlAsync
Updates the database system.
updateDbSystem
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateDbSystemDbInstanceResponse> updateDbSystemDbInstance(UpdateDbSystemDbInstanceRequest request, AsyncHandler<UpdateDbSystemDbInstanceRequest,UpdateDbSystemDbInstanceResponse> handler)
PostgresqlAsync
Updates the database instance node.
updateDbSystemDbInstance
in interface PostgresqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
public String getClientCommonLibraryVersion()
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
Copyright © 2016–2024. All rights reserved.