@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.
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
Modifier and Type | Method and Description |
---|---|
AddDataFilesResponse |
addDataFiles(AddDataFilesRequest request)
Adds data files or temp files to the tablespace.
|
AddManagedDatabaseToManagedDatabaseGroupResponse |
addManagedDatabaseToManagedDatabaseGroup(AddManagedDatabaseToManagedDatabaseGroupRequest request)
Adds a Managed Database to a specific Managed Database Group.
|
AddmTasksResponse |
addmTasks(AddmTasksRequest request)
Lists the metadata for each ADDM task who’s end snapshot time falls within the provided start and end time.
|
ChangeDatabaseParametersResponse |
changeDatabaseParameters(ChangeDatabaseParametersRequest request)
Changes database parameter values.
|
ChangeDbManagementPrivateEndpointCompartmentResponse |
changeDbManagementPrivateEndpointCompartment(ChangeDbManagementPrivateEndpointCompartmentRequest request)
Moves the Database Management private endpoint and its dependent resources to the specified compartment.
|
ChangeJobCompartmentResponse |
changeJobCompartment(ChangeJobCompartmentRequest request)
Moves a job.
|
ChangeManagedDatabaseGroupCompartmentResponse |
changeManagedDatabaseGroupCompartment(ChangeManagedDatabaseGroupCompartmentRequest request)
Moves a Managed Database Group to a different compartment.
|
CreateDbManagementPrivateEndpointResponse |
createDbManagementPrivateEndpoint(CreateDbManagementPrivateEndpointRequest request)
Creates a new Database Management private endpoint.
|
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.
|
CreateTablespaceResponse |
createTablespace(CreateTablespaceRequest request)
Creates a tablespace within the Managed Database specified by managedDatabaseId.
|
DeleteDbManagementPrivateEndpointResponse |
deleteDbManagementPrivateEndpoint(DeleteDbManagementPrivateEndpointRequest request)
Deletes a specific Database Management private endpoint.
|
DeleteJobResponse |
deleteJob(DeleteJobRequest request)
Deletes the job specified by jobId.
|
DeleteManagedDatabaseGroupResponse |
deleteManagedDatabaseGroup(DeleteManagedDatabaseGroupRequest request)
Deletes the Managed Database Group specified by managedDatabaseGroupId.
|
DropTablespaceResponse |
dropTablespace(DropTablespaceRequest request)
Drops the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.
|
GenerateAwrSnapshotResponse |
generateAwrSnapshot(GenerateAwrSnapshotRequest request)
Creates an AWR snapshot for the target database.
|
GetAwrDbReportResponse |
getAwrDbReport(GetAwrDbReportRequest request)
Gets the AWR report for the specific database.
|
GetAwrDbSqlReportResponse |
getAwrDbSqlReport(GetAwrDbSqlReportRequest request)
Gets the SQL health check report for one SQL of the specific database.
|
GetClusterCacheMetricResponse |
getClusterCacheMetric(GetClusterCacheMetricRequest request)
Gets the metrics related to cluster cache for the Oracle
Real Application Clusters (Oracle RAC) database specified
by managedDatabaseId.
|
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.
|
GetDbManagementPrivateEndpointResponse |
getDbManagementPrivateEndpoint(GetDbManagementPrivateEndpointRequest request)
Gets the details of a specific Database Management private endpoint.
|
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.
|
GetPdbMetricsResponse |
getPdbMetrics(GetPdbMetricsRequest request)
Gets a summary of the resource usage metrics such as CPU, User I/O, and Storage for each
PDB within a specific CDB.
|
GetTablespaceResponse |
getTablespace(GetTablespaceRequest request)
Gets the details of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.
|
GetUserResponse |
getUser(GetUserRequest request)
Gets the details of the user specified by managedDatabaseId and userName.
|
DbManagementWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
GetWorkRequestResponse |
getWorkRequest(GetWorkRequestRequest request)
Gets the status of the work request with the given Work Request ID
|
ListAsmPropertiesResponse |
listAsmProperties(ListAsmPropertiesRequest request)
Gets the list of ASM properties for the specified managedDatabaseId.
|
ListAssociatedDatabasesResponse |
listAssociatedDatabases(ListAssociatedDatabasesRequest request)
Gets the list of databases using a specific Database Management private endpoint.
|
ListAwrDbsResponse |
listAwrDbs(ListAwrDbsRequest request)
Gets the list of databases and their snapshot summary details available in the AWR of the specified Managed Database.
|
ListAwrDbSnapshotsResponse |
listAwrDbSnapshots(ListAwrDbSnapshotsRequest request)
Lists AWR snapshots for the specified database in the AWR.
|
ListConsumerGroupPrivilegesResponse |
listConsumerGroupPrivileges(ListConsumerGroupPrivilegesRequest request)
Gets the list of consumer group privileges granted to a specific user.
|
ListDataAccessContainersResponse |
listDataAccessContainers(ListDataAccessContainersRequest request)
Gets the list of containers for a specific user.
|
ListDatabaseParametersResponse |
listDatabaseParameters(ListDatabaseParametersRequest request)
Gets the list of database parameters for the specified Managed Database.
|
ListDbManagementPrivateEndpointsResponse |
listDbManagementPrivateEndpoints(ListDbManagementPrivateEndpointsRequest request)
Gets a list of Database Management private endpoints.
|
ListJobExecutionsResponse |
listJobExecutions(ListJobExecutionsRequest request)
Gets the job execution for a specific ID or the list of job executions for a job, job run, 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.
|
ListObjectPrivilegesResponse |
listObjectPrivileges(ListObjectPrivilegesRequest request)
Gets the list of object privileges granted to a specific user.
|
ListProxiedForUsersResponse |
listProxiedForUsers(ListProxiedForUsersRequest request)
Gets the list of users on whose behalf the current user acts as proxy.
|
ListProxyUsersResponse |
listProxyUsers(ListProxyUsersRequest request)
Gets the list of proxy users for the current user.
|
ListRolesResponse |
listRoles(ListRolesRequest request)
Gets the list of roles granted to a specific user.
|
ListSystemPrivilegesResponse |
listSystemPrivileges(ListSystemPrivilegesRequest request)
Gets the list of system privileges granted to a specific user.
|
ListTablespacesResponse |
listTablespaces(ListTablespacesRequest request)
Gets the list of tablespaces for the specified managedDatabaseId.
|
ListUsersResponse |
listUsers(ListUsersRequest request)
Gets the list of users for the specified managedDatabaseId.
|
ListWorkRequestErrorsResponse |
listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Returns a paginated list of errors for a given work request.
|
ListWorkRequestLogsResponse |
listWorkRequestLogs(ListWorkRequestLogsRequest request)
Returns a paginated list of logs for a given work request.
|
ListWorkRequestsResponse |
listWorkRequests(ListWorkRequestsRequest request)
The list of work requests in a specific compartment was retrieved successfully.
|
RemoveDataFileResponse |
removeDataFile(RemoveDataFileRequest request)
Removes a data file or temp file from the tablespace.
|
RemoveManagedDatabaseFromManagedDatabaseGroupResponse |
removeManagedDatabaseFromManagedDatabaseGroup(RemoveManagedDatabaseFromManagedDatabaseGroupRequest request)
Removes a Managed Database from a Managed Database Group.
|
ResetDatabaseParametersResponse |
resetDatabaseParameters(ResetDatabaseParametersRequest request)
Resets database parameter values to their default or startup values.
|
ResizeDataFileResponse |
resizeDataFile(ResizeDataFileRequest request)
Resizes a data file or temp file within the tablespace.
|
RunHistoricAddmResponse |
runHistoricAddm(RunHistoricAddmRequest request)
Creates and executes a historic ADDM task using the specified AWR snapshot IDs.
|
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’).
|
SummarizeAwrDbCpuUsagesResponse |
summarizeAwrDbCpuUsages(SummarizeAwrDbCpuUsagesRequest request)
Summarizes the AWR CPU resource limits and metrics for the specified database in AWR.
|
SummarizeAwrDbMetricsResponse |
summarizeAwrDbMetrics(SummarizeAwrDbMetricsRequest request)
Summarizes the metric samples for the specified database in the AWR.
|
SummarizeAwrDbParameterChangesResponse |
summarizeAwrDbParameterChanges(SummarizeAwrDbParameterChangesRequest request)
Summarizes the database parameter change history for one database parameter of the specified database in AWR.
|
SummarizeAwrDbParametersResponse |
summarizeAwrDbParameters(SummarizeAwrDbParametersRequest request)
Summarizes the database parameter history for the specified database in AWR.
|
SummarizeAwrDbSnapshotRangesResponse |
summarizeAwrDbSnapshotRanges(SummarizeAwrDbSnapshotRangesRequest request)
Summarizes the AWR snapshot ranges that contain continuous snapshots, for the specified Managed Database.
|
SummarizeAwrDbSysstatsResponse |
summarizeAwrDbSysstats(SummarizeAwrDbSysstatsRequest request)
Summarizes the AWR SYSSTAT sample data for the specified database in AWR.
|
SummarizeAwrDbTopWaitEventsResponse |
summarizeAwrDbTopWaitEvents(SummarizeAwrDbTopWaitEventsRequest request)
Summarizes the AWR top wait events.
|
SummarizeAwrDbWaitEventBucketsResponse |
summarizeAwrDbWaitEventBuckets(SummarizeAwrDbWaitEventBucketsRequest request)
Summarizes AWR wait event data into value buckets and frequency, for the specified database in the AWR.
|
SummarizeAwrDbWaitEventsResponse |
summarizeAwrDbWaitEvents(SummarizeAwrDbWaitEventsRequest request)
Summarizes the AWR wait event sample data for the specified database in the AWR.
|
SummarizeJobExecutionsStatusesResponse |
summarizeJobExecutionsStatuses(SummarizeJobExecutionsStatusesRequest request)
Gets the number of job executions grouped by status for a job, Managed Database, or Database Group in a specific compartment.
|
UpdateDbManagementPrivateEndpointResponse |
updateDbManagementPrivateEndpoint(UpdateDbManagementPrivateEndpointRequest request)
Updates one or more attributes of a specific Database Management private endpoint.
|
UpdateJobResponse |
updateJob(UpdateJobRequest request)
Updates the details for the recurring scheduled job specified by jobId.
|
UpdateManagedDatabaseGroupResponse |
updateManagedDatabaseGroup(UpdateManagedDatabaseGroupRequest request)
Updates the Managed Database Group specified by managedDatabaseGroupId.
|
UpdateTablespaceResponse |
updateTablespace(UpdateTablespaceRequest request)
Updates the attributes of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.
|
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(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.
region
- The region of the service.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
.
regionId
- The public region ID.AddDataFilesResponse addDataFiles(AddDataFilesRequest request)
Adds data files or temp files to the tablespace.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use AddDataFiles API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use AddManagedDatabaseToManagedDatabaseGroup API.
AddmTasksResponse addmTasks(AddmTasksRequest request)
Lists the metadata for each ADDM task who’s end snapshot time falls within the provided start and end time. Details include the name of the ADDM task, description, user, status and creation date time.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use AddmTasks API.
ChangeDatabaseParametersResponse changeDatabaseParameters(ChangeDatabaseParametersRequest request)
Changes database parameter values. There are two kinds of database parameters:
- Dynamic parameters: They can be changed for the current Oracle Database instance. The changes take effect immediately. - Static parameters: They cannot be changed for the current instance. You must change these parameters and then restart the database before changes take effect.
Note:** If the instance is started using a text initialization parameter file, the parameter changes are applicable only for the current instance. You must update them manually to be passed to a future instance.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeDatabaseParameters API.
ChangeDbManagementPrivateEndpointCompartmentResponse changeDbManagementPrivateEndpointCompartment(ChangeDbManagementPrivateEndpointCompartmentRequest request)
Moves the Database Management private endpoint and its dependent resources to the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeDbManagementPrivateEndpointCompartment API.
ChangeJobCompartmentResponse changeJobCompartment(ChangeJobCompartmentRequest request)
Moves a job.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeJobCompartment API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeManagedDatabaseGroupCompartment API.
CreateDbManagementPrivateEndpointResponse createDbManagementPrivateEndpoint(CreateDbManagementPrivateEndpointRequest request)
Creates a new Database Management private endpoint.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateDbManagementPrivateEndpoint API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateJob API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateManagedDatabaseGroup API.
CreateTablespaceResponse createTablespace(CreateTablespaceRequest request)
Creates a tablespace within the Managed Database specified by managedDatabaseId.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateTablespace API.
DeleteDbManagementPrivateEndpointResponse deleteDbManagementPrivateEndpoint(DeleteDbManagementPrivateEndpointRequest request)
Deletes a specific Database Management private endpoint.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteDbManagementPrivateEndpoint API.
DeleteJobResponse deleteJob(DeleteJobRequest request)
Deletes the job specified by jobId.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteJob API.
DeleteManagedDatabaseGroupResponse deleteManagedDatabaseGroup(DeleteManagedDatabaseGroupRequest request)
Deletes the Managed Database Group specified by managedDatabaseGroupId. If the group contains Managed Databases, then it cannot be deleted.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteManagedDatabaseGroup API.
DropTablespaceResponse dropTablespace(DropTablespaceRequest request)
Drops the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DropTablespace API.
GenerateAwrSnapshotResponse generateAwrSnapshot(GenerateAwrSnapshotRequest request)
Creates an AWR snapshot for the target database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GenerateAwrSnapshot API.
GetAwrDbReportResponse getAwrDbReport(GetAwrDbReportRequest request)
Gets the AWR report for the specific database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetAwrDbReport API.
GetAwrDbSqlReportResponse getAwrDbSqlReport(GetAwrDbSqlReportRequest request)
Gets the SQL health check report for one SQL of the specific database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetAwrDbSqlReport API.
GetClusterCacheMetricResponse getClusterCacheMetric(GetClusterCacheMetricRequest request)
Gets the metrics related to cluster cache for the Oracle Real Application Clusters (Oracle RAC) database specified by managedDatabaseId.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetClusterCacheMetric API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetDatabaseFleetHealthMetrics API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetDatabaseHomeMetrics API.
GetDbManagementPrivateEndpointResponse getDbManagementPrivateEndpoint(GetDbManagementPrivateEndpointRequest request)
Gets the details of a specific Database Management private endpoint.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetDbManagementPrivateEndpoint API.
GetJobResponse getJob(GetJobRequest request)
Gets the details for the job specified by jobId.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetJob API.
GetJobExecutionResponse getJobExecution(GetJobExecutionRequest request)
Gets the details for the job execution specified by jobExecutionId.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetJobExecution API.
GetJobRunResponse getJobRun(GetJobRunRequest request)
Gets the details for the job run specified by jobRunId.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetJobRun API.
GetManagedDatabaseResponse getManagedDatabase(GetManagedDatabaseRequest request)
Gets the details for the Managed Database specified by managedDatabaseId.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetManagedDatabase API.
GetManagedDatabaseGroupResponse getManagedDatabaseGroup(GetManagedDatabaseGroupRequest request)
Gets the details for the Managed Database Group specified by managedDatabaseGroupId.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetManagedDatabaseGroup API.
GetPdbMetricsResponse getPdbMetrics(GetPdbMetricsRequest request)
Gets a summary of the resource usage metrics such as CPU, User I/O, and Storage for each PDB within a specific CDB. If comparmentId is specified, then the metrics for each PDB (within the CDB) in the specified compartment are retrieved. If compartmentId is not specified, then the metrics for all the PDBs within the CDB are retrieved.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetPdbMetrics API.
GetTablespaceResponse getTablespace(GetTablespaceRequest request)
Gets the details of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetTablespace API.
GetUserResponse getUser(GetUserRequest request)
Gets the details of the user specified by managedDatabaseId and userName.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetUser API.
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Gets the status of the work request with the given Work Request ID
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetWorkRequest API.
ListAsmPropertiesResponse listAsmProperties(ListAsmPropertiesRequest request)
Gets the list of ASM properties for the specified managedDatabaseId.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListAsmProperties API.
ListAssociatedDatabasesResponse listAssociatedDatabases(ListAssociatedDatabasesRequest request)
Gets the list of databases using a specific Database Management private endpoint.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListAssociatedDatabases API.
ListAwrDbSnapshotsResponse listAwrDbSnapshots(ListAwrDbSnapshotsRequest request)
Lists AWR snapshots for the specified database in the AWR.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListAwrDbSnapshots API.
ListAwrDbsResponse listAwrDbs(ListAwrDbsRequest request)
Gets the list of databases and their snapshot summary details available in the AWR of the specified Managed Database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListAwrDbs API.
ListConsumerGroupPrivilegesResponse listConsumerGroupPrivileges(ListConsumerGroupPrivilegesRequest request)
Gets the list of consumer group privileges granted to a specific user.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListConsumerGroupPrivileges API.
ListDataAccessContainersResponse listDataAccessContainers(ListDataAccessContainersRequest request)
Gets the list of containers for a specific user. This is only applicable if ALL_CONTAINERS !=‘Y’.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListDataAccessContainers API.
ListDatabaseParametersResponse listDatabaseParameters(ListDatabaseParametersRequest request)
Gets the list of database parameters for the specified Managed Database. The parameters are listed in alphabetical order, along with their current values.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListDatabaseParameters API.
ListDbManagementPrivateEndpointsResponse listDbManagementPrivateEndpoints(ListDbManagementPrivateEndpointsRequest request)
Gets a list of Database Management private endpoints.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListDbManagementPrivateEndpoints API.
ListJobExecutionsResponse listJobExecutions(ListJobExecutionsRequest request)
Gets the job execution for a specific ID or the list of job executions for a job, job run, Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, jobId, jobRunId, 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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListJobExecutions API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListJobRuns API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListJobs API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListManagedDatabaseGroups API.
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 be filtered based on the name parameter. Only one of the parameters, ID or name
should be provided. If neither of these parameters is provided, all the Managed Databases in the compartment
are listed. Managed Databases can also be filtered based on the deployment type and management option.
If the deployment type is not specified or if it is ONPREMISE
, then the management option is not
considered and Managed Databases with ADVANCED
management option are listed.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListManagedDatabases API.
ListObjectPrivilegesResponse listObjectPrivileges(ListObjectPrivilegesRequest request)
Gets the list of object privileges granted to a specific user.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListObjectPrivileges API.
ListProxiedForUsersResponse listProxiedForUsers(ListProxiedForUsersRequest request)
Gets the list of users on whose behalf the current user acts as proxy.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListProxiedForUsers API.
ListProxyUsersResponse listProxyUsers(ListProxyUsersRequest request)
Gets the list of proxy users for the current user.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListProxyUsers API.
ListRolesResponse listRoles(ListRolesRequest request)
Gets the list of roles granted to a specific user.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListRoles API.
ListSystemPrivilegesResponse listSystemPrivileges(ListSystemPrivilegesRequest request)
Gets the list of system privileges granted to a specific user.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSystemPrivileges API.
ListTablespacesResponse listTablespaces(ListTablespacesRequest request)
Gets the list of tablespaces for the specified managedDatabaseId.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListTablespaces API.
ListUsersResponse listUsers(ListUsersRequest request)
Gets the list of users for the specified managedDatabaseId.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListUsers API.
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Returns a paginated list of errors for a given work request.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListWorkRequestErrors API.
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Returns a paginated list of logs for a given work request.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListWorkRequestLogs API.
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
The list of work requests in a specific compartment was retrieved successfully.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListWorkRequests API.
RemoveDataFileResponse removeDataFile(RemoveDataFileRequest request)
Removes a data file or temp file from the tablespace.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RemoveDataFile API.
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RemoveManagedDatabaseFromManagedDatabaseGroup API.
ResetDatabaseParametersResponse resetDatabaseParameters(ResetDatabaseParametersRequest request)
Resets database parameter values to their default or startup values.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ResetDatabaseParameters API.
ResizeDataFileResponse resizeDataFile(ResizeDataFileRequest request)
Resizes a data file or temp file within the tablespace.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ResizeDataFile API.
RunHistoricAddmResponse runHistoricAddm(RunHistoricAddmRequest request)
Creates and executes a historic ADDM task using the specified AWR snapshot IDs. If an existing ADDM task uses the provided awr snapshot IDs, the existing task will be returned.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use RunHistoricAddm API.
SummarizeAwrDbCpuUsagesResponse summarizeAwrDbCpuUsages(SummarizeAwrDbCpuUsagesRequest request)
Summarizes the AWR CPU resource limits and metrics for the specified database in AWR.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SummarizeAwrDbCpuUsages API.
SummarizeAwrDbMetricsResponse summarizeAwrDbMetrics(SummarizeAwrDbMetricsRequest request)
Summarizes the metric samples for the specified database in the AWR. The metric samples are summarized based on the Time dimension for each metric.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SummarizeAwrDbMetrics API.
SummarizeAwrDbParameterChangesResponse summarizeAwrDbParameterChanges(SummarizeAwrDbParameterChangesRequest request)
Summarizes the database parameter change history for one database parameter of the specified database in AWR. One change history record contains the previous value, the changed value, and the corresponding time range. If the database parameter value was changed multiple times within the time range, then multiple change history records are created for the same parameter. Note that this API only returns information on change history details for one database parameter. To get a list of all the database parameters whose values were changed during a specified time range, use the following API endpoint: /managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbParameters
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SummarizeAwrDbParameterChanges API.
SummarizeAwrDbParametersResponse summarizeAwrDbParameters(SummarizeAwrDbParametersRequest request)
Summarizes the database parameter history for the specified database in AWR. This includes the list of database parameters, with information on whether the parameter values were modified within the query time range. Note that each database parameter is only listed once. Depending on the optional query parameters, the returned summary gets all the database parameters, which include:
- Each parameter whose value was changed during the time range: (valueChanged =\"Y\") - Each parameter whose value was unchanged during the time range: (valueChanged =\"N\") - Each parameter whose value was changed at the system level during the time range: (valueChanged =\"Y\" and valueModified = \"SYSTEM_MOD\") - Each parameter whose value was unchanged during the time range, however, the value is not the default value: (valueChanged =\"N\" and valueDefault = \"FALSE\")
Note that this API does not return information on the number of times each database parameter has been changed within the time range. To get the database parameter value change history for a specific parameter, use the following API endpoint: /managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbParameterChanges
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SummarizeAwrDbParameters API.
SummarizeAwrDbSnapshotRangesResponse summarizeAwrDbSnapshotRanges(SummarizeAwrDbSnapshotRangesRequest request)
Summarizes the AWR snapshot ranges that contain continuous snapshots, for the specified Managed Database.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SummarizeAwrDbSnapshotRanges API.
SummarizeAwrDbSysstatsResponse summarizeAwrDbSysstats(SummarizeAwrDbSysstatsRequest request)
Summarizes the AWR SYSSTAT sample data for the specified database in AWR. The statistical data is summarized based on the Time dimension for each statistic.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SummarizeAwrDbSysstats API.
SummarizeAwrDbTopWaitEventsResponse summarizeAwrDbTopWaitEvents(SummarizeAwrDbTopWaitEventsRequest request)
Summarizes the AWR top wait events.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SummarizeAwrDbTopWaitEvents API.
SummarizeAwrDbWaitEventBucketsResponse summarizeAwrDbWaitEventBuckets(SummarizeAwrDbWaitEventBucketsRequest request)
Summarizes AWR wait event data into value buckets and frequency, for the specified database in the AWR.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SummarizeAwrDbWaitEventBuckets API.
SummarizeAwrDbWaitEventsResponse summarizeAwrDbWaitEvents(SummarizeAwrDbWaitEventsRequest request)
Summarizes the AWR wait event sample data for the specified database in the AWR. The event data is summarized based on the Time dimension for each event.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SummarizeAwrDbWaitEvents API.
SummarizeJobExecutionsStatusesResponse summarizeJobExecutionsStatuses(SummarizeJobExecutionsStatusesRequest request)
Gets the number of job executions grouped by status for a job, Managed Database, or Database Group in a specific compartment. Only one of the parameters, jobId, managedDatabaseId, or managedDatabaseGroupId should be provided.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SummarizeJobExecutionsStatuses API.
UpdateDbManagementPrivateEndpointResponse updateDbManagementPrivateEndpoint(UpdateDbManagementPrivateEndpointRequest request)
Updates one or more attributes of a specific Database Management private endpoint.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateDbManagementPrivateEndpoint API.
UpdateJobResponse updateJob(UpdateJobRequest request)
Updates the details for the recurring scheduled job specified by jobId. Note that non-recurring (one time) jobs cannot be updated.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateJob API.
UpdateManagedDatabaseGroupResponse updateManagedDatabaseGroup(UpdateManagedDatabaseGroupRequest request)
Updates the Managed Database Group specified by managedDatabaseGroupId.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateManagedDatabaseGroup API.
UpdateTablespaceResponse updateTablespace(UpdateTablespaceRequest request)
Updates the attributes of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateTablespace API.
DbManagementWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
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.
Copyright © 2016–2022. All rights reserved.