@Generated(value="OracleSDKGenerator", comments="API Version: 20201101") public class DbManagementClient extends Object implements DbManagement
Modifier and Type | Class and Description |
---|---|
static class |
DbManagementClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for DbManagement.
|
Modifier | Constructor and Description |
---|---|
|
DbManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
DbManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
DbManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
DbManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
DbManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration.
|
protected |
DbManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
|
DbManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
DbManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
DbManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
Modifier and Type | Method and Description |
---|---|
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.
|
static DbManagementClient.Builder |
builder()
Create a builder for this client.
|
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.
|
void |
close() |
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.
|
public static final Service SERVICE
Service instance for DbManagement.
public DbManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public DbManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public DbManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public DbManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public DbManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public DbManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public DbManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public DbManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorprotected DbManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
Use the DbManagementClient.Builder
to get access to all these parameters.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static DbManagementClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
DbManagement
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface DbManagement
endpoint
- The endpoint of the service.public String getEndpoint()
DbManagement
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface DbManagement
public void setRegion(Region region)
DbManagement
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
setRegion
in interface DbManagement
region
- The region of the service.public void setRegion(String regionId)
DbManagement
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call
setRegion
.
If no known Region could be determined, it will create an endpoint based on the
default endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
setRegion
in interface DbManagement
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public AddDataFilesResponse addDataFiles(AddDataFilesRequest request)
DbManagement
Adds data files or temp files to the tablespace.
addDataFiles
in interface DbManagement
request
- The request object containing the details to sendpublic AddManagedDatabaseToManagedDatabaseGroupResponse addManagedDatabaseToManagedDatabaseGroup(AddManagedDatabaseToManagedDatabaseGroupRequest request)
DbManagement
Adds a Managed Database to a specific Managed Database Group. After the database is added, it will be included in the management activities performed on the Managed Database Group.
addManagedDatabaseToManagedDatabaseGroup
in interface DbManagement
request
- The request object containing the details to sendpublic AddmTasksResponse addmTasks(AddmTasksRequest request)
DbManagement
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.
addmTasks
in interface DbManagement
request
- The request object containing the details to sendpublic ChangeDatabaseParametersResponse changeDatabaseParameters(ChangeDatabaseParametersRequest request)
DbManagement
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.
changeDatabaseParameters
in interface DbManagement
request
- The request object containing the details to sendpublic ChangeDbManagementPrivateEndpointCompartmentResponse changeDbManagementPrivateEndpointCompartment(ChangeDbManagementPrivateEndpointCompartmentRequest request)
DbManagement
Moves the Database Management private endpoint and its dependent resources to the specified compartment.
changeDbManagementPrivateEndpointCompartment
in interface DbManagement
request
- The request object containing the details to sendpublic ChangeJobCompartmentResponse changeJobCompartment(ChangeJobCompartmentRequest request)
DbManagement
Moves a job.
changeJobCompartment
in interface DbManagement
request
- The request object containing the details to sendpublic ChangeManagedDatabaseGroupCompartmentResponse changeManagedDatabaseGroupCompartment(ChangeManagedDatabaseGroupCompartmentRequest request)
DbManagement
Moves a Managed Database Group to a different compartment. The destination compartment must not have a Managed Database Group with the same name.
changeManagedDatabaseGroupCompartment
in interface DbManagement
request
- The request object containing the details to sendpublic CreateDbManagementPrivateEndpointResponse createDbManagementPrivateEndpoint(CreateDbManagementPrivateEndpointRequest request)
DbManagement
Creates a new Database Management private endpoint.
createDbManagementPrivateEndpoint
in interface DbManagement
request
- The request object containing the details to sendpublic CreateJobResponse createJob(CreateJobRequest request)
DbManagement
Creates a job to be executed on a Managed Database or Managed Database Group. Only one of the parameters, managedDatabaseId or managedDatabaseGroupId should be provided as input in CreateJobDetails resource in request body.
createJob
in interface DbManagement
request
- The request object containing the details to sendpublic CreateManagedDatabaseGroupResponse createManagedDatabaseGroup(CreateManagedDatabaseGroupRequest request)
DbManagement
Creates a Managed Database Group. The group does not contain any Managed Databases when it is created, and they must be added later.
createManagedDatabaseGroup
in interface DbManagement
request
- The request object containing the details to sendpublic CreateTablespaceResponse createTablespace(CreateTablespaceRequest request)
DbManagement
Creates a tablespace within the Managed Database specified by managedDatabaseId.
createTablespace
in interface DbManagement
request
- The request object containing the details to sendpublic DeleteDbManagementPrivateEndpointResponse deleteDbManagementPrivateEndpoint(DeleteDbManagementPrivateEndpointRequest request)
DbManagement
Deletes a specific Database Management private endpoint.
deleteDbManagementPrivateEndpoint
in interface DbManagement
request
- The request object containing the details to sendpublic DeleteJobResponse deleteJob(DeleteJobRequest request)
DbManagement
Deletes the job specified by jobId.
deleteJob
in interface DbManagement
request
- The request object containing the details to sendpublic DeleteManagedDatabaseGroupResponse deleteManagedDatabaseGroup(DeleteManagedDatabaseGroupRequest request)
DbManagement
Deletes the Managed Database Group specified by managedDatabaseGroupId. If the group contains Managed Databases, then it cannot be deleted.
deleteManagedDatabaseGroup
in interface DbManagement
request
- The request object containing the details to sendpublic DropTablespaceResponse dropTablespace(DropTablespaceRequest request)
DbManagement
Drops the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.
dropTablespace
in interface DbManagement
request
- The request object containing the details to sendpublic GenerateAwrSnapshotResponse generateAwrSnapshot(GenerateAwrSnapshotRequest request)
DbManagement
Creates an AWR snapshot for the target database.
generateAwrSnapshot
in interface DbManagement
request
- The request object containing the details to sendpublic GetAwrDbReportResponse getAwrDbReport(GetAwrDbReportRequest request)
DbManagement
Gets the AWR report for the specific database.
getAwrDbReport
in interface DbManagement
request
- The request object containing the details to sendpublic GetAwrDbSqlReportResponse getAwrDbSqlReport(GetAwrDbSqlReportRequest request)
DbManagement
Gets the SQL health check report for one SQL of the specific database.
getAwrDbSqlReport
in interface DbManagement
request
- The request object containing the details to sendpublic GetClusterCacheMetricResponse getClusterCacheMetric(GetClusterCacheMetricRequest request)
DbManagement
Gets the metrics related to cluster cache for the Oracle Real Application Clusters (Oracle RAC) database specified by managedDatabaseId.
getClusterCacheMetric
in interface DbManagement
request
- The request object containing the details to sendpublic GetDatabaseFleetHealthMetricsResponse getDatabaseFleetHealthMetrics(GetDatabaseFleetHealthMetricsRequest request)
DbManagement
Gets the health metrics for a fleet of databases in a compartment or in a Managed Database Group. Either the CompartmentId or the ManagedDatabaseGroupId query parameters must be provided to retrieve the health metrics.
getDatabaseFleetHealthMetrics
in interface DbManagement
request
- The request object containing the details to sendpublic GetDatabaseHomeMetricsResponse getDatabaseHomeMetrics(GetDatabaseHomeMetricsRequest request)
DbManagement
Gets a summary of the activity and resource usage metrics like DB Time, CPU, User I/O, Wait, Storage, and Memory for a Managed Database.
getDatabaseHomeMetrics
in interface DbManagement
request
- The request object containing the details to sendpublic GetDbManagementPrivateEndpointResponse getDbManagementPrivateEndpoint(GetDbManagementPrivateEndpointRequest request)
DbManagement
Gets the details of a specific Database Management private endpoint.
getDbManagementPrivateEndpoint
in interface DbManagement
request
- The request object containing the details to sendpublic GetJobResponse getJob(GetJobRequest request)
DbManagement
Gets the details for the job specified by jobId.
getJob
in interface DbManagement
request
- The request object containing the details to sendpublic GetJobExecutionResponse getJobExecution(GetJobExecutionRequest request)
DbManagement
Gets the details for the job execution specified by jobExecutionId.
getJobExecution
in interface DbManagement
request
- The request object containing the details to sendpublic GetJobRunResponse getJobRun(GetJobRunRequest request)
DbManagement
Gets the details for the job run specified by jobRunId.
getJobRun
in interface DbManagement
request
- The request object containing the details to sendpublic GetManagedDatabaseResponse getManagedDatabase(GetManagedDatabaseRequest request)
DbManagement
Gets the details for the Managed Database specified by managedDatabaseId.
getManagedDatabase
in interface DbManagement
request
- The request object containing the details to sendpublic GetManagedDatabaseGroupResponse getManagedDatabaseGroup(GetManagedDatabaseGroupRequest request)
DbManagement
Gets the details for the Managed Database Group specified by managedDatabaseGroupId.
getManagedDatabaseGroup
in interface DbManagement
request
- The request object containing the details to sendpublic GetPdbMetricsResponse getPdbMetrics(GetPdbMetricsRequest request)
DbManagement
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.
getPdbMetrics
in interface DbManagement
request
- The request object containing the details to sendpublic GetTablespaceResponse getTablespace(GetTablespaceRequest request)
DbManagement
Gets the details of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.
getTablespace
in interface DbManagement
request
- The request object containing the details to sendpublic GetUserResponse getUser(GetUserRequest request)
DbManagement
Gets the details of the user specified by managedDatabaseId and userName.
getUser
in interface DbManagement
request
- The request object containing the details to sendpublic GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
DbManagement
Gets the status of the work request with the given Work Request ID
getWorkRequest
in interface DbManagement
request
- The request object containing the details to sendpublic ListAsmPropertiesResponse listAsmProperties(ListAsmPropertiesRequest request)
DbManagement
Gets the list of ASM properties for the specified managedDatabaseId.
listAsmProperties
in interface DbManagement
request
- The request object containing the details to sendpublic ListAssociatedDatabasesResponse listAssociatedDatabases(ListAssociatedDatabasesRequest request)
DbManagement
Gets the list of databases using a specific Database Management private endpoint.
listAssociatedDatabases
in interface DbManagement
request
- The request object containing the details to sendpublic ListAwrDbSnapshotsResponse listAwrDbSnapshots(ListAwrDbSnapshotsRequest request)
DbManagement
Lists AWR snapshots for the specified database in the AWR.
listAwrDbSnapshots
in interface DbManagement
request
- The request object containing the details to sendpublic ListAwrDbsResponse listAwrDbs(ListAwrDbsRequest request)
DbManagement
Gets the list of databases and their snapshot summary details available in the AWR of the specified Managed Database.
listAwrDbs
in interface DbManagement
request
- The request object containing the details to sendpublic ListConsumerGroupPrivilegesResponse listConsumerGroupPrivileges(ListConsumerGroupPrivilegesRequest request)
DbManagement
Gets the list of consumer group privileges granted to a specific user.
listConsumerGroupPrivileges
in interface DbManagement
request
- The request object containing the details to sendpublic ListDataAccessContainersResponse listDataAccessContainers(ListDataAccessContainersRequest request)
DbManagement
Gets the list of containers for a specific user. This is only applicable if ALL_CONTAINERS !=‘Y’.
listDataAccessContainers
in interface DbManagement
request
- The request object containing the details to sendpublic ListDatabaseParametersResponse listDatabaseParameters(ListDatabaseParametersRequest request)
DbManagement
Gets the list of database parameters for the specified Managed Database. The parameters are listed in alphabetical order, along with their current values.
listDatabaseParameters
in interface DbManagement
request
- The request object containing the details to sendpublic ListDbManagementPrivateEndpointsResponse listDbManagementPrivateEndpoints(ListDbManagementPrivateEndpointsRequest request)
DbManagement
Gets a list of Database Management private endpoints.
listDbManagementPrivateEndpoints
in interface DbManagement
request
- The request object containing the details to sendpublic ListJobExecutionsResponse listJobExecutions(ListJobExecutionsRequest request)
DbManagement
Gets the job execution for a specific ID or the list of job executions for a job, 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.
listJobExecutions
in interface DbManagement
request
- The request object containing the details to sendpublic ListJobRunsResponse listJobRuns(ListJobRunsRequest request)
DbManagement
Gets the job run for a specific ID or the list of job runs for a job, Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, jobId, managedDatabaseId, or managedDatabaseGroupId should be provided. If none of these parameters is provided, all the job runs in the compartment are listed. Job runs can also be filtered based on name and runStatus parameters.
listJobRuns
in interface DbManagement
request
- The request object containing the details to sendpublic ListJobsResponse listJobs(ListJobsRequest request)
DbManagement
Gets the job for a specific ID or the list of jobs for a Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, managedDatabaseId or managedDatabaseGroupId, should be provided. If none of these parameters is provided, all the jobs in the compartment are listed. Jobs can also be filtered based on the name and lifecycleState parameters.
listJobs
in interface DbManagement
request
- The request object containing the details to sendpublic ListManagedDatabaseGroupsResponse listManagedDatabaseGroups(ListManagedDatabaseGroupsRequest request)
DbManagement
Gets the Managed Database Group for a specific ID or the list of Managed Database Groups in a specific compartment. Managed Database Groups can also be filtered based on the name parameter. Only one of the parameters, ID or name should be provided. If none of these parameters is provided, all the Managed Database Groups in the compartment are listed.
listManagedDatabaseGroups
in interface DbManagement
request
- The request object containing the details to sendpublic ListManagedDatabasesResponse listManagedDatabases(ListManagedDatabasesRequest request)
DbManagement
Gets the Managed Database for a specific ID or the list of Managed Databases in a specific compartment.
Managed Databases can 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.
listManagedDatabases
in interface DbManagement
request
- The request object containing the details to sendpublic ListObjectPrivilegesResponse listObjectPrivileges(ListObjectPrivilegesRequest request)
DbManagement
Gets the list of object privileges granted to a specific user.
listObjectPrivileges
in interface DbManagement
request
- The request object containing the details to sendpublic ListProxiedForUsersResponse listProxiedForUsers(ListProxiedForUsersRequest request)
DbManagement
Gets the list of users on whose behalf the current user acts as proxy.
listProxiedForUsers
in interface DbManagement
request
- The request object containing the details to sendpublic ListProxyUsersResponse listProxyUsers(ListProxyUsersRequest request)
DbManagement
Gets the list of proxy users for the current user.
listProxyUsers
in interface DbManagement
request
- The request object containing the details to sendpublic ListRolesResponse listRoles(ListRolesRequest request)
DbManagement
Gets the list of roles granted to a specific user.
listRoles
in interface DbManagement
request
- The request object containing the details to sendpublic ListSystemPrivilegesResponse listSystemPrivileges(ListSystemPrivilegesRequest request)
DbManagement
Gets the list of system privileges granted to a specific user.
listSystemPrivileges
in interface DbManagement
request
- The request object containing the details to sendpublic ListTablespacesResponse listTablespaces(ListTablespacesRequest request)
DbManagement
Gets the list of tablespaces for the specified managedDatabaseId.
listTablespaces
in interface DbManagement
request
- The request object containing the details to sendpublic ListUsersResponse listUsers(ListUsersRequest request)
DbManagement
Gets the list of users for the specified managedDatabaseId.
listUsers
in interface DbManagement
request
- The request object containing the details to sendpublic ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
DbManagement
Returns a paginated list of errors for a given work request.
listWorkRequestErrors
in interface DbManagement
request
- The request object containing the details to sendpublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
DbManagement
Returns a paginated list of logs for a given work request.
listWorkRequestLogs
in interface DbManagement
request
- The request object containing the details to sendpublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
DbManagement
The list of work requests in a specific compartment was retrieved successfully.
listWorkRequests
in interface DbManagement
request
- The request object containing the details to sendpublic RemoveDataFileResponse removeDataFile(RemoveDataFileRequest request)
DbManagement
Removes a data file or temp file from the tablespace.
removeDataFile
in interface DbManagement
request
- The request object containing the details to sendpublic RemoveManagedDatabaseFromManagedDatabaseGroupResponse removeManagedDatabaseFromManagedDatabaseGroup(RemoveManagedDatabaseFromManagedDatabaseGroupRequest request)
DbManagement
Removes a Managed Database from a Managed Database Group. Any management activities that are currently running on this database will continue to run to completion. However, any activities scheduled to run in the future will not be performed on this database.
removeManagedDatabaseFromManagedDatabaseGroup
in interface DbManagement
request
- The request object containing the details to sendpublic ResetDatabaseParametersResponse resetDatabaseParameters(ResetDatabaseParametersRequest request)
DbManagement
Resets database parameter values to their default or startup values.
resetDatabaseParameters
in interface DbManagement
request
- The request object containing the details to sendpublic ResizeDataFileResponse resizeDataFile(ResizeDataFileRequest request)
DbManagement
Resizes a data file or temp file within the tablespace.
resizeDataFile
in interface DbManagement
request
- The request object containing the details to sendpublic RunHistoricAddmResponse runHistoricAddm(RunHistoricAddmRequest request)
DbManagement
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.
runHistoricAddm
in interface DbManagement
request
- The request object containing the details to sendpublic SummarizeAwrDbCpuUsagesResponse summarizeAwrDbCpuUsages(SummarizeAwrDbCpuUsagesRequest request)
DbManagement
Summarizes the AWR CPU resource limits and metrics for the specified database in AWR.
summarizeAwrDbCpuUsages
in interface DbManagement
request
- The request object containing the details to sendpublic SummarizeAwrDbMetricsResponse summarizeAwrDbMetrics(SummarizeAwrDbMetricsRequest request)
DbManagement
Summarizes the metric samples for the specified database in the AWR. The metric samples are summarized based on the Time dimension for each metric.
summarizeAwrDbMetrics
in interface DbManagement
request
- The request object containing the details to sendpublic SummarizeAwrDbParameterChangesResponse summarizeAwrDbParameterChanges(SummarizeAwrDbParameterChangesRequest request)
DbManagement
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
summarizeAwrDbParameterChanges
in interface DbManagement
request
- The request object containing the details to sendpublic SummarizeAwrDbParametersResponse summarizeAwrDbParameters(SummarizeAwrDbParametersRequest request)
DbManagement
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
summarizeAwrDbParameters
in interface DbManagement
request
- The request object containing the details to sendpublic SummarizeAwrDbSnapshotRangesResponse summarizeAwrDbSnapshotRanges(SummarizeAwrDbSnapshotRangesRequest request)
DbManagement
Summarizes the AWR snapshot ranges that contain continuous snapshots, for the specified Managed Database.
summarizeAwrDbSnapshotRanges
in interface DbManagement
request
- The request object containing the details to sendpublic SummarizeAwrDbSysstatsResponse summarizeAwrDbSysstats(SummarizeAwrDbSysstatsRequest request)
DbManagement
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.
summarizeAwrDbSysstats
in interface DbManagement
request
- The request object containing the details to sendpublic SummarizeAwrDbTopWaitEventsResponse summarizeAwrDbTopWaitEvents(SummarizeAwrDbTopWaitEventsRequest request)
DbManagement
Summarizes the AWR top wait events.
summarizeAwrDbTopWaitEvents
in interface DbManagement
request
- The request object containing the details to sendpublic SummarizeAwrDbWaitEventBucketsResponse summarizeAwrDbWaitEventBuckets(SummarizeAwrDbWaitEventBucketsRequest request)
DbManagement
Summarizes AWR wait event data into value buckets and frequency, for the specified database in the AWR.
summarizeAwrDbWaitEventBuckets
in interface DbManagement
request
- The request object containing the details to sendpublic SummarizeAwrDbWaitEventsResponse summarizeAwrDbWaitEvents(SummarizeAwrDbWaitEventsRequest request)
DbManagement
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.
summarizeAwrDbWaitEvents
in interface DbManagement
request
- The request object containing the details to sendpublic SummarizeJobExecutionsStatusesResponse summarizeJobExecutionsStatuses(SummarizeJobExecutionsStatusesRequest request)
DbManagement
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.
summarizeJobExecutionsStatuses
in interface DbManagement
request
- The request object containing the details to sendpublic UpdateDbManagementPrivateEndpointResponse updateDbManagementPrivateEndpoint(UpdateDbManagementPrivateEndpointRequest request)
DbManagement
Updates one or more attributes of a specific Database Management private endpoint.
updateDbManagementPrivateEndpoint
in interface DbManagement
request
- The request object containing the details to sendpublic UpdateJobResponse updateJob(UpdateJobRequest request)
DbManagement
Updates the details for the recurring scheduled job specified by jobId. Note that non-recurring (one time) jobs cannot be updated.
updateJob
in interface DbManagement
request
- The request object containing the details to sendpublic UpdateManagedDatabaseGroupResponse updateManagedDatabaseGroup(UpdateManagedDatabaseGroupRequest request)
DbManagement
Updates the Managed Database Group specified by managedDatabaseGroupId.
updateManagedDatabaseGroup
in interface DbManagement
request
- The request object containing the details to sendpublic UpdateTablespaceResponse updateTablespace(UpdateTablespaceRequest request)
DbManagement
Updates the attributes of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.
updateTablespace
in interface DbManagement
request
- The request object containing the details to sendpublic DbManagementWaiters getWaiters()
DbManagement
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface DbManagement
public DbManagementPaginators getPaginators()
DbManagement
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data. These paginators provide an Iterable
interface so that service responses, or
resources/records, can be iterated through without having to manually deal with pagination and page tokens.
getPaginators
in interface DbManagement
Copyright © 2016–2022. All rights reserved.