DbSystemClient (Oracle Cloud Infrastructure Java SDK

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

All Implemented Interfaces:: DbSystem, AutoCloseable

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DbSystemClient.Builder
Builder class for this client.

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

Field Summary

Fields
Modifier and Type Field and Description

static Service SERVICE
Service instance for DbSystem.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`DbSystemClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Creates a new service instance using the given authentication provider and client configuration.
	`DbSystemClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
	`DbSystemClient(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.
	`DbSystemClient(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.
	`DbSystemClient(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`	`DbSystemClient(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.
	`DbSystemClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
	`DbSystemClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
	`DbSystemClient(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 DbSystemClient.Builder`	`builder()` Create a builder for this client.
`void`	`close()`
`CreateDbSystemResponse`	`createDbSystem(CreateDbSystemRequest request)` Creates and launches a DB System.
`DeleteDbSystemResponse`	`deleteDbSystem(DeleteDbSystemRequest request)` Delete a DB System, including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
`GetDbSystemResponse`	`getDbSystem(GetDbSystemRequest request)` Get information about the specified DB System.
`DbSystemPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`DbSystemWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`ListDbSystemsResponse`	`listDbSystems(ListDbSystemsRequest request)` Get a list of DB Systems in the specified compartment.
`RestartDbSystemResponse`	`restartDbSystem(RestartDbSystemRequest request)` Restarts the specified DB System.
`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’).
`StartDbSystemResponse`	`startDbSystem(StartDbSystemRequest request)` Start the specified DB System.
`StopDbSystemResponse`	`stopDbSystem(StopDbSystemRequest request)` Stops the specified DB System.
`UpdateDbSystemResponse`	`updateDbSystem(UpdateDbSystemRequest request)` Update the configuration of a DB System.

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 DbSystem.
- Constructor Detail
  - DbSystemClient
```
public DbSystemClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - DbSystemClient
```
public DbSystemClient(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.
  - DbSystemClient
```
public DbSystemClient(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.
  - DbSystemClient
```
public DbSystemClient(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.
  - DbSystemClient
```
public DbSystemClient(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.
  - DbSystemClient
```
public DbSystemClient(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)
  - DbSystemClient
```
public DbSystemClient(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)
  - DbSystemClient
```
public DbSystemClient(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
  - DbSystemClient
```
protected DbSystemClient(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 DbSystemClient.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 DbSystemClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: DbSystem
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface DbSystem
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: DbSystem
    
    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 DbSystem
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: DbSystem
    
    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 DbSystem
    
    Parameters:
    
    regionId - The public region ID.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - createDbSystem
```
public CreateDbSystemResponse createDbSystem(CreateDbSystemRequest request)
```
    Description copied from interface: DbSystem
    
    Creates and launches a DB System.
    
    Specified by:
    
    createDbSystem in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteDbSystem
```
public DeleteDbSystemResponse deleteDbSystem(DeleteDbSystemRequest request)
```
    Description copied from interface: DbSystem
    
    Delete a DB System, including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
    
    Specified by:
    
    deleteDbSystem in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDbSystem
```
public GetDbSystemResponse getDbSystem(GetDbSystemRequest request)
```
    Description copied from interface: DbSystem
    
    Get information about the specified DB System.
    
    Specified by:
    
    getDbSystem in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listDbSystems
```
public ListDbSystemsResponse listDbSystems(ListDbSystemsRequest request)
```
    Description copied from interface: DbSystem
    
    Get a list of DB Systems in the specified compartment. The default sort order is by timeUpdated, descending.
    
    Specified by:
    
    listDbSystems in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - restartDbSystem
```
public RestartDbSystemResponse restartDbSystem(RestartDbSystemRequest request)
```
    Description copied from interface: DbSystem
    
    Restarts the specified DB System.
    
    Specified by:
    
    restartDbSystem in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - startDbSystem
```
public StartDbSystemResponse startDbSystem(StartDbSystemRequest request)
```
    Description copied from interface: DbSystem
    
    Start the specified DB System.
    
    Specified by:
    
    startDbSystem in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - stopDbSystem
```
public StopDbSystemResponse stopDbSystem(StopDbSystemRequest request)
```
    Description copied from interface: DbSystem
    
    Stops the specified DB System.
    A stopped DB System is not billed.
    
    Specified by:
    
    stopDbSystem in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateDbSystem
```
public UpdateDbSystemResponse updateDbSystem(UpdateDbSystemRequest request)
```
    Description copied from interface: DbSystem
    
    Update the configuration of a DB System.
    Updating different fields in the DB System will have different results on the uptime of the DB System. For example, changing the displayName of a DB System will take effect immediately, but changing the shape of a DB System is an asynchronous operation that involves provisioning new Compute resources, pausing the DB System and migrating storage before making the DB System available again.
    
    Specified by:
    
    updateDbSystem in interface DbSystem
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public DbSystemWaiters getWaiters()
```
    Description copied from interface: DbSystem
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface DbSystem
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public DbSystemPaginators getPaginators()
```
    Description copied from interface: DbSystem
    
    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 DbSystem
    
    Returns:
    
    The service paginators.

Class DbSystemClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

DbSystemClient

DbSystemClient

DbSystemClient

DbSystemClient

DbSystemClient

DbSystemClient

DbSystemClient

DbSystemClient

DbSystemClient

Method Detail

builder

setEndpoint

setRegion

setRegion

close

createDbSystem

deleteDbSystem

getDbSystem

listDbSystems

restartDbSystem

startDbSystem

stopDbSystem

updateDbSystem

getWaiters

getPaginators