com.oracle.bmc.databasemanagement

Interface DbManagement

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DbManagementClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20201101")
public interface DbManagement
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
AddManagedDatabaseToManagedDatabaseGroupResponse	addManagedDatabaseToManagedDatabaseGroup(AddManagedDatabaseToManagedDatabaseGroupRequest request) Adds a Managed Database to a specific Managed Database Group.
ChangeJobCompartmentResponse	changeJobCompartment(ChangeJobCompartmentRequest request) Moves a job.
ChangeManagedDatabaseGroupCompartmentResponse	changeManagedDatabaseGroupCompartment(ChangeManagedDatabaseGroupCompartmentRequest request) Moves a Managed Database Group to a different compartment.
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(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’).
UpdateManagedDatabaseGroupResponse	updateManagedDatabaseGroup(UpdateManagedDatabaseGroupRequest request) 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 service.

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

AddManagedDatabaseToManagedDatabaseGroupResponse addManagedDatabaseToManagedDatabaseGroup(AddManagedDatabaseToManagedDatabaseGroupRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use AddManagedDatabaseToManagedDatabaseGroup API.

changeJobCompartment

ChangeJobCompartmentResponse changeJobCompartment(ChangeJobCompartmentRequest request)

Moves a job.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ChangeJobCompartment API.

changeManagedDatabaseGroupCompartment

ChangeManagedDatabaseGroupCompartmentResponse changeManagedDatabaseGroupCompartment(ChangeManagedDatabaseGroupCompartmentRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ChangeManagedDatabaseGroupCompartment API.

createJob

CreateJobResponse createJob(CreateJobRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use CreateJob API.

createManagedDatabaseGroup

CreateManagedDatabaseGroupResponse createManagedDatabaseGroup(CreateManagedDatabaseGroupRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use CreateManagedDatabaseGroup API.

deleteJob

DeleteJobResponse deleteJob(DeleteJobRequest request)

Deletes the job specified by jobId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use DeleteJob API.

deleteManagedDatabaseGroup

DeleteManagedDatabaseGroupResponse deleteManagedDatabaseGroup(DeleteManagedDatabaseGroupRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use DeleteManagedDatabaseGroup API.

getDatabaseFleetHealthMetrics

GetDatabaseFleetHealthMetricsResponse getDatabaseFleetHealthMetrics(GetDatabaseFleetHealthMetricsRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetDatabaseFleetHealthMetrics API.

getDatabaseHomeMetrics

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetDatabaseHomeMetrics API.

getJob

GetJobResponse getJob(GetJobRequest request)

Gets the details for the job specified by jobId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetJob API.

getJobExecution

GetJobExecutionResponse getJobExecution(GetJobExecutionRequest request)

Gets the details for the job execution specified by jobExecutionId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetJobExecution API.

getJobRun

GetJobRunResponse getJobRun(GetJobRunRequest request)

Gets the details for the job run specified by jobRunId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetJobRun API.

getManagedDatabase

GetManagedDatabaseResponse getManagedDatabase(GetManagedDatabaseRequest request)

Gets the details for the Managed Database specified by managedDatabaseId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetManagedDatabase API.

getManagedDatabaseGroup

GetManagedDatabaseGroupResponse getManagedDatabaseGroup(GetManagedDatabaseGroupRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetManagedDatabaseGroup API.

listJobExecutions

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListJobExecutions API.

listJobRuns

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListJobRuns API.

listJobs

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListJobs API.

listManagedDatabaseGroups

ListManagedDatabaseGroupsResponse listManagedDatabaseGroups(ListManagedDatabaseGroupsRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListManagedDatabaseGroups API.

listManagedDatabases

ListManagedDatabasesResponse listManagedDatabases(ListManagedDatabasesRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListManagedDatabases API.

removeManagedDatabaseFromManagedDatabaseGroup

RemoveManagedDatabaseFromManagedDatabaseGroupResponse removeManagedDatabaseFromManagedDatabaseGroup(RemoveManagedDatabaseFromManagedDatabaseGroupRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use RemoveManagedDatabaseFromManagedDatabaseGroup API.

updateManagedDatabaseGroup

UpdateManagedDatabaseGroupResponse updateManagedDatabaseGroup(UpdateManagedDatabaseGroupRequest request)

Updates the Managed Database Group specified by managedDatabaseGroupId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use UpdateManagedDatabaseGroup API.

getWaiters

DbManagementWaiters getWaiters()

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

Returns:

The service waiters.

getPaginators

DbManagementPaginators getPaginators()

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.

Returns:

The service paginators.