com.oracle.bmc.mysql

Class MysqlaasClient

java.lang.Object

com.oracle.bmc.mysql.MysqlaasClient

All Implemented Interfaces:

Mysqlaas, AutoCloseable

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	MysqlaasClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	MysqlaasClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	MysqlaasClient(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.
	MysqlaasClient(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.
	MysqlaasClient(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	MysqlaasClient(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.
	MysqlaasClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	MysqlaasClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	MysqlaasClient(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 MysqlaasClient.Builder	builder() Create a builder for this client.
void	close()
CreateConfigurationResponse	createConfiguration(CreateConfigurationRequest request) Creates a new Configuration.
DeleteConfigurationResponse	deleteConfiguration(DeleteConfigurationRequest request) Deletes a Configuration.
GetConfigurationResponse	getConfiguration(GetConfigurationRequest request) Get the full details of the specified Configuration, including the list of MySQL Variables and their values.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
MysqlaasPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
MysqlaasWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListConfigurationsResponse	listConfigurations(ListConfigurationsRequest request) Lists the Configurations available when creating a DB System.
ListShapesResponse	listShapes(ListShapesRequest request) Gets a list of the shapes you can use to create a new MySQL DB System.
ListVersionsResponse	listVersions(ListVersionsRequest request) Get a list of supported and available MySQL database major versions.
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’).
UpdateConfigurationResponse	updateConfiguration(UpdateConfigurationRequest request) Updates the Configuration details.

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 Mysqlaas.

Constructor Detail

MysqlaasClient

public MysqlaasClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

MysqlaasClient

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

MysqlaasClient

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

MysqlaasClient

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

MysqlaasClient

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

MysqlaasClient

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

MysqlaasClient

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

MysqlaasClient

public MysqlaasClient(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

MysqlaasClient

protected MysqlaasClient(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 MysqlaasClient.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 MysqlaasClient.Builder builder()

Create a builder for this client.

Returns:

builder

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: Mysqlaas

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

Specified by:

setEndpoint in interface Mysqlaas

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: Mysqlaas

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

Specified by:

getEndpoint in interface Mysqlaas

setRegion

public void setRegion(Region region)

Description copied from interface: Mysqlaas

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 Mysqlaas

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Mysqlaas

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 Mysqlaas

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

createConfiguration

public CreateConfigurationResponse createConfiguration(CreateConfigurationRequest request)

Description copied from interface: Mysqlaas

Creates a new Configuration.

Specified by:

createConfiguration in interface Mysqlaas

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteConfiguration

public DeleteConfigurationResponse deleteConfiguration(DeleteConfigurationRequest request)

Description copied from interface: Mysqlaas

Deletes a Configuration. The Configuration must not be in use by any DB Systems.

Specified by:

deleteConfiguration in interface Mysqlaas

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getConfiguration

public GetConfigurationResponse getConfiguration(GetConfigurationRequest request)

Description copied from interface: Mysqlaas

Get the full details of the specified Configuration, including the list of MySQL Variables and their values.

Specified by:

getConfiguration in interface Mysqlaas

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listConfigurations

public ListConfigurationsResponse listConfigurations(ListConfigurationsRequest request)

Description copied from interface: Mysqlaas

Lists the Configurations available when creating a DB System.

This may include DEFAULT configurations per Shape and CUSTOM configurations.

The default sort order is a multi-part sort by: - shapeName, ascending - DEFAULT-before-CUSTOM - displayName ascending

Specified by:

listConfigurations in interface Mysqlaas

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listShapes

public ListShapesResponse listShapes(ListShapesRequest request)

Description copied from interface: Mysqlaas

Gets a list of the shapes you can use to create a new MySQL DB System. The shape determines the resources allocated to the DB System: CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes.

Specified by:

listShapes in interface Mysqlaas

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listVersions

public ListVersionsResponse listVersions(ListVersionsRequest request)

Description copied from interface: Mysqlaas

Get a list of supported and available MySQL database major versions.

The list is sorted by version family.

Specified by:

listVersions in interface Mysqlaas

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateConfiguration

public UpdateConfigurationResponse updateConfiguration(UpdateConfigurationRequest request)

Description copied from interface: Mysqlaas

Updates the Configuration details.

Specified by:

updateConfiguration in interface Mysqlaas

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public MysqlaasWaiters getWaiters()

Description copied from interface: Mysqlaas

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

Specified by:

getWaiters in interface Mysqlaas

Returns:

The service waiters.

getPaginators

public MysqlaasPaginators getPaginators()

Description copied from interface: Mysqlaas

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 Mysqlaas

Returns:

The service paginators.