@Generated(value="OracleSDKGenerator", comments="API Version: 20190415") public class DbSystemClient extends Object implements DbSystem
Modifier and Type | Class and Description |
---|---|
static class |
DbSystemClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for DbSystem.
|
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.
|
Modifier and Type | Method and Description |
---|---|
AddAnalyticsClusterResponse |
addAnalyticsCluster(AddAnalyticsClusterRequest request)
Adds an Analytics Cluster to the DB System.
|
static DbSystemClient.Builder |
builder()
Create a builder for this client.
|
void |
close() |
CreateDbSystemResponse |
createDbSystem(CreateDbSystemRequest request)
Creates and launches a DB System.
|
DeleteAnalyticsClusterResponse |
deleteAnalyticsCluster(DeleteAnalyticsClusterRequest request)
Deletes the Analytics Cluster including terminating, detaching, removing, finalizing and
otherwise deleting all related resources.
|
DeleteDbSystemResponse |
deleteDbSystem(DeleteDbSystemRequest request)
Delete a DB System, including terminating, detaching,
removing, finalizing and otherwise deleting all related resources.
|
GenerateAnalyticsClusterMemoryEstimateResponse |
generateAnalyticsClusterMemoryEstimate(GenerateAnalyticsClusterMemoryEstimateRequest request)
Sends a request to estimate the memory footprints of user tables when loaded to Analytics Cluster memory.
|
GetAnalyticsClusterResponse |
getAnalyticsCluster(GetAnalyticsClusterRequest request)
Gets information about the Analytics Cluster.
|
GetAnalyticsClusterMemoryEstimateResponse |
getAnalyticsClusterMemoryEstimate(GetAnalyticsClusterMemoryEstimateRequest request)
Gets the most recent Analytics Cluster memory estimate that can be used to determine a suitable
Analytics Cluster size.
|
GetDbSystemResponse |
getDbSystem(GetDbSystemRequest request)
Get information about the specified DB System.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
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.
|
RestartAnalyticsClusterResponse |
restartAnalyticsCluster(RestartAnalyticsClusterRequest request)
Restarts the Analytics Cluster.
|
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’).
|
StartAnalyticsClusterResponse |
startAnalyticsCluster(StartAnalyticsClusterRequest request)
Starts the Analytics Cluster.
|
StartDbSystemResponse |
startDbSystem(StartDbSystemRequest request)
Start the specified DB System.
|
StopAnalyticsClusterResponse |
stopAnalyticsCluster(StopAnalyticsClusterRequest request)
Stops the Analytics Cluster.
|
StopDbSystemResponse |
stopDbSystem(StopDbSystemRequest request)
Stops the specified DB System.
|
UpdateAnalyticsClusterResponse |
updateAnalyticsCluster(UpdateAnalyticsClusterRequest request)
Updates the Analytics Cluster.
|
UpdateDbSystemResponse |
updateDbSystem(UpdateDbSystemRequest request)
Update the configuration of a DB System.
|
public static final Service SERVICE
Service instance for DbSystem.
public DbSystemClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public DbSystemClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.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.
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.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.
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.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.
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.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.
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
)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.
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 signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)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.
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 signeradditionalClientConfigurators
- 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 ThreadPoolExecutorprotected 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.
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 signeradditionalClientConfigurators
- 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 ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static DbSystemClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
DbSystem
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface DbSystem
endpoint
- The endpoint of the service.public String getEndpoint()
DbSystem
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface DbSystem
public void setRegion(Region region)
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.
public void setRegion(String regionId)
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
.
public void close()
close
in interface AutoCloseable
public AddAnalyticsClusterResponse addAnalyticsCluster(AddAnalyticsClusterRequest request)
DbSystem
Adds an Analytics Cluster to the DB System.
addAnalyticsCluster
in interface DbSystem
request
- The request object containing the details to sendpublic CreateDbSystemResponse createDbSystem(CreateDbSystemRequest request)
DbSystem
Creates and launches a DB System.
createDbSystem
in interface DbSystem
request
- The request object containing the details to sendpublic DeleteAnalyticsClusterResponse deleteAnalyticsCluster(DeleteAnalyticsClusterRequest request)
DbSystem
Deletes the Analytics Cluster including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
deleteAnalyticsCluster
in interface DbSystem
request
- The request object containing the details to sendpublic DeleteDbSystemResponse deleteDbSystem(DeleteDbSystemRequest request)
DbSystem
Delete a DB System, including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
deleteDbSystem
in interface DbSystem
request
- The request object containing the details to sendpublic GenerateAnalyticsClusterMemoryEstimateResponse generateAnalyticsClusterMemoryEstimate(GenerateAnalyticsClusterMemoryEstimateRequest request)
DbSystem
Sends a request to estimate the memory footprints of user tables when loaded to Analytics Cluster memory.
generateAnalyticsClusterMemoryEstimate
in interface DbSystem
request
- The request object containing the details to sendpublic GetAnalyticsClusterResponse getAnalyticsCluster(GetAnalyticsClusterRequest request)
DbSystem
Gets information about the Analytics Cluster.
getAnalyticsCluster
in interface DbSystem
request
- The request object containing the details to sendpublic GetAnalyticsClusterMemoryEstimateResponse getAnalyticsClusterMemoryEstimate(GetAnalyticsClusterMemoryEstimateRequest request)
DbSystem
Gets the most recent Analytics Cluster memory estimate that can be used to determine a suitable Analytics Cluster size.
getAnalyticsClusterMemoryEstimate
in interface DbSystem
request
- The request object containing the details to sendpublic GetDbSystemResponse getDbSystem(GetDbSystemRequest request)
DbSystem
Get information about the specified DB System.
getDbSystem
in interface DbSystem
request
- The request object containing the details to sendpublic ListDbSystemsResponse listDbSystems(ListDbSystemsRequest request)
DbSystem
Get a list of DB Systems in the specified compartment. The default sort order is by timeUpdated, descending.
listDbSystems
in interface DbSystem
request
- The request object containing the details to sendpublic RestartAnalyticsClusterResponse restartAnalyticsCluster(RestartAnalyticsClusterRequest request)
DbSystem
Restarts the Analytics Cluster.
restartAnalyticsCluster
in interface DbSystem
request
- The request object containing the details to sendpublic RestartDbSystemResponse restartDbSystem(RestartDbSystemRequest request)
DbSystem
Restarts the specified DB System.
restartDbSystem
in interface DbSystem
request
- The request object containing the details to sendpublic StartAnalyticsClusterResponse startAnalyticsCluster(StartAnalyticsClusterRequest request)
DbSystem
Starts the Analytics Cluster.
startAnalyticsCluster
in interface DbSystem
request
- The request object containing the details to sendpublic StartDbSystemResponse startDbSystem(StartDbSystemRequest request)
DbSystem
Start the specified DB System.
startDbSystem
in interface DbSystem
request
- The request object containing the details to sendpublic StopAnalyticsClusterResponse stopAnalyticsCluster(StopAnalyticsClusterRequest request)
DbSystem
Stops the Analytics Cluster.
stopAnalyticsCluster
in interface DbSystem
request
- The request object containing the details to sendpublic StopDbSystemResponse stopDbSystem(StopDbSystemRequest request)
DbSystem
Stops the specified DB System.
A stopped DB System is not billed.
stopDbSystem
in interface DbSystem
request
- The request object containing the details to sendpublic UpdateAnalyticsClusterResponse updateAnalyticsCluster(UpdateAnalyticsClusterRequest request)
DbSystem
Updates the Analytics Cluster.
updateAnalyticsCluster
in interface DbSystem
request
- The request object containing the details to sendpublic UpdateDbSystemResponse updateDbSystem(UpdateDbSystemRequest request)
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.
updateDbSystem
in interface DbSystem
request
- The request object containing the details to sendpublic DbSystemWaiters getWaiters()
DbSystem
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface DbSystem
public DbSystemPaginators getPaginators()
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.
getPaginators
in interface DbSystem
Copyright © 2016–2021. All rights reserved.