All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

OciCacheBackupClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220315")
public interface OciCacheBackup
extends AutoCloseable
```
Use the OCI Cache API to create and manage clusters.
A cluster is a memory-based storage solution. For more information, see OCI Cache. 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
`ChangeOciCacheBackupCompartmentResponse`	`changeOciCacheBackupCompartment(ChangeOciCacheBackupCompartmentRequest request)`	Moves an OCI Cache Backup resource from one compartment identifier to another.
`CreateOciCacheBackupResponse`	`createOciCacheBackup(CreateOciCacheBackupRequest request)`	Creates a new OCI Cache Backup.
`DeleteOciCacheBackupResponse`	`deleteOciCacheBackup(DeleteOciCacheBackupRequest request)`	Deletes an OCI Cache Backup resource by identifier
`ExportOciCacheBackupToObjectStorageResponse`	`exportOciCacheBackupToObjectStorage(ExportOciCacheBackupToObjectStorageRequest request)`	Initiates an asynchronous export of the backup\u2019s RDB file(s) to the specified Object Storage bucket.
`String`	`getEndpoint()`	Gets the set endpoint for REST call (ex, https://www.example.com)
`GetOciCacheBackupResponse`	`getOciCacheBackup(GetOciCacheBackupRequest request)`	Gets an OCI Cache Backup by identifier
`OciCacheBackupPaginators`	`getPaginators()`	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`OciCacheBackupWaiters`	`getWaiters()`	Gets the pre-configured waiters available for resources for this service.
`ListOciCacheBackupsResponse`	`listOciCacheBackups(ListOciCacheBackupsRequest request)`	Returns a list of OCI Cache 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’).
`UpdateOciCacheBackupResponse`	`updateOciCacheBackup(UpdateOciCacheBackupRequest request)`	Updates the OCI Cache Backup
`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 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
  - changeOciCacheBackupCompartment
```
ChangeOciCacheBackupCompartmentResponse changeOciCacheBackupCompartment(ChangeOciCacheBackupCompartmentRequest request)
```
    Moves an OCI Cache Backup resource from one compartment identifier 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_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.86.0/redis/ChangeOciCacheBackupCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeOciCacheBackupCompartment API.
  - createOciCacheBackup
```
CreateOciCacheBackupResponse createOciCacheBackup(CreateOciCacheBackupRequest request)
```
    Creates a new OCI Cache 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/3.86.0/redis/CreateOciCacheBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateOciCacheBackup API.
  - deleteOciCacheBackup
```
DeleteOciCacheBackupResponse deleteOciCacheBackup(DeleteOciCacheBackupRequest request)
```
    Deletes an OCI Cache Backup resource 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_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.86.0/redis/DeleteOciCacheBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteOciCacheBackup API.
  - exportOciCacheBackupToObjectStorage
```
ExportOciCacheBackupToObjectStorageResponse exportOciCacheBackupToObjectStorage(ExportOciCacheBackupToObjectStorageRequest request)
```
    Initiates an asynchronous export of the backup\u2019s RDB file(s) to the specified Object Storage bucket.
    The service generates the object names. For sharded backups, one object is written per shard under the optional prefix.
    
    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/3.86.0/redis/ExportOciCacheBackupToObjectStorageExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ExportOciCacheBackupToObjectStorage API.
  - getOciCacheBackup
```
GetOciCacheBackupResponse getOciCacheBackup(GetOciCacheBackupRequest request)
```
    Gets an OCI Cache 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_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.86.0/redis/GetOciCacheBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetOciCacheBackup API.
  - listOciCacheBackups
```
ListOciCacheBackupsResponse listOciCacheBackups(ListOciCacheBackupsRequest request)
```
    Returns a list of OCI Cache 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/3.86.0/redis/ListOciCacheBackupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOciCacheBackups API.
  - updateOciCacheBackup
```
UpdateOciCacheBackupResponse updateOciCacheBackup(UpdateOciCacheBackupRequest request)
```
    Updates the OCI Cache 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/3.86.0/redis/UpdateOciCacheBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateOciCacheBackup API.
  - getWaiters
```
OciCacheBackupWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
OciCacheBackupPaginators 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 OciCacheBackup

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

changeOciCacheBackupCompartment

createOciCacheBackup

deleteOciCacheBackup

exportOciCacheBackupToObjectStorage

getOciCacheBackup

listOciCacheBackups

updateOciCacheBackup

getWaiters

getPaginators