com.oracle.bmc.databasemanagement

Interface DbManagementAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DbManagementAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20201101")
public interface DbManagementAsync
extends AutoCloseable

Use the Database Management API to perform tasks such as obtaining performance and resource usage metrics for a fleet of Managed Databases or a specific Managed Database, creating Managed Database Groups, and running a SQL job on a Managed Database or Managed Database Group.

Method Summary

Modifier and Type	Method and Description
Future<AddManagedDatabaseToManagedDatabaseGroupResponse>	addManagedDatabaseToManagedDatabaseGroup(AddManagedDatabaseToManagedDatabaseGroupRequest request, com.oracle.bmc.responses.AsyncHandler<AddManagedDatabaseToManagedDatabaseGroupRequest,AddManagedDatabaseToManagedDatabaseGroupResponse> handler) Adds a Managed Database to a specific Managed Database Group.
Future<ChangeJobCompartmentResponse>	changeJobCompartment(ChangeJobCompartmentRequest request, com.oracle.bmc.responses.AsyncHandler<ChangeJobCompartmentRequest,ChangeJobCompartmentResponse> handler) Moves a job.
Future<ChangeManagedDatabaseGroupCompartmentResponse>	changeManagedDatabaseGroupCompartment(ChangeManagedDatabaseGroupCompartmentRequest request, com.oracle.bmc.responses.AsyncHandler<ChangeManagedDatabaseGroupCompartmentRequest,ChangeManagedDatabaseGroupCompartmentResponse> handler) Moves a Managed Database Group to a different compartment.
Future<CreateJobResponse>	createJob(CreateJobRequest request, com.oracle.bmc.responses.AsyncHandler<CreateJobRequest,CreateJobResponse> handler) Creates a job to be executed on a Managed Database or Managed Database Group.
Future<CreateManagedDatabaseGroupResponse>	createManagedDatabaseGroup(CreateManagedDatabaseGroupRequest request, com.oracle.bmc.responses.AsyncHandler<CreateManagedDatabaseGroupRequest,CreateManagedDatabaseGroupResponse> handler) Creates a Managed Database Group.
Future<DeleteJobResponse>	deleteJob(DeleteJobRequest request, com.oracle.bmc.responses.AsyncHandler<DeleteJobRequest,DeleteJobResponse> handler) Deletes the job specified by jobId.
Future<DeleteManagedDatabaseGroupResponse>	deleteManagedDatabaseGroup(DeleteManagedDatabaseGroupRequest request, com.oracle.bmc.responses.AsyncHandler<DeleteManagedDatabaseGroupRequest,DeleteManagedDatabaseGroupResponse> handler) Deletes the Managed Database Group specified by managedDatabaseGroupId.
Future<GetDatabaseFleetHealthMetricsResponse>	getDatabaseFleetHealthMetrics(GetDatabaseFleetHealthMetricsRequest request, com.oracle.bmc.responses.AsyncHandler<GetDatabaseFleetHealthMetricsRequest,GetDatabaseFleetHealthMetricsResponse> handler) Gets the health metrics for a fleet of databases in a compartment or in a Managed Database Group.
Future<GetDatabaseHomeMetricsResponse>	getDatabaseHomeMetrics(GetDatabaseHomeMetricsRequest request, com.oracle.bmc.responses.AsyncHandler<GetDatabaseHomeMetricsRequest,GetDatabaseHomeMetricsResponse> handler) 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)
Future<GetJobResponse>	getJob(GetJobRequest request, com.oracle.bmc.responses.AsyncHandler<GetJobRequest,GetJobResponse> handler) Gets the details for the job specified by jobId.
Future<GetJobExecutionResponse>	getJobExecution(GetJobExecutionRequest request, com.oracle.bmc.responses.AsyncHandler<GetJobExecutionRequest,GetJobExecutionResponse> handler) Gets the details for the job execution specified by jobExecutionId.
Future<GetJobRunResponse>	getJobRun(GetJobRunRequest request, com.oracle.bmc.responses.AsyncHandler<GetJobRunRequest,GetJobRunResponse> handler) Gets the details for the job run specified by jobRunId.
Future<GetManagedDatabaseResponse>	getManagedDatabase(GetManagedDatabaseRequest request, com.oracle.bmc.responses.AsyncHandler<GetManagedDatabaseRequest,GetManagedDatabaseResponse> handler) Gets the details for the Managed Database specified by managedDatabaseId.
Future<GetManagedDatabaseGroupResponse>	getManagedDatabaseGroup(GetManagedDatabaseGroupRequest request, com.oracle.bmc.responses.AsyncHandler<GetManagedDatabaseGroupRequest,GetManagedDatabaseGroupResponse> handler) Gets the details for the Managed Database Group specified by managedDatabaseGroupId.
Future<ListJobExecutionsResponse>	listJobExecutions(ListJobExecutionsRequest request, com.oracle.bmc.responses.AsyncHandler<ListJobExecutionsRequest,ListJobExecutionsResponse> handler) 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.
Future<ListJobRunsResponse>	listJobRuns(ListJobRunsRequest request, com.oracle.bmc.responses.AsyncHandler<ListJobRunsRequest,ListJobRunsResponse> handler) 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.
Future<ListJobsResponse>	listJobs(ListJobsRequest request, com.oracle.bmc.responses.AsyncHandler<ListJobsRequest,ListJobsResponse> handler) Gets the job for a specific ID or the list of jobs for a Managed Database or Managed Database Group in a specific compartment.
Future<ListManagedDatabaseGroupsResponse>	listManagedDatabaseGroups(ListManagedDatabaseGroupsRequest request, com.oracle.bmc.responses.AsyncHandler<ListManagedDatabaseGroupsRequest,ListManagedDatabaseGroupsResponse> handler) Gets the Managed Database Group for a specific ID or the list of Managed Database Groups in a specific compartment.
Future<ListManagedDatabasesResponse>	listManagedDatabases(ListManagedDatabasesRequest request, com.oracle.bmc.responses.AsyncHandler<ListManagedDatabasesRequest,ListManagedDatabasesResponse> handler) Gets the Managed Database for a specific ID or the list of Managed Databases in a specific compartment.
Future<RemoveManagedDatabaseFromManagedDatabaseGroupResponse>	removeManagedDatabaseFromManagedDatabaseGroup(RemoveManagedDatabaseFromManagedDatabaseGroupRequest request, com.oracle.bmc.responses.AsyncHandler<RemoveManagedDatabaseFromManagedDatabaseGroupRequest,RemoveManagedDatabaseFromManagedDatabaseGroupResponse> handler) 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(com.oracle.bmc.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’).
Future<UpdateManagedDatabaseGroupResponse>	updateManagedDatabaseGroup(UpdateManagedDatabaseGroupRequest request, com.oracle.bmc.responses.AsyncHandler<UpdateManagedDatabaseGroupRequest,UpdateManagedDatabaseGroupResponse> handler) Updates the Managed Database Group specified by managedDatabaseGroupId.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

setEndpoint

void setEndpoint(String endpoint)

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

Parameters:

endpoint - The endpoint of the serice.

getEndpoint

String getEndpoint()

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

setRegion

void setRegion(com.oracle.bmc.Region region)

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.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

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.

Parameters:

regionId - The public region ID.

addManagedDatabaseToManagedDatabaseGroup

Future<AddManagedDatabaseToManagedDatabaseGroupResponse> addManagedDatabaseToManagedDatabaseGroup(AddManagedDatabaseToManagedDatabaseGroupRequest request,
                                                                                                  com.oracle.bmc.responses.AsyncHandler<AddManagedDatabaseToManagedDatabaseGroupRequest,AddManagedDatabaseToManagedDatabaseGroupResponse> handler)

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.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

changeJobCompartment

Future<ChangeJobCompartmentResponse> changeJobCompartment(ChangeJobCompartmentRequest request,
                                                          com.oracle.bmc.responses.AsyncHandler<ChangeJobCompartmentRequest,ChangeJobCompartmentResponse> handler)

Moves a job.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

changeManagedDatabaseGroupCompartment

Future<ChangeManagedDatabaseGroupCompartmentResponse> changeManagedDatabaseGroupCompartment(ChangeManagedDatabaseGroupCompartmentRequest request,
                                                                                            com.oracle.bmc.responses.AsyncHandler<ChangeManagedDatabaseGroupCompartmentRequest,ChangeManagedDatabaseGroupCompartmentResponse> handler)

Moves a Managed Database Group to a different compartment. The destination compartment must not have a Managed Database Group with the same name.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createJob

Future<CreateJobResponse> createJob(CreateJobRequest request,
                                    com.oracle.bmc.responses.AsyncHandler<CreateJobRequest,CreateJobResponse> handler)

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.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createManagedDatabaseGroup

Future<CreateManagedDatabaseGroupResponse> createManagedDatabaseGroup(CreateManagedDatabaseGroupRequest request,
                                                                      com.oracle.bmc.responses.AsyncHandler<CreateManagedDatabaseGroupRequest,CreateManagedDatabaseGroupResponse> handler)

Creates a Managed Database Group. The group does not contain any Managed Databases when it is created, and they must be added later.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteJob

Future<DeleteJobResponse> deleteJob(DeleteJobRequest request,
                                    com.oracle.bmc.responses.AsyncHandler<DeleteJobRequest,DeleteJobResponse> handler)

Deletes the job specified by jobId.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteManagedDatabaseGroup

Future<DeleteManagedDatabaseGroupResponse> deleteManagedDatabaseGroup(DeleteManagedDatabaseGroupRequest request,
                                                                      com.oracle.bmc.responses.AsyncHandler<DeleteManagedDatabaseGroupRequest,DeleteManagedDatabaseGroupResponse> handler)

Deletes the Managed Database Group specified by managedDatabaseGroupId. If the group contains Managed Databases, then it cannot be deleted.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getDatabaseFleetHealthMetrics

Future<GetDatabaseFleetHealthMetricsResponse> getDatabaseFleetHealthMetrics(GetDatabaseFleetHealthMetricsRequest request,
                                                                            com.oracle.bmc.responses.AsyncHandler<GetDatabaseFleetHealthMetricsRequest,GetDatabaseFleetHealthMetricsResponse> handler)

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.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getDatabaseHomeMetrics

Future<GetDatabaseHomeMetricsResponse> getDatabaseHomeMetrics(GetDatabaseHomeMetricsRequest request,
                                                              com.oracle.bmc.responses.AsyncHandler<GetDatabaseHomeMetricsRequest,GetDatabaseHomeMetricsResponse> handler)

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.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getJob

Future<GetJobResponse> getJob(GetJobRequest request,
                              com.oracle.bmc.responses.AsyncHandler<GetJobRequest,GetJobResponse> handler)

Gets the details for the job specified by jobId.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getJobExecution

Future<GetJobExecutionResponse> getJobExecution(GetJobExecutionRequest request,
                                                com.oracle.bmc.responses.AsyncHandler<GetJobExecutionRequest,GetJobExecutionResponse> handler)

Gets the details for the job execution specified by jobExecutionId.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getJobRun

Future<GetJobRunResponse> getJobRun(GetJobRunRequest request,
                                    com.oracle.bmc.responses.AsyncHandler<GetJobRunRequest,GetJobRunResponse> handler)

Gets the details for the job run specified by jobRunId.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getManagedDatabase

Future<GetManagedDatabaseResponse> getManagedDatabase(GetManagedDatabaseRequest request,
                                                      com.oracle.bmc.responses.AsyncHandler<GetManagedDatabaseRequest,GetManagedDatabaseResponse> handler)

Gets the details for the Managed Database specified by managedDatabaseId.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getManagedDatabaseGroup

Future<GetManagedDatabaseGroupResponse> getManagedDatabaseGroup(GetManagedDatabaseGroupRequest request,
                                                                com.oracle.bmc.responses.AsyncHandler<GetManagedDatabaseGroupRequest,GetManagedDatabaseGroupResponse> handler)

Gets the details for the Managed Database Group specified by managedDatabaseGroupId.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listJobExecutions

Future<ListJobExecutionsResponse> listJobExecutions(ListJobExecutionsRequest request,
                                                    com.oracle.bmc.responses.AsyncHandler<ListJobExecutionsRequest,ListJobExecutionsResponse> handler)

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.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listJobRuns

Future<ListJobRunsResponse> listJobRuns(ListJobRunsRequest request,
                                        com.oracle.bmc.responses.AsyncHandler<ListJobRunsRequest,ListJobRunsResponse> handler)

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.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listJobs

Future<ListJobsResponse> listJobs(ListJobsRequest request,
                                  com.oracle.bmc.responses.AsyncHandler<ListJobsRequest,ListJobsResponse> handler)

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.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listManagedDatabaseGroups

Future<ListManagedDatabaseGroupsResponse> listManagedDatabaseGroups(ListManagedDatabaseGroupsRequest request,
                                                                    com.oracle.bmc.responses.AsyncHandler<ListManagedDatabaseGroupsRequest,ListManagedDatabaseGroupsResponse> handler)

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.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listManagedDatabases

Future<ListManagedDatabasesResponse> listManagedDatabases(ListManagedDatabasesRequest request,
                                                          com.oracle.bmc.responses.AsyncHandler<ListManagedDatabasesRequest,ListManagedDatabasesResponse> handler)

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.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

removeManagedDatabaseFromManagedDatabaseGroup

Future<RemoveManagedDatabaseFromManagedDatabaseGroupResponse> removeManagedDatabaseFromManagedDatabaseGroup(RemoveManagedDatabaseFromManagedDatabaseGroupRequest request,
                                                                                                            com.oracle.bmc.responses.AsyncHandler<RemoveManagedDatabaseFromManagedDatabaseGroupRequest,RemoveManagedDatabaseFromManagedDatabaseGroupResponse> handler)

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.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateManagedDatabaseGroup

Future<UpdateManagedDatabaseGroupResponse> updateManagedDatabaseGroup(UpdateManagedDatabaseGroupRequest request,
                                                                      com.oracle.bmc.responses.AsyncHandler<UpdateManagedDatabaseGroupRequest,UpdateManagedDatabaseGroupResponse> handler)

Updates the Managed Database Group specified by managedDatabaseGroupId.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.