@Generated(value="OracleSDKGenerator", comments="API Version: 20201101") public class DbManagementClient extends Object implements DbManagement
Modifier and Type | Class and Description |
---|---|
static class |
DbManagementClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for DbManagement.
|
Modifier | Constructor and Description |
---|---|
|
DbManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
DbManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
DbManagementClient(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.
|
|
DbManagementClient(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.
|
|
DbManagementClient(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 |
DbManagementClient(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.
|
|
DbManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
DbManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
DbManagementClient(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 |
---|---|
AddManagedDatabaseToManagedDatabaseGroupResponse |
addManagedDatabaseToManagedDatabaseGroup(AddManagedDatabaseToManagedDatabaseGroupRequest request)
Adds a Managed Database to a specific Managed Database Group.
|
static DbManagementClient.Builder |
builder()
Create a builder for this client.
|
ChangeJobCompartmentResponse |
changeJobCompartment(ChangeJobCompartmentRequest request)
Moves a job.
|
ChangeManagedDatabaseGroupCompartmentResponse |
changeManagedDatabaseGroupCompartment(ChangeManagedDatabaseGroupCompartmentRequest request)
Moves a Managed Database Group to a different compartment.
|
void |
close() |
CreateJobResponse |
createJob(CreateJobRequest request)
Creates a job to be executed on a Managed Database or Managed Database Group.
|
CreateManagedDatabaseGroupResponse |
createManagedDatabaseGroup(CreateManagedDatabaseGroupRequest request)
Creates a Managed Database Group.
|
DeleteJobResponse |
deleteJob(DeleteJobRequest request)
Deletes the job specified by jobId.
|
DeleteManagedDatabaseGroupResponse |
deleteManagedDatabaseGroup(DeleteManagedDatabaseGroupRequest request)
Deletes the Managed Database Group specified by managedDatabaseGroupId.
|
GetDatabaseFleetHealthMetricsResponse |
getDatabaseFleetHealthMetrics(GetDatabaseFleetHealthMetricsRequest request)
Gets the health metrics for a fleet of databases in a compartment or in a Managed Database Group.
|
GetDatabaseHomeMetricsResponse |
getDatabaseHomeMetrics(GetDatabaseHomeMetricsRequest request)
Gets a summary of the activity and resource usage metrics like DB Time, CPU, User I/O, Wait, Storage, and Memory for a Managed Database.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
GetJobResponse |
getJob(GetJobRequest request)
Gets the details for the job specified by jobId.
|
GetJobExecutionResponse |
getJobExecution(GetJobExecutionRequest request)
Gets the details for the job execution specified by jobExecutionId.
|
GetJobRunResponse |
getJobRun(GetJobRunRequest request)
Gets the details for the job run specified by jobRunId.
|
GetManagedDatabaseResponse |
getManagedDatabase(GetManagedDatabaseRequest request)
Gets the details for the Managed Database specified by managedDatabaseId.
|
GetManagedDatabaseGroupResponse |
getManagedDatabaseGroup(GetManagedDatabaseGroupRequest request)
Gets the details for the Managed Database Group specified by managedDatabaseGroupId.
|
DbManagementPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data.
|
DbManagementWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
ListJobExecutionsResponse |
listJobExecutions(ListJobExecutionsRequest request)
Gets the job execution for a specific ID or the list of job executions for a job, Managed Database or Managed Database Group
in a specific compartment.
|
ListJobRunsResponse |
listJobRuns(ListJobRunsRequest request)
Gets the job run for a specific ID or the list of job runs for a job, Managed Database or Managed Database Group
in a specific compartment.
|
ListJobsResponse |
listJobs(ListJobsRequest request)
Gets the job for a specific ID or the list of jobs for a Managed Database or Managed Database Group
in a specific compartment.
|
ListManagedDatabaseGroupsResponse |
listManagedDatabaseGroups(ListManagedDatabaseGroupsRequest request)
Gets the Managed Database Group for a specific ID or the list of Managed Database Groups in
a specific compartment.
|
ListManagedDatabasesResponse |
listManagedDatabases(ListManagedDatabasesRequest request)
Gets the Managed Database for a specific ID or the list of Managed Databases in a specific compartment.
|
RemoveManagedDatabaseFromManagedDatabaseGroupResponse |
removeManagedDatabaseFromManagedDatabaseGroup(RemoveManagedDatabaseFromManagedDatabaseGroupRequest request)
Removes a Managed Database from a Managed Database Group.
|
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’).
|
UpdateManagedDatabaseGroupResponse |
updateManagedDatabaseGroup(UpdateManagedDatabaseGroupRequest request)
Updates the Managed Database Group specified by managedDatabaseGroupId.
|
public static final Service SERVICE
Service instance for DbManagement.
public DbManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public DbManagementClient(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 DbManagementClient(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 DbManagementClient(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 DbManagementClient(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 DbManagementClient(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 DbManagementClient(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 DbManagementClient(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 DbManagementClient(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 DbManagementClient.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 DbManagementClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
DbManagement
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface DbManagement
endpoint
- The endpoint of the service.public String getEndpoint()
DbManagement
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface DbManagement
public void setRegion(Region region)
DbManagement
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.
setRegion
in interface DbManagement
region
- The region of the service.public void setRegion(String regionId)
DbManagement
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
.
setRegion
in interface DbManagement
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public AddManagedDatabaseToManagedDatabaseGroupResponse addManagedDatabaseToManagedDatabaseGroup(AddManagedDatabaseToManagedDatabaseGroupRequest request)
DbManagement
Adds a Managed Database to a specific Managed Database Group. After the database is added, it will be included in the management activities performed on the Managed Database Group.
addManagedDatabaseToManagedDatabaseGroup
in interface DbManagement
request
- The request object containing the details to sendpublic ChangeJobCompartmentResponse changeJobCompartment(ChangeJobCompartmentRequest request)
DbManagement
Moves a job.
changeJobCompartment
in interface DbManagement
request
- The request object containing the details to sendpublic ChangeManagedDatabaseGroupCompartmentResponse changeManagedDatabaseGroupCompartment(ChangeManagedDatabaseGroupCompartmentRequest request)
DbManagement
Moves a Managed Database Group to a different compartment. The destination compartment must not have a Managed Database Group with the same name.
changeManagedDatabaseGroupCompartment
in interface DbManagement
request
- The request object containing the details to sendpublic CreateJobResponse createJob(CreateJobRequest request)
DbManagement
Creates a job to be executed on a Managed Database or Managed Database Group. Only one of the parameters, managedDatabaseId or managedDatabaseGroupId should be provided as input in CreateJobDetails resource in request body.
createJob
in interface DbManagement
request
- The request object containing the details to sendpublic CreateManagedDatabaseGroupResponse createManagedDatabaseGroup(CreateManagedDatabaseGroupRequest request)
DbManagement
Creates a Managed Database Group. The group does not contain any Managed Databases when it is created, and they must be added later.
createManagedDatabaseGroup
in interface DbManagement
request
- The request object containing the details to sendpublic DeleteJobResponse deleteJob(DeleteJobRequest request)
DbManagement
Deletes the job specified by jobId.
deleteJob
in interface DbManagement
request
- The request object containing the details to sendpublic DeleteManagedDatabaseGroupResponse deleteManagedDatabaseGroup(DeleteManagedDatabaseGroupRequest request)
DbManagement
Deletes the Managed Database Group specified by managedDatabaseGroupId. If the group contains Managed Databases, then it cannot be deleted.
deleteManagedDatabaseGroup
in interface DbManagement
request
- The request object containing the details to sendpublic GetDatabaseFleetHealthMetricsResponse getDatabaseFleetHealthMetrics(GetDatabaseFleetHealthMetricsRequest request)
DbManagement
Gets the health metrics for a fleet of databases in a compartment or in a Managed Database Group. Either the CompartmentId or the ManagedDatabaseGroupId query parameters must be provided to retrieve the health metrics.
getDatabaseFleetHealthMetrics
in interface DbManagement
request
- The request object containing the details to sendpublic GetDatabaseHomeMetricsResponse getDatabaseHomeMetrics(GetDatabaseHomeMetricsRequest request)
DbManagement
Gets a summary of the activity and resource usage metrics like DB Time, CPU, User I/O, Wait, Storage, and Memory for a Managed Database.
getDatabaseHomeMetrics
in interface DbManagement
request
- The request object containing the details to sendpublic GetJobResponse getJob(GetJobRequest request)
DbManagement
Gets the details for the job specified by jobId.
getJob
in interface DbManagement
request
- The request object containing the details to sendpublic GetJobExecutionResponse getJobExecution(GetJobExecutionRequest request)
DbManagement
Gets the details for the job execution specified by jobExecutionId.
getJobExecution
in interface DbManagement
request
- The request object containing the details to sendpublic GetJobRunResponse getJobRun(GetJobRunRequest request)
DbManagement
Gets the details for the job run specified by jobRunId.
getJobRun
in interface DbManagement
request
- The request object containing the details to sendpublic GetManagedDatabaseResponse getManagedDatabase(GetManagedDatabaseRequest request)
DbManagement
Gets the details for the Managed Database specified by managedDatabaseId.
getManagedDatabase
in interface DbManagement
request
- The request object containing the details to sendpublic GetManagedDatabaseGroupResponse getManagedDatabaseGroup(GetManagedDatabaseGroupRequest request)
DbManagement
Gets the details for the Managed Database Group specified by managedDatabaseGroupId.
getManagedDatabaseGroup
in interface DbManagement
request
- The request object containing the details to sendpublic ListJobExecutionsResponse listJobExecutions(ListJobExecutionsRequest request)
DbManagement
Gets the job execution for a specific ID or the list of job executions for a job, Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, jobId, managedDatabaseId or managedDatabaseGroupId should be provided. If none of these parameters is provided, all the job executions in the compartment are listed. Job executions can also be filtered based on the name and status parameters.
listJobExecutions
in interface DbManagement
request
- The request object containing the details to sendpublic ListJobRunsResponse listJobRuns(ListJobRunsRequest request)
DbManagement
Gets the job run for a specific ID or the list of job runs for a job, Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, jobId, managedDatabaseId, or managedDatabaseGroupId should be provided. If none of these parameters is provided, all the job runs in the compartment are listed. Job runs can also be filtered based on name and runStatus parameters.
listJobRuns
in interface DbManagement
request
- The request object containing the details to sendpublic ListJobsResponse listJobs(ListJobsRequest request)
DbManagement
Gets the job for a specific ID or the list of jobs for a Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, managedDatabaseId or managedDatabaseGroupId, should be provided. If none of these parameters is provided, all the jobs in the compartment are listed. Jobs can also be filtered based on the name and lifecycleState parameters.
listJobs
in interface DbManagement
request
- The request object containing the details to sendpublic ListManagedDatabaseGroupsResponse listManagedDatabaseGroups(ListManagedDatabaseGroupsRequest request)
DbManagement
Gets the Managed Database Group for a specific ID or the list of Managed Database Groups in a specific compartment. Managed Database Groups can also be filtered based on the name parameter. Only one of the parameters, ID or name should be provided. If none of these parameters is provided, all the Managed Database Groups in the compartment are listed.
listManagedDatabaseGroups
in interface DbManagement
request
- The request object containing the details to sendpublic ListManagedDatabasesResponse listManagedDatabases(ListManagedDatabasesRequest request)
DbManagement
Gets the Managed Database for a specific ID or the list of Managed Databases in a specific compartment. Managed Databases can also be filtered based on the name parameter. Only one of the parameters, ID or name should be provided. If none of these parameters is provided, all the Managed Databases in the compartment are listed.
listManagedDatabases
in interface DbManagement
request
- The request object containing the details to sendpublic RemoveManagedDatabaseFromManagedDatabaseGroupResponse removeManagedDatabaseFromManagedDatabaseGroup(RemoveManagedDatabaseFromManagedDatabaseGroupRequest request)
DbManagement
Removes a Managed Database from a Managed Database Group. Any management activities that are currently running on this database will continue to run to completion. However, any activities scheduled to run in the future will not be performed on this database.
removeManagedDatabaseFromManagedDatabaseGroup
in interface DbManagement
request
- The request object containing the details to sendpublic UpdateManagedDatabaseGroupResponse updateManagedDatabaseGroup(UpdateManagedDatabaseGroupRequest request)
DbManagement
Updates the Managed Database Group specified by managedDatabaseGroupId.
updateManagedDatabaseGroup
in interface DbManagement
request
- The request object containing the details to sendpublic DbManagementWaiters getWaiters()
DbManagement
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface DbManagement
public DbManagementPaginators getPaginators()
DbManagement
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 DbManagement
Copyright © 2016–2021. All rights reserved.