java.lang.Object
- com.oracle.bmc.http.internal.BaseAsyncClient
- - com.oracle.bmc.mysql.DbBackupsAsyncClient

All Implemented Interfaces:

DbBackupsAsync, AutoCloseable
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190415")
public class DbBackupsAsyncClient
extends BaseAsyncClient
implements DbBackupsAsync
```
Async client implementation for DbBackups service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DbBackupsAsyncClient.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 DbBackups.

Constructor Summary

Constructors
Constructor	Description
`DbBackupsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)`	Deprecated. Use the `builder` instead.
`DbBackupsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)`	Deprecated. Use the `builder` instead.
`DbBackupsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`DbBackupsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`DbBackupsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)`	Deprecated. Use the `builder` instead.
`DbBackupsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)`	Deprecated. Use the `builder` instead.
`DbBackupsAsyncClient(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
`static DbBackupsAsyncClient.Builder`	`builder()`	Create a builder for this client.
`Future<CancelBackupDeletionResponse>`	`cancelBackupDeletion(CancelBackupDeletionRequest request, AsyncHandler<CancelBackupDeletionRequest,CancelBackupDeletionResponse> handler)`	Cancels the scheduled deletion of a backup and moves it to ACTIVE state.
`Future<ChangeBackupCompartmentResponse>`	`changeBackupCompartment(ChangeBackupCompartmentRequest request, AsyncHandler<ChangeBackupCompartmentRequest,ChangeBackupCompartmentResponse> handler)`	Moves a DB System Backup into a different compartment.
`protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>`	`clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)`
`void`	`close()`
`Future<CopyBackupResponse>`	`copyBackup(CopyBackupRequest request, AsyncHandler<CopyBackupRequest,CopyBackupResponse> handler)`	Creates a copy of a DB system backup available in the specified source region.
`Future<CreateBackupResponse>`	`createBackup(CreateBackupRequest request, AsyncHandler<CreateBackupRequest,CreateBackupResponse> handler)`	Create a backup of a DB System.
`Future<DeleteBackupResponse>`	`deleteBackup(DeleteBackupRequest request, AsyncHandler<DeleteBackupRequest,DeleteBackupResponse> handler)`	Delete a Backup.
`Future<GetBackupResponse>`	`getBackup(GetBackupRequest request, AsyncHandler<GetBackupRequest,GetBackupResponse> handler)`	Get information about the specified Backup
`String`	`getClientCommonLibraryVersion()`
`protected ClientConfigurator`	`getDefaultConfigurator()`
`String`	`getEndpoint()`
`Optional<String>`	`getMinimumClientCommonLibraryVersionFromClient()`
`Future<ListBackupsResponse>`	`listBackups(ListBackupsRequest request, AsyncHandler<ListBackupsRequest,ListBackupsResponse> handler)`	Get a list of DB System backups.
`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`.
`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’).
`Future<UpdateBackupResponse>`	`updateBackup(UpdateBackupRequest request, AsyncHandler<UpdateBackupRequest,UpdateBackupResponse> handler)`	Update the metadata of a Backup.
`void`	`updateBaseEndpoint(String endpoint)`	This method should be used for parameterized endpoint templates only.
`void`	`useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)`	This method should be used to enable or disable the use of realm-specific endpoint template.

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.mysql.DbBackupsAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for DbBackups.
  - 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
  - DbBackupsAsyncClient
```
@Deprecated
public DbBackupsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see DbBackupsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - DbBackupsAsyncClient
```
@Deprecated
public DbBackupsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see DbBackupsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - DbBackupsAsyncClient
```
@Deprecated
public DbBackupsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see DbBackupsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - DbBackupsAsyncClient
```
@Deprecated
public DbBackupsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see DbBackupsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
  - DbBackupsAsyncClient
```
@Deprecated
public DbBackupsAsyncClient(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 DbBackupsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
  - DbBackupsAsyncClient
```
@Deprecated
public DbBackupsAsyncClient(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 DbBackupsAsyncClient.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)
  - DbBackupsAsyncClient
```
@Deprecated
public DbBackupsAsyncClient(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 DbBackupsAsyncClient.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
- Method Detail
  - builder
```
public static DbBackupsAsyncClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: DbBackupsAsync
    
    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 DbBackupsAsync
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: DbBackupsAsync
    
    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 DbBackupsAsync
    
    Parameters:
    
    regionId - The public region ID.
  - cancelBackupDeletion
```
public Future<CancelBackupDeletionResponse> cancelBackupDeletion(CancelBackupDeletionRequest request,
                                                                 AsyncHandler<CancelBackupDeletionRequest,CancelBackupDeletionResponse> handler)
```
    Description copied from interface: DbBackupsAsync
    
    Cancels the scheduled deletion of a backup and moves it to ACTIVE state.
    
    Specified by:
    
    cancelBackupDeletion in interface DbBackupsAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - changeBackupCompartment
```
public Future<ChangeBackupCompartmentResponse> changeBackupCompartment(ChangeBackupCompartmentRequest request,
                                                                       AsyncHandler<ChangeBackupCompartmentRequest,ChangeBackupCompartmentResponse> handler)
```
    Description copied from interface: DbBackupsAsync
    
    Moves a DB System Backup into a different compartment.
    When provided, If-Match is checked against ETag values of the Backup.
    
    Specified by:
    
    changeBackupCompartment in interface DbBackupsAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - copyBackup
```
public Future<CopyBackupResponse> copyBackup(CopyBackupRequest request,
                                             AsyncHandler<CopyBackupRequest,CopyBackupResponse> handler)
```
    Description copied from interface: DbBackupsAsync
    
    Creates a copy of a DB system backup available in the specified source region.
    
    Specified by:
    
    copyBackup in interface DbBackupsAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - createBackup
```
public Future<CreateBackupResponse> createBackup(CreateBackupRequest request,
                                                 AsyncHandler<CreateBackupRequest,CreateBackupResponse> handler)
```
    Description copied from interface: DbBackupsAsync
    
    Create a backup of a DB System.
    
    Specified by:
    
    createBackup in interface DbBackupsAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - deleteBackup
```
public Future<DeleteBackupResponse> deleteBackup(DeleteBackupRequest request,
                                                 AsyncHandler<DeleteBackupRequest,DeleteBackupResponse> handler)
```
    Description copied from interface: DbBackupsAsync
    
    Delete a Backup.
    
    Specified by:
    
    deleteBackup in interface DbBackupsAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getBackup
```
public Future<GetBackupResponse> getBackup(GetBackupRequest request,
                                           AsyncHandler<GetBackupRequest,GetBackupResponse> handler)
```
    Description copied from interface: DbBackupsAsync
    
    Get information about the specified Backup
    
    Specified by:
    
    getBackup in interface DbBackupsAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listBackups
```
public Future<ListBackupsResponse> listBackups(ListBackupsRequest request,
                                               AsyncHandler<ListBackupsRequest,ListBackupsResponse> handler)
```
    Description copied from interface: DbBackupsAsync
    
    Get a list of DB System backups.
    
    Specified by:
    
    listBackups in interface DbBackupsAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - updateBackup
```
public Future<UpdateBackupResponse> updateBackup(UpdateBackupRequest request,
                                                 AsyncHandler<UpdateBackupRequest,UpdateBackupResponse> handler)
```
    Description copied from interface: DbBackupsAsync
    
    Update the metadata of a Backup.
    Metadata such as the displayName or description
    
    Specified by:
    
    updateBackup in interface DbBackupsAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - 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()
```
  - clientCall
```
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                                                   Supplier<RESP_BUILDER> responseBuilder)
```

Class DbBackupsAsyncClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.AutoCloseable

Methods inherited from interface com.oracle.bmc.mysql.DbBackupsAsync

Field Detail

SERVICE

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

DbBackupsAsyncClient

DbBackupsAsyncClient

DbBackupsAsyncClient

DbBackupsAsyncClient

DbBackupsAsyncClient

DbBackupsAsyncClient

DbBackupsAsyncClient

Method Detail

builder

setRegion

setRegion

cancelBackupDeletion

changeBackupCompartment

copyBackup

createBackup

deleteBackup

getBackup

listBackups

updateBackup

getDefaultConfigurator

useRealmSpecificEndpointTemplate

populateServiceParametersInEndpoint

updateBaseEndpoint

setEndpoint

getEndpoint

refreshClient

close

getClientCommonLibraryVersion

getMinimumClientCommonLibraryVersionFromClient

clientCall