DbBackupsAsyncClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.mysql.DbBackupsAsyncClient

All Implemented Interfaces:

DbBackupsAsync, AutoCloseable
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190415")
public class DbBackupsAsyncClient
extends Object
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 and Description

static class DbBackupsAsyncClient.Builder
Builder class for this client.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DbBackupsAsyncClient.Builder` Builder class for this client.

Field Summary

Fields
Modifier and Type Field and Description

static Service SERVICE
Service instance for DbBackups.

Fields
Modifier and Type	Field and Description
`static Service`	`SERVICE` Service instance for DbBackups.

Constructor Summary

Constructors
Constructor and Description
`DbBackupsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Creates a new service instance using the given authentication provider and client configuration.
`DbBackupsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
`DbBackupsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
`DbBackupsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
`DbBackupsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)` Creates a new service instance using the given authentication provider and client configuration.
`DbBackupsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
`DbBackupsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
`DbBackupsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Creates a new service instance using the given authentication provider and client configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DbBackupsAsyncClient.Builder`	`builder()` Create a builder for this client.
`void`	`close()`
`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`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`Future<ListBackupsResponse>`	`listBackups(ListBackupsRequest request, AsyncHandler<ListBackupsRequest,ListBackupsResponse> handler)` 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’).
`Future<UpdateBackupResponse>`	`updateBackup(UpdateBackupRequest request, AsyncHandler<UpdateBackupRequest,UpdateBackupResponse> handler)` Update the metadata of a Backup.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for DbBackups.
- Constructor Detail
  - DbBackupsAsyncClient
```
public DbBackupsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - DbBackupsAsyncClient
```
public DbBackupsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration)
```
    Creates a new service instance using the given authentication provider and client configuration.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
  - DbBackupsAsyncClient
```
public DbBackupsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
  - DbBackupsAsyncClient
```
public DbBackupsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
  - DbBackupsAsyncClient
```
public DbBackupsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            List<ClientConfigurator> additionalClientConfigurators)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
  - DbBackupsAsyncClient
```
public DbBackupsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            List<ClientConfigurator> additionalClientConfigurators,
                            String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - DbBackupsAsyncClient
```
public DbBackupsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                            List<ClientConfigurator> additionalClientConfigurators,
                            String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - DbBackupsAsyncClient
```
public DbBackupsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                            List<ClientConfigurator> additionalClientConfigurators,
                            String endpoint,
                            com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    restClientFactoryBuilder - the builder for the RestClientFactory
- Method Detail
  - builder
```
public static DbBackupsAsyncClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: DbBackupsAsync
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface DbBackupsAsync
    
    Parameters:
    
    endpoint - The endpoint of the serice.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: DbBackupsAsync
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface DbBackupsAsync
  - 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.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - 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.

Class DbBackupsAsyncClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

DbBackupsAsyncClient

DbBackupsAsyncClient

DbBackupsAsyncClient

DbBackupsAsyncClient

DbBackupsAsyncClient

DbBackupsAsyncClient

DbBackupsAsyncClient

DbBackupsAsyncClient

Method Detail

builder

setEndpoint

getEndpoint

setRegion

setRegion

close

createBackup

deleteBackup

getBackup

listBackups

updateBackup