com.oracle.bmc.mysql

Interface DbBackups

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

Method Summary

Modifier and Type	Method and Description
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	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.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

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.

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.

Example: Click 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.

Example: Click 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.

Example: Click 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.

Example: Click 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.

Example: Click here to see how to use UpdateBackup 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.