Interface Postgresql
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
PostgresqlClient
@Generated(value="OracleSDKGenerator", comments="API Version: 20220915") public interface Postgresql extends AutoCloseable
Use the OCI Database with PostgreSQL API to manage resources such as database systems, database nodes, backups, and configurations.For information, see the user guide documentation for the service.
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description BackupCopyResponse
backupCopy(BackupCopyRequest request)
Backup Copy Request to copy back up in remote region.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.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.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.String
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)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
refreshClient()
Rebuilds the client from scratch.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)
Sets the endpoint to call (ex, https://www.example.com).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.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 realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.-
Methods inherited from interface java.lang.AutoCloseable
close
-
-
-
-
Method Detail
-
refreshClient
void refreshClient()
Rebuilds the client from scratch.Useful to refresh certificates.
-
setEndpoint
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).- Parameters:
endpoint
- The endpoint of the service.
-
getEndpoint
String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
-
setRegion
void setRegion(Region region)
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.- Parameters:
region
- The region of the service.
-
setRegion
void setRegion(String regionId)
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 callsetEndpoint
.- Parameters:
regionId
- The public region ID.
-
useRealmSpecificEndpointTemplate
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
- Parameters:
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint template
-
backupCopy
BackupCopyResponse backupCopy(BackupCopyRequest request)
Backup Copy Request to copy back up in remote region.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/BackupCopyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BackupCopy API.
-
changeBackupCompartment
ChangeBackupCompartmentResponse changeBackupCompartment(ChangeBackupCompartmentRequest request)
Moves a backup from one compartment to another.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/ChangeBackupCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeBackupCompartment API.
-
changeConfigurationCompartment
ChangeConfigurationCompartmentResponse changeConfigurationCompartment(ChangeConfigurationCompartmentRequest request)
Moves a configuration from one compartment to another.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/ChangeConfigurationCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeConfigurationCompartment API.
-
changeDbSystemCompartment
ChangeDbSystemCompartmentResponse changeDbSystemCompartment(ChangeDbSystemCompartmentRequest request)
Moves a database system from one compartment to another.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/ChangeDbSystemCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeDbSystemCompartment API.
-
createBackup
CreateBackupResponse createBackup(CreateBackupRequest request)
Creates a new backup.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/CreateBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateBackup API.
-
createConfiguration
CreateConfigurationResponse createConfiguration(CreateConfigurationRequest request)
Creates a new configuration.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/CreateConfigurationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateConfiguration API.
-
createDbSystem
CreateDbSystemResponse createDbSystem(CreateDbSystemRequest request)
Creates a new database system.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/CreateDbSystemExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDbSystem API.
-
deleteBackup
DeleteBackupResponse deleteBackup(DeleteBackupRequest request)
Deletes a backup by identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/DeleteBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteBackup API.
-
deleteConfiguration
DeleteConfigurationResponse deleteConfiguration(DeleteConfigurationRequest request)
Deletes a configuration by identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/DeleteConfigurationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteConfiguration API.
-
deleteDbSystem
DeleteDbSystemResponse deleteDbSystem(DeleteDbSystemRequest request)
Deletes a database system by identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/DeleteDbSystemExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDbSystem API.
-
failoverDbSystem
FailoverDbSystemResponse failoverDbSystem(FailoverDbSystemRequest request)
Runs a failover operation.Optionally, specify the desired AD for regions with three ADs.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/FailoverDbSystemExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use FailoverDbSystem API.
-
getBackup
GetBackupResponse getBackup(GetBackupRequest request)
Gets a backup by identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/GetBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetBackup API.
-
getConfiguration
GetConfigurationResponse getConfiguration(GetConfigurationRequest request)
Gets a configuration by identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/GetConfigurationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetConfiguration API.
-
getConnectionDetails
GetConnectionDetailsResponse getConnectionDetails(GetConnectionDetailsRequest request)
Gets the database system connection details.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/GetConnectionDetailsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetConnectionDetails API.
-
getDbSystem
GetDbSystemResponse getDbSystem(GetDbSystemRequest request)
Gets a database system by identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/GetDbSystemExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDbSystem API.
-
getDefaultConfiguration
GetDefaultConfigurationResponse getDefaultConfiguration(GetDefaultConfigurationRequest request)
Gets a default configuration by identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/GetDefaultConfigurationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDefaultConfiguration API.
-
getPrimaryDbInstance
GetPrimaryDbInstanceResponse getPrimaryDbInstance(GetPrimaryDbInstanceRequest request)
Gets the primary database instance node details.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/GetPrimaryDbInstanceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPrimaryDbInstance API.
-
getWorkRequest
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Gets details of the work request with the given ID.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.
-
listBackups
ListBackupsResponse listBackups(ListBackupsRequest request)
Returns a list of backups.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/ListBackupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBackups API.
-
listConfigurations
ListConfigurationsResponse listConfigurations(ListConfigurationsRequest request)
Returns a list of configurations.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/ListConfigurationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListConfigurations API.
-
listDbSystems
ListDbSystemsResponse listDbSystems(ListDbSystemsRequest request)
Returns a list of database systems.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/ListDbSystemsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDbSystems API.
-
listDefaultConfigurations
ListDefaultConfigurationsResponse listDefaultConfigurations(ListDefaultConfigurationsRequest request)
Returns a list of default configurations.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/ListDefaultConfigurationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDefaultConfigurations API.
-
listShapes
ListShapesResponse listShapes(ListShapesRequest request)
Returns the list of shapes allowed in the region.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/ListShapesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListShapes API.
-
listWorkRequestErrors
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Returns a (paginated) list of errors for the work request with the given ID.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/ListWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestErrors API.
-
listWorkRequestLogs
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Returns a (paginated) list of logs for the work request with the given ID.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/ListWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestLogs API.
-
listWorkRequests
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.
-
patchDbSystem
PatchDbSystemResponse patchDbSystem(PatchDbSystemRequest request)
Modifies the database system by adding or removing database instance nodes.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/PatchDbSystemExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PatchDbSystem API.
-
resetMasterUserPassword
ResetMasterUserPasswordResponse resetMasterUserPassword(ResetMasterUserPasswordRequest request)
Resets the database system’s master password.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/ResetMasterUserPasswordExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ResetMasterUserPassword API.
-
restartDbInstanceInDbSystem
RestartDbInstanceInDbSystemResponse restartDbInstanceInDbSystem(RestartDbInstanceInDbSystemRequest request)
Restarts the running database instance node.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/RestartDbInstanceInDbSystemExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RestartDbInstanceInDbSystem API.
-
restoreDbSystem
RestoreDbSystemResponse restoreDbSystem(RestoreDbSystemRequest request)
Restore the database system.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/RestoreDbSystemExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RestoreDbSystem API.
-
updateBackup
UpdateBackupResponse updateBackup(UpdateBackupRequest request)
Updates the backup.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/UpdateBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateBackup API.
-
updateConfiguration
UpdateConfigurationResponse updateConfiguration(UpdateConfigurationRequest request)
Updates a display name or description of the configuration.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/UpdateConfigurationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateConfiguration API.
-
updateDbSystem
UpdateDbSystemResponse updateDbSystem(UpdateDbSystemRequest request)
Updates the database system.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/UpdateDbSystemExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDbSystem API.
-
updateDbSystemDbInstance
UpdateDbSystemDbInstanceResponse updateDbSystemDbInstance(UpdateDbSystemDbInstanceRequest request)
Updates the database instance node.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/psql/UpdateDbSystemDbInstanceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDbSystemDbInstance API.
-
getWaiters
PostgresqlWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.- Returns:
- The service waiters.
-
getPaginators
PostgresqlPaginators getPaginators()
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.- Returns:
- The service paginators.
-
-