All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DbBackupsClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190415")
public interface DbBackups
extends AutoCloseable
```
The API for the MySQL Database 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
`CancelBackupDeletionResponse`	`cancelBackupDeletion(CancelBackupDeletionRequest request)`	Cancels the scheduled deletion of a backup and moves it to ACTIVE state.
`ChangeBackupCompartmentResponse`	`changeBackupCompartment(ChangeBackupCompartmentRequest request)`	Moves a DB System Backup into a different compartment.
`CopyBackupResponse`	`copyBackup(CopyBackupRequest request)`	Creates a copy of a DB system backup available in the specified source region.
`CreateBackupResponse`	`createBackup(CreateBackupRequest request)`	Create a backup of a DB System.
`DeleteBackupResponse`	`deleteBackup(DeleteBackupRequest request)`	Delete a Backup.
`GetBackupResponse`	`getBackup(GetBackupRequest request)`	Get information about the specified Backup
`String`	`getEndpoint()`	Gets the set endpoint for REST call (ex, https://www.example.com)
`DbBackupsPaginators`	`getPaginators()`	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`DbBackupsWaiters`	`getWaiters()`	Gets the pre-configured waiters available for resources for this service.
`ListBackupsResponse`	`listBackups(ListBackupsRequest request)`	Get a list of DB System backups.
`void`	`refreshClient()`	Rebuilds the client from scratch.
`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)`	Update the metadata of a Backup.
`void`	`useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)`	Determines whether realm specific endpoint should be used or not.
`ValidateBackupResponse`	`validateBackup(ValidateBackupRequest request)`	Request to validate the backup by checking the data consistency.

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 call setEndpoint.
    
    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
  - cancelBackupDeletion
```
CancelBackupDeletionResponse cancelBackupDeletion(CancelBackupDeletionRequest request)
```
    Cancels the scheduled deletion of a backup and moves it to ACTIVE state.
    
    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_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/mysql/CancelBackupDeletionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelBackupDeletion API.
  - changeBackupCompartment
```
ChangeBackupCompartmentResponse changeBackupCompartment(ChangeBackupCompartmentRequest request)
```
    Moves a DB System Backup into a different compartment.
    When provided, If-Match is checked against ETag values of 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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/mysql/ChangeBackupCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeBackupCompartment API.
  - copyBackup
```
CopyBackupResponse copyBackup(CopyBackupRequest request)
```
    Creates a copy of a DB system backup available in the specified source 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_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/mysql/CopyBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CopyBackup API.
  - createBackup
```
CreateBackupResponse createBackup(CreateBackupRequest request)
```
    Create a backup of a DB 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_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/mysql/CreateBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateBackup API.
  - deleteBackup
```
DeleteBackupResponse deleteBackup(DeleteBackupRequest request)
```
    Delete a 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_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/mysql/DeleteBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteBackup API.
  - getBackup
```
GetBackupResponse getBackup(GetBackupRequest request)
```
    Get information about the specified 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_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/mysql/GetBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetBackup API.
  - listBackups
```
ListBackupsResponse listBackups(ListBackupsRequest request)
```
    Get a list of DB System 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_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/mysql/ListBackupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBackups API.
  - updateBackup
```
UpdateBackupResponse updateBackup(UpdateBackupRequest request)
```
    Update the metadata of a Backup.
    Metadata such as the displayName or description
    
    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_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/mysql/UpdateBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateBackup API.
  - validateBackup
```
ValidateBackupResponse validateBackup(ValidateBackupRequest request)
```
    Request to validate the backup by checking the data consistency.
    
    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_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/mysql/ValidateBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ValidateBackup API.
  - getWaiters
```
DbBackupsWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
DbBackupsPaginators 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.

Interface DbBackups

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

cancelBackupDeletion

changeBackupCompartment

copyBackup

createBackup

deleteBackup

getBackup

listBackups

updateBackup

validateBackup

getWaiters

getPaginators