com.oracle.bmc.mysql

Class DbBackupsClient

java.lang.Object

com.oracle.bmc.mysql.DbBackupsClient

All Implemented Interfaces:

DbBackups, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190415")
public class DbBackupsClient
extends Object
implements DbBackups

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DbBackupsClient.Builder Builder class for this client.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	DbBackupsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	DbBackupsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	DbBackupsClient(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.
	DbBackupsClient(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.
	DbBackupsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Creates a new service instance using the given authentication provider and client configuration.
protected	DbBackupsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder) Creates a new service instance using the given authentication provider and client configuration.
	DbBackupsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	DbBackupsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	DbBackupsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Creates a new service instance using the given authentication provider and client configuration.

Method Summary

Modifier and Type	Method and Description
static DbBackupsClient.Builder	builder() Create a builder for this client.
void	close()
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 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

DbBackupsClient

public DbBackupsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

DbBackupsClient

public DbBackupsClient(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.

DbBackupsClient

public DbBackupsClient(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.

DbBackupsClient

public DbBackupsClient(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.

DbBackupsClient

public DbBackupsClient(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.

DbBackupsClient

public DbBackupsClient(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)

DbBackupsClient

public DbBackupsClient(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)

DbBackupsClient

public DbBackupsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory,
                       Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                       List<ClientConfigurator> additionalClientConfigurators,
                       String endpoint,
                       ExecutorService executorService)

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)

executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor

DbBackupsClient

protected DbBackupsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory,
                          Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                          List<ClientConfigurator> additionalClientConfigurators,
                          String endpoint,
                          ExecutorService executorService,
                          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. Use the DbBackupsClient.Builder to get access to all these parameters.

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)

executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor

restClientFactoryBuilder - the builder for the RestClientFactory

Method Detail

builder

public static DbBackupsClient.Builder builder()

Create a builder for this client.

Returns:

builder

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: DbBackups

Sets the endpoint to call (ex, https://www.example.com).

Specified by:

setEndpoint in interface DbBackups

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: DbBackups

Gets the set endpoint for REST call (ex, https://www.example.com)

Specified by:

getEndpoint in interface DbBackups

setRegion

public void setRegion(Region region)

Description copied from interface: DbBackups

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 DbBackups

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DbBackups

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 DbBackups

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

createBackup

public CreateBackupResponse createBackup(CreateBackupRequest request)

Description copied from interface: DbBackups

Create a backup of a DB System.

Specified by:

createBackup in interface DbBackups

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteBackup

public DeleteBackupResponse deleteBackup(DeleteBackupRequest request)

Description copied from interface: DbBackups

Delete a Backup.

Specified by:

deleteBackup in interface DbBackups

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getBackup

public GetBackupResponse getBackup(GetBackupRequest request)

Description copied from interface: DbBackups

Get information about the specified Backup

Specified by:

getBackup in interface DbBackups

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listBackups

public ListBackupsResponse listBackups(ListBackupsRequest request)

Description copied from interface: DbBackups

Get a list of DB System backups.

Specified by:

listBackups in interface DbBackups

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateBackup

public UpdateBackupResponse updateBackup(UpdateBackupRequest request)

Description copied from interface: DbBackups

Update the metadata of a Backup. Metadata such as the displayName or description

Specified by:

updateBackup in interface DbBackups

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public DbBackupsWaiters getWaiters()

Description copied from interface: DbBackups

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface DbBackups

Returns:

The service waiters.

getPaginators

public DbBackupsPaginators getPaginators()

Description copied from interface: DbBackups

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.

Specified by:

getPaginators in interface DbBackups

Returns:

The service paginators.