java.lang.Object
- com.oracle.bmc.http.internal.BaseSyncClient
- - com.oracle.bmc.psql.PostgresqlClient

All Implemented Interfaces:: Postgresql, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220915")
public class PostgresqlClient
extends BaseSyncClient
implements Postgresql

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PostgresqlClient.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 Postgresql.

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BackupCopyResponse`	`backupCopy(BackupCopyRequest request)`	Backup Copy Request to copy back up in remote region.
`static PostgresqlClient.Builder`	`builder()`	Create a builder for this client.
`ChangeBackupCompartmentResponse`	`changeBackupCompartment(ChangeBackupCompartmentRequest request)`	Moves a backup from one compartment to another.
`ChangeConfigurationCompartmentResponse`	`changeConfigurationCompartment(ChangeConfigurationCompartmentRequest request)`	Moves a configuration from one compartment to another.
`ChangeDbSystemCompartmentResponse`	`changeDbSystemCompartment(ChangeDbSystemCompartmentRequest request)`	Moves a database system from one compartment to another.
`void`	`close()`
`CreateBackupResponse`	`createBackup(CreateBackupRequest request)`	Creates a new backup.
`CreateConfigurationResponse`	`createConfiguration(CreateConfigurationRequest request)`	Creates a new configuration.
`CreateDbSystemResponse`	`createDbSystem(CreateDbSystemRequest request)`	Creates a new database system.
`DeleteBackupResponse`	`deleteBackup(DeleteBackupRequest request)`	Deletes a backup by identifier.
`DeleteConfigurationResponse`	`deleteConfiguration(DeleteConfigurationRequest request)`	Deletes a configuration by identifier.
`DeleteDbSystemResponse`	`deleteDbSystem(DeleteDbSystemRequest request)`	Deletes a database system by identifier.
`FailoverDbSystemResponse`	`failoverDbSystem(FailoverDbSystemRequest request)`	Runs a failover operation.
`GetBackupResponse`	`getBackup(GetBackupRequest request)`	Gets a backup by identifier.
`String`	`getClientCommonLibraryVersion()`
`GetConfigurationResponse`	`getConfiguration(GetConfigurationRequest request)`	Gets a configuration by identifier.
`GetConnectionDetailsResponse`	`getConnectionDetails(GetConnectionDetailsRequest request)`	Gets the database system connection details.
`GetDbSystemResponse`	`getDbSystem(GetDbSystemRequest request)`	Gets a database system by identifier.
`GetDefaultConfigurationResponse`	`getDefaultConfiguration(GetDefaultConfigurationRequest request)`	Gets a default configuration by identifier.
`protected ClientConfigurator`	`getDefaultConfigurator()`
`String`	`getEndpoint()`
`Optional<String>`	`getMinimumClientCommonLibraryVersionFromClient()`
`PostgresqlPaginators`	`getPaginators()`	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GetPrimaryDbInstanceResponse`	`getPrimaryDbInstance(GetPrimaryDbInstanceRequest request)`	Gets the primary database instance node details.
`PostgresqlWaiters`	`getWaiters()`	Gets the pre-configured waiters available for resources for this service.
`GetWorkRequestResponse`	`getWorkRequest(GetWorkRequestRequest request)`	Gets details of the work request with the given ID.
`ListBackupsResponse`	`listBackups(ListBackupsRequest request)`	Returns a list of backups.
`ListConfigurationsResponse`	`listConfigurations(ListConfigurationsRequest request)`	Returns a list of configurations.
`ListDbSystemsResponse`	`listDbSystems(ListDbSystemsRequest request)`	Returns a list of database systems.
`ListDefaultConfigurationsResponse`	`listDefaultConfigurations(ListDefaultConfigurationsRequest request)`	Returns a list of default configurations.
`ListShapesResponse`	`listShapes(ListShapesRequest request)`	Returns the list of shapes allowed in the region.
`ListWorkRequestErrorsResponse`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request)`	Returns a (paginated) list of errors for the work request with the given ID.
`ListWorkRequestLogsResponse`	`listWorkRequestLogs(ListWorkRequestLogsRequest request)`	Returns a (paginated) list of logs for the work request with the given ID.
`ListWorkRequestsResponse`	`listWorkRequests(ListWorkRequestsRequest request)`	Lists the work requests in a compartment.
`PatchDbSystemResponse`	`patchDbSystem(PatchDbSystemRequest request)`	Modifies the database system by adding or removing database instance nodes.
`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`.
`ResetMasterUserPasswordResponse`	`resetMasterUserPassword(ResetMasterUserPasswordRequest request)`	Resets the database system’s master password.
`RestartDbInstanceInDbSystemResponse`	`restartDbInstanceInDbSystem(RestartDbInstanceInDbSystemRequest request)`	Restarts the running database instance node.
`RestoreDbSystemResponse`	`restoreDbSystem(RestoreDbSystemRequest request)`	Restore the database system.
`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’).
`UpdateBackupResponse`	`updateBackup(UpdateBackupRequest request)`	Updates the backup.
`void`	`updateBaseEndpoint(String endpoint)`	This method should be used for parameterized endpoint templates only.
`UpdateConfigurationResponse`	`updateConfiguration(UpdateConfigurationRequest request)`	Updates a display name or description of the configuration.
`UpdateDbSystemResponse`	`updateDbSystem(UpdateDbSystemRequest request)`	Updates the database system.
`UpdateDbSystemDbInstanceResponse`	`updateDbSystemDbInstance(UpdateDbSystemDbInstanceRequest request)`	Updates the database instance node.
`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.psql.Postgresql
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for Postgresql.
  - 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
  - PostgresqlClient
```
@Deprecated
public PostgresqlClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see PostgresqlClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - PostgresqlClient
```
@Deprecated
public PostgresqlClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see PostgresqlClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - PostgresqlClient
```
@Deprecated
public PostgresqlClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration,
                        ClientConfigurator clientConfigurator)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see PostgresqlClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - PostgresqlClient
```
@Deprecated
public PostgresqlClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration,
                        ClientConfigurator clientConfigurator,
                        RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see PostgresqlClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
  - PostgresqlClient
```
@Deprecated
public PostgresqlClient(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 PostgresqlClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
  - PostgresqlClient
```
@Deprecated
public PostgresqlClient(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 PostgresqlClient.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)
  - PostgresqlClient
```
@Deprecated
public PostgresqlClient(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 PostgresqlClient.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
  - PostgresqlClient
```
@Deprecated
public PostgresqlClient(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 PostgresqlClient.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 - PostgresqlClient.Builder.executorService
- Method Detail
  - builder
```
public static PostgresqlClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: Postgresql
    
    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 Postgresql
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: Postgresql
    
    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 Postgresql
    
    Parameters:
    
    regionId - The public region ID.
  - backupCopy
```
public BackupCopyResponse backupCopy(BackupCopyRequest request)
```
    Description copied from interface: Postgresql
    
    Backup Copy Request to copy back up in remote region.
    When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    backupCopy in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeBackupCompartment
```
public ChangeBackupCompartmentResponse changeBackupCompartment(ChangeBackupCompartmentRequest request)
```
    Description copied from interface: Postgresql
    
    Moves a backup from one compartment to another.
    When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    changeBackupCompartment in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeConfigurationCompartment
```
public ChangeConfigurationCompartmentResponse changeConfigurationCompartment(ChangeConfigurationCompartmentRequest request)
```
    Description copied from interface: Postgresql
    
    Moves a configuration from one compartment to another.
    When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    changeConfigurationCompartment in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeDbSystemCompartment
```
public ChangeDbSystemCompartmentResponse changeDbSystemCompartment(ChangeDbSystemCompartmentRequest request)
```
    Description copied from interface: Postgresql
    
    Moves a database system from one compartment to another.
    When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    changeDbSystemCompartment in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createBackup
```
public CreateBackupResponse createBackup(CreateBackupRequest request)
```
    Description copied from interface: Postgresql
    
    Creates a new backup.
    
    Specified by:
    
    createBackup in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createConfiguration
```
public CreateConfigurationResponse createConfiguration(CreateConfigurationRequest request)
```
    Description copied from interface: Postgresql
    
    Creates a new configuration.
    
    Specified by:
    
    createConfiguration in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createDbSystem
```
public CreateDbSystemResponse createDbSystem(CreateDbSystemRequest request)
```
    Description copied from interface: Postgresql
    
    Creates a new database system.
    
    Specified by:
    
    createDbSystem in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteBackup
```
public DeleteBackupResponse deleteBackup(DeleteBackupRequest request)
```
    Description copied from interface: Postgresql
    
    Deletes a backup by identifier.
    
    Specified by:
    
    deleteBackup in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteConfiguration
```
public DeleteConfigurationResponse deleteConfiguration(DeleteConfigurationRequest request)
```
    Description copied from interface: Postgresql
    
    Deletes a configuration by identifier.
    
    Specified by:
    
    deleteConfiguration in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteDbSystem
```
public DeleteDbSystemResponse deleteDbSystem(DeleteDbSystemRequest request)
```
    Description copied from interface: Postgresql
    
    Deletes a database system by identifier.
    
    Specified by:
    
    deleteDbSystem in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - failoverDbSystem
```
public FailoverDbSystemResponse failoverDbSystem(FailoverDbSystemRequest request)
```
    Description copied from interface: Postgresql
    
    Runs a failover operation.
    Optionally, specify the desired AD for regions with three ADs.
    
    Specified by:
    
    failoverDbSystem in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getBackup
```
public GetBackupResponse getBackup(GetBackupRequest request)
```
    Description copied from interface: Postgresql
    
    Gets a backup by identifier.
    
    Specified by:
    
    getBackup in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getConfiguration
```
public GetConfigurationResponse getConfiguration(GetConfigurationRequest request)
```
    Description copied from interface: Postgresql
    
    Gets a configuration by identifier.
    
    Specified by:
    
    getConfiguration in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getConnectionDetails
```
public GetConnectionDetailsResponse getConnectionDetails(GetConnectionDetailsRequest request)
```
    Description copied from interface: Postgresql
    
    Gets the database system connection details.
    
    Specified by:
    
    getConnectionDetails in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDbSystem
```
public GetDbSystemResponse getDbSystem(GetDbSystemRequest request)
```
    Description copied from interface: Postgresql
    
    Gets a database system by identifier.
    
    Specified by:
    
    getDbSystem in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDefaultConfiguration
```
public GetDefaultConfigurationResponse getDefaultConfiguration(GetDefaultConfigurationRequest request)
```
    Description copied from interface: Postgresql
    
    Gets a default configuration by identifier.
    
    Specified by:
    
    getDefaultConfiguration in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getPrimaryDbInstance
```
public GetPrimaryDbInstanceResponse getPrimaryDbInstance(GetPrimaryDbInstanceRequest request)
```
    Description copied from interface: Postgresql
    
    Gets the primary database instance node details.
    
    Specified by:
    
    getPrimaryDbInstance in interface Postgresql
    
    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: Postgresql
    
    Gets details of the work request with the given ID.
    
    Specified by:
    
    getWorkRequest in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listBackups
```
public ListBackupsResponse listBackups(ListBackupsRequest request)
```
    Description copied from interface: Postgresql
    
    Returns a list of backups.
    
    Specified by:
    
    listBackups in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listConfigurations
```
public ListConfigurationsResponse listConfigurations(ListConfigurationsRequest request)
```
    Description copied from interface: Postgresql
    
    Returns a list of configurations.
    
    Specified by:
    
    listConfigurations in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listDbSystems
```
public ListDbSystemsResponse listDbSystems(ListDbSystemsRequest request)
```
    Description copied from interface: Postgresql
    
    Returns a list of database systems.
    
    Specified by:
    
    listDbSystems in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listDefaultConfigurations
```
public ListDefaultConfigurationsResponse listDefaultConfigurations(ListDefaultConfigurationsRequest request)
```
    Description copied from interface: Postgresql
    
    Returns a list of default configurations.
    
    Specified by:
    
    listDefaultConfigurations in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listShapes
```
public ListShapesResponse listShapes(ListShapesRequest request)
```
    Description copied from interface: Postgresql
    
    Returns the list of shapes allowed in the region.
    
    Specified by:
    
    listShapes in interface Postgresql
    
    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: Postgresql
    
    Returns a (paginated) list of errors for the work request with the given ID.
    
    Specified by:
    
    listWorkRequestErrors in interface Postgresql
    
    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: Postgresql
    
    Returns a (paginated) list of logs for the work request with the given ID.
    
    Specified by:
    
    listWorkRequestLogs in interface Postgresql
    
    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: Postgresql
    
    Lists the work requests in a compartment.
    
    Specified by:
    
    listWorkRequests in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - patchDbSystem
```
public PatchDbSystemResponse patchDbSystem(PatchDbSystemRequest request)
```
    Description copied from interface: Postgresql
    
    Modifies the database system by adding or removing database instance nodes.
    
    Specified by:
    
    patchDbSystem in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - resetMasterUserPassword
```
public ResetMasterUserPasswordResponse resetMasterUserPassword(ResetMasterUserPasswordRequest request)
```
    Description copied from interface: Postgresql
    
    Resets the database system’s master password.
    
    Specified by:
    
    resetMasterUserPassword in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - restartDbInstanceInDbSystem
```
public RestartDbInstanceInDbSystemResponse restartDbInstanceInDbSystem(RestartDbInstanceInDbSystemRequest request)
```
    Description copied from interface: Postgresql
    
    Restarts the running database instance node.
    
    Specified by:
    
    restartDbInstanceInDbSystem in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - restoreDbSystem
```
public RestoreDbSystemResponse restoreDbSystem(RestoreDbSystemRequest request)
```
    Description copied from interface: Postgresql
    
    Restore the database system.
    
    Specified by:
    
    restoreDbSystem in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateBackup
```
public UpdateBackupResponse updateBackup(UpdateBackupRequest request)
```
    Description copied from interface: Postgresql
    
    Updates the backup.
    
    Specified by:
    
    updateBackup in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateConfiguration
```
public UpdateConfigurationResponse updateConfiguration(UpdateConfigurationRequest request)
```
    Description copied from interface: Postgresql
    
    Updates a display name or description of the configuration.
    
    Specified by:
    
    updateConfiguration in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateDbSystem
```
public UpdateDbSystemResponse updateDbSystem(UpdateDbSystemRequest request)
```
    Description copied from interface: Postgresql
    
    Updates the database system.
    
    Specified by:
    
    updateDbSystem in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateDbSystemDbInstance
```
public UpdateDbSystemDbInstanceResponse updateDbSystemDbInstance(UpdateDbSystemDbInstanceRequest request)
```
    Description copied from interface: Postgresql
    
    Updates the database instance node.
    
    Specified by:
    
    updateDbSystemDbInstance in interface Postgresql
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public PostgresqlWaiters getWaiters()
```
    Description copied from interface: Postgresql
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface Postgresql
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public PostgresqlPaginators getPaginators()
```
    Description copied from interface: Postgresql
    
    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 Postgresql
    
    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()
```

Class PostgresqlClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.AutoCloseable

Methods inherited from interface com.oracle.bmc.psql.Postgresql

Field Detail

SERVICE

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

PostgresqlClient

PostgresqlClient

PostgresqlClient

PostgresqlClient

PostgresqlClient

PostgresqlClient

PostgresqlClient

PostgresqlClient

Method Detail

builder

setRegion

setRegion

backupCopy

changeBackupCompartment

changeConfigurationCompartment

changeDbSystemCompartment

createBackup

createConfiguration

createDbSystem

deleteBackup

deleteConfiguration

deleteDbSystem

failoverDbSystem

getBackup

getConfiguration

getConnectionDetails

getDbSystem

getDefaultConfiguration

getPrimaryDbInstance

getWorkRequest

listBackups

listConfigurations

listDbSystems

listDefaultConfigurations

listShapes

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

patchDbSystem

resetMasterUserPassword

restartDbInstanceInDbSystem

restoreDbSystem

updateBackup

updateConfiguration

updateDbSystem

updateDbSystemDbInstance

getWaiters

getPaginators

getDefaultConfigurator

useRealmSpecificEndpointTemplate

populateServiceParametersInEndpoint

updateBaseEndpoint

setEndpoint

getEndpoint

refreshClient

close

getClientCommonLibraryVersion

getMinimumClientCommonLibraryVersionFromClient