Namespace Oci.DatabaseService.Models
Classes
AcdAvmResourceStats
Resource usage by autonomous container database in a particular VM.
ActionMember
The details of an action member.
ActionOrderDetails
Describes the ordering list of action resources.
ActionParamValuesCollection
A list of Action Parameters. Contains ActionParamValues items.
ActionParamValuesSummary
Details of the action parameter and its possible values that is used in listParamsForActionType.
ActivateExadataInfrastructureDetails
The activation details for the Exadata Cloud@Customer infrastructure. Applies to Exadata Cloud@Customer instances only.
AddVirtualMachineToCloudVmClusterDetails
Details of adding Virtual Machines to the Cloud VM Cluster. Applies to Exadata Cloud instances only.
AddVirtualMachineToVmClusterDetails
Details of adding Virtual Machines to the VM Cluster. Applies to Exadata Cloud@Customer instances only.
AppVersionSummary
The version details specific to an app.
ApplicationVip
Details of an application virtual IP (VIP) address.
ApplicationVipSummary
Details of an application virtual IP (VIP) address.
AssociatedDatabaseDetails
Databases associated with a backup destination
AutomatedMountDetails
Used for creating NFS Auto Mount backup destinations for autonomous on ExaCC.
AutonomousContainerDatabase
AutonomousContainerDatabaseBackupConfig
Backup options for the Autonomous Container Database.
AutonomousContainerDatabaseDataguardAssociation
The properties that define Autonomous Data Guard association between two different Autonomous Container Databases.
AutonomousContainerDatabaseResourceUsage
Associated autonomous container databases usages.
AutonomousContainerDatabaseSummary
An Autonomous Container Database is a container database service that enables the customer to host one or more databases within the container database. A basic container database runs on a single Autonomous Exadata Infrastructure from an availability domain without the Extreme Availability features enabled.
AutonomousContainerDatabaseVersionSummary
The supported Autonomous Database version.
AutonomousDataWarehouse
Deprecated. See {@link AutonomousDatabase} for reference information about Autonomous Databases with the warehouse workload type.
AutonomousDataWarehouseConnectionStrings
Deprecated. For information about connection strings to connect to an Oracle Autonomous Data Warehouse, see {@link #autonomousDatabaseConnectionStrings(AutonomousDatabaseConnectionStringsRequest) autonomousDatabaseConnectionStrings}.
AutonomousDataWarehouseSummary
Deprecated. See {@link #autonomousDatabase(AutonomousDatabaseRequest) autonomousDatabase} for reference information about Autonomous Databases with the warehouse workload type.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
AutonomousDatabase
An Oracle Autonomous Database.
AutonomousDatabaseApex
Oracle APEX Application Development is a low-code development platform that enables you to build scalable, secure enterprise apps, with world-class features. Autonomous Database with the APEX workload type is optimized to support APEX development.
AutonomousDatabaseBackup
An Autonomous Database backup.
AutonomousDatabaseBackupConfig
Autonomous Database configuration details for storing manual backups in the Object Storage service.
AutonomousDatabaseBackupSummary
An Autonomous Database backup. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
AutonomousDatabaseCharacterSets
The Oracle Autonomous Database supported character sets.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
AutonomousDatabaseConnectionStrings
Connection strings to connect to an Oracle Autonomous Database.
Example output for connection strings. See {@link #databaseConnectionStringProfile(DatabaseConnectionStringProfileRequest) databaseConnectionStringProfile} for additional details:
"connectionStrings": {
"allConnectionStrings": {
"HIGH": "adb.region.oraclecloud.com:1522/unique_id_databasename_high.adwc.oraclecloud.com",
"LOW": "adb.region.oraclecloud.com:1522/unique_id_databasename_low.adwc.oraclecloud.com",
"MEDIUM": "adb.region.oraclecloud.com:1522/unique_id_databasename_medium.adwc.oraclecloud.com"
},
"profiles": [
{
"displayName": "databasename_high",
"value": "(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_high.adwc.oraclecloud.com))(security=(ssl_server_cert_dn="CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US")))",
"consumerGroup": "HIGH",
"protocol": "TCPS",
"tlsAuthentication": "MUTUAL",
"hostFormat": "FQDN",
"sessionMode": "DIRECT",
"syntaxFormat": "LONG"
},
{
"displayName": "databasename_low",
"value": "(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_low.adwc.oraclecloud.com))(security=(ssl_server_cert_dn="CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US")))",
"consumerGroup": "LOW",
"protocol": "TCPS",
"tlsAuthentication": "MUTUAL",
"hostFormat": "FQDN",
"sessionMode": "DIRECT",
"syntaxFormat": "LONG"
},
{
"displayName": "databasename_medium",
"value": "(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.region.oraclecloud.com))(connect_data=(service_name=unique_id_databasename_medium.adwc.oraclecloud.com))(security=(ssl_server_cert_dn="CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US")))",
"consumerGroup": "MEDIUM",
"protocol": "TCPS",
"tlsAuthentication": "MUTUAL",
"hostFormat": "FQDN",
"sessionMode": "DIRECT",
"syntaxFormat": "LONG"
}
],
"dedicated": null,
"high": "adb.region.oraclecloud.com:1522/unique_id_databasename_high.adwc.oraclecloud.com",
"low": "adb.region.oraclecloud.com:1522/unique_id_databasename_low.adwc.oraclecloud.com",
"medium": "adb.region.oraclecloud.com:1522/unique_id_databasename_medium.adwc.oraclecloud.com"
}
AutonomousDatabaseConnectionUrls
AutonomousDatabaseConsoleTokenDetails
The token that allows the OCI Console to access the Autonomous Database Service Console.
AutonomousDatabaseDataguardAssociation
The properties that define dataguard association between two different Autonomous Databases. Note that Autonomous Databases inherit DataGuard association from parent Autonomous Container Database. No actions can be taken on AutonomousDatabaseDataguardAssociation, usage is strictly informational.
AutonomousDatabaseEncryptionKeyDetails
Details of the Autonomous Database encryption key.
AutonomousDatabaseEncryptionKeyDetailsModelConverter
AutonomousDatabaseEncryptionKeyHistoryEntry
The Autonomous Database encryption key history entry.
AutonomousDatabaseKeyHistoryEntry
The Autonomous Database Vault service key management history entry.
AutonomousDatabaseManualRefreshDetails
Details of manual refresh for an Autonomous Database refreshable clone.
AutonomousDatabasePeerCollection
The object holds details about the peer Autonomous Databases for an Oracle Autonomous Database.
AutonomousDatabasePeerSummary
The object holds details about a peer Autonomous Database for Oracle Autonomous Database.
AutonomousDatabaseSoftwareImage
Autonomous Database Software Images created from Autonomous Container Database
AutonomousDatabaseSoftwareImageCollection
Result of List Autonomous Database Software Images.
AutonomousDatabaseSoftwareImageSummary
The Database service supports the creation of Autonomous Database Software Images for use in creating Autonomous Container Database.
AutonomousDatabaseStandbySummary
Autonomous Data Guard standby database details.
AutonomousDatabaseSummary
An Oracle Autonomous Database.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
AutonomousDatabaseWallet
The Autonomous Database wallet details.
AutonomousDbPreviewVersionSummary
The Autonomous Database preview version. Note that preview version software is only available for Autonomous Database Serverless instances.
AutonomousDbVersionSummary
The supported Autonomous Database version.
AutonomousExadataInfrastructure
AutonomousExadataInfrastructureShapeSummary
The shape of the Autonomous Exadata Infrastructure. The shape determines resources to allocate to the Autonomous Exadata Infrastructure (CPU cores, memory and storage).
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator.
If you're an administrator who needs to write policies to give users access,
see Getting Started with Policies.
AutonomousExadataInfrastructureSummary
Deprecated These APIs are deprecated with the introduction of the Autonomous Exadata VM Cluster resource and a shift to a common Exadata Infrastructure resource for all Exadata Cloud-based services, including Autonomous Database on dedicated Exadata infrastructure. For more details, see Latest Resource Model.
Infrastructure that enables the running of multiple Autonomous Databases within a dedicated DB system.
For more information about Autonomous Exadata Infrastructure, see
Oracle Autonomous Database.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
For information about access control and compartments, see
Overview of the Identity Service.
For information about availability domains, see
Regions and Availability Domains.
To get a list of availability domains, use the ListAvailabilityDomains operation
in the Identity service API.
AutonomousPatch
AutonomousPatchSummary
A patch for an Autonomous Exadata Infrastructure or Autonomous Container Database.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
talk to an administrator. If you're an administrator who needs to write policies to give users access,
see Getting Started with Policies.
AutonomousVirtualMachine
Autonomous Virtual Machine details.
AutonomousVirtualMachineSummary
Details of the Autonomous Virtual Machine.
AutonomousVmCluster
Details of the Autonomous VM cluster.
AutonomousVmClusterResourceDetails
Unallocated resource details of the AVM
AutonomousVmClusterResourceUsage
Autonomous VM Cluster usage details, including the Autonomous Container Databases usage.
AutonomousVmClusterSummary
Details of the Autonomous VM cluster.
AutonomousVmResourceUsage
Autonomous VM usage statistics.
AvmAcdResourceStats
Associated autonomous container databases usages.
AwsKeyDetails
Details for AWS encryption key.
AzureKeyDetails
Details for Azure encryption key.
Backup
BackupDestination
Backup destination details.
BackupDestinationDetails
Backup destination details
BackupDestinationSummary
Backup destination details, including the list of databases using the backup destination.
BackupSummary
A database backup.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CancelExecutionWindowDetails
Describe the parameters to create a new execution window after this execution window is canceled.
ChangeAutonomousDatabaseSoftwareImageCompartmentDetails
The configuration details for moving the resource.
ChangeAutonomousDatabaseSubscriptionDetails
The configuration details for associating the Autonomous Database with a different subscription.
ChangeAutonomousVmClusterCompartmentDetails
The configuration details for moving the Autonomous VM cluster.
ChangeCloudAutonomousVmClusterCompartmentDetails
The configuration details for moving the cloud Autonomous VM cluster.
ChangeCloudExadataInfrastructureCompartmentDetails
The configuration details for moving the cloud Exadata infrastructure resource to another compartment. Applies to Exadata Cloud Service instances only.
ChangeCloudExadataInfrastructureSubscriptionDetails
The configuration details for associating the cloud Exadata infrastructure resource with a different subscription.
ChangeCloudVmClusterCompartmentDetails
The configuration details for moving the cloud VM cluster to another compartment. Applies to Exadata Cloud Service instances only.
ChangeCloudVmClusterSubscriptionDetails
The configuration details for associating the cloud VM cluster resource with a different subscription.
ChangeCompartmentDetails
The configuration details for moving the resource.
ChangeDataguardRoleDetails
The configuration details for change Autonomous Container Database Dataguard role
ChangeDisasterRecoveryConfigurationDetails
Details to update the cross-region disaster recovery (DR) details of the standby Autonomous Database Serverless instance.
ChangeExadataInfrastructureCompartmentDetails
The configuration details for moving the resource.
ChangeExadbVmClusterCompartmentDetails
The configuration details for moving the Exadata VM cluster on Exascale Infrastructure to another compartment. Applies to Exadata Database Service on Exascale Infrastructure only.
ChangeExascaleDbStorageVaultCompartmentDetails
The configuration details for moving the Exadata Database Storage Vault to another compartment.
ChangeKeyStoreCompartmentDetails
The configuration details for moving the key store.
ChangeKeyStoreTypeDetails
Request details to change the source of the encryption key for the database.
ChangeSchedulingPlanCompartmentDetails
The configuration details for moving the Scheduling Plan.
ChangeSchedulingPolicyCompartmentDetails
The configuration details for moving the Scheduling Policy.
ChangeSubscriptionDetails
The configuration details for associating the resource with a different subscription.
ChangeVmClusterCompartmentDetails
The configuration details for moving the VM cluster.
CloudAutomationApplyUpdateTimePreference
Configure the time slot for applying VM cloud automation software updates to the cluster. When nothing is selected, the default time slot is 12 AM to 2 AM UTC. Any 2-hour slot is available starting at 12 AM.
CloudAutomationFreezePeriod
Enables a freeze period for the VM cluster prohibiting the VMs from getting cloud automation software updates during critical business cycles. Freeze period start date. Starts at 12:00 AM UTC on the selected date and ends at 11:59:59 PM UTC on the selected date. Validates to ensure the freeze period does not exceed 45 days.
CloudAutomationUpdateDetails
Specifies the properties necessary for cloud automation updates. This includes modifying the apply update time preference, enabling or disabling early adoption, and enabling, modifying, or disabling the update freeze period.
CloudAutonomousVmCluster
Details of the cloud Autonomous VM cluster.
CloudAutonomousVmClusterResourceDetails
Unallocated resource details of the Cloud Autonomous VM Cluster.
CloudAutonomousVmClusterResourceUsage
Cloud Autonomous VM Cluster usage details, including the Autonomous Container Databases usage.
CloudAutonomousVmClusterSummary
Details of the cloud Autonomous VM cluster.
CloudDatabaseManagementConfig
The configuration of the Database Management service.
CloudDbServerDetails
Details of the ExaDB-D DB server. Applies to Exadata Cloud instances only.
CloudExadataInfrastructure
Details of the cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances only.
CloudExadataInfrastructureSummary
Details of the cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances only.
CloudExadataInfrastructureUnallocatedResources
Details of unallocated resources of the Cloud Exadata infrastructure. Applies to Cloud Exadata infrastructure instances only.
CloudVmCluster
Details of the cloud VM cluster. Applies to Exadata Cloud Service instances only.
CloudVmClusterSummary
Details of the cloud VM cluster. Applies to Exadata Cloud Service instances only.
CompleteExternalBackupJobDetails
ComputePerformanceSummary
Parameters detailing the compute performance for a specified DB system shape.
ConfigureAutonomousDatabaseVaultKeyDetails
Configuration details for the Autonomous Database vault key.
ConfigureSaasAdminUserDetails
Details to update SaaS administrative user configuration.
ConsoleConnection
ConsoleConnectionSummary
The InstanceConsoleConnection
API provides you with console access to dbnode
enabling you to troubleshoot malfunctioning dbnode.
ConsoleHistory
The details of the Db Node console history.
ConsoleHistoryCollection
Results of the Db Node console history lists. Contains ConsoleHistorySummary items.
ConsoleHistorySummary
The details of the Db Node console history.
ConvertToPdbDetails
Details for converting a non-container database to pluggable database.
ConvertToPdbTargetBase
Details of the container database in which the converted pluggable database will be located.
ConvertToPdbTargetBaseModelConverter
ConvertToRegularPluggableDatabaseDetails
Parameters for converting Refreshable Clone Pluggable Database into Regular Pluggable Database.
CreateApplicationVipDetails
Details to create an application virtual IP (VIP) address on a cloud VM cluster.
CreateAutonomousContainerDatabaseDataguardAssociationDetails
Create Autonomous Dataguard Association to an existing Autonomous Container Database
CreateAutonomousContainerDatabaseDetails
Describes the required parameters for the creation of an Autonomous Container Database.
CreateAutonomousDatabaseBackupDetails
Details to create an Oracle Autonomous Database backup.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateAutonomousDatabaseBase
Details to create an Oracle Autonomous Database.
Notes:
- To specify OCPU core count, you must use either
ocpuCount
orcpuCoreCount
. You cannot use both parameters at the same time. For Autonomous Database Serverless instances,ocpuCount
is not used. - To specify a storage allocation, you must use either
dataStorageSizeInGBs
ordataStorageSizeInTBs
. - See the individual parameter discriptions for more information on the OCPU and storage value parameters.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateAutonomousDatabaseBaseModelConverter
CreateAutonomousDatabaseCloneDetails
Details to create an Oracle Autonomous Database by cloning an existing Autonomous Database.
CreateAutonomousDatabaseDetails
Details to create an Oracle Autonomous Database.
CreateAutonomousDatabaseFromBackupDetails
Details to create an Oracle Autonomous Database by cloning from a backup of an existing Autonomous Database.
CreateAutonomousDatabaseFromBackupTimestampDetails
Details to create a point-in-time clone of an Oracle Autonomous Database by specifying a timestamp. Point-in-time clones use backups as the source of the data for the clone.
CreateAutonomousDatabaseSoftwareImageDetails
Parameters for creating a Autonomous Database Software Image
CreateAutonomousVmClusterDetails
Details for the create Autonomous VM cluster operation.
CreateBackupDestinationDetails
Details for creating a backup destination.
CreateBackupDestinationDetailsModelConverter
CreateBackupDetails
Details for creating a database backup.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateCloudAutonomousVmClusterDetails
Details for the create cloud Autonomous VM cluster operation.
CreateCloudExadataInfrastructureDetails
Request to create cloud Exadata infrastructure. Applies to Exadata Cloud Service instances only.
CreateCloudVmClusterDetails
Details for the create cloud VM cluster operation. Applies to Exadata Cloud Service instances only.
CreateConsoleConnectionDetails
The details for creating a Db node console connection. The Db node console connection is created in the same compartment as the dbNode.
CreateConsoleHistoryDetails
The details for creating a Db node console history. The Db node console history is created in the same compartment as the dbNode.
CreateCrossRegionAutonomousDatabaseDataGuardDetails
Details to create an Autonomous Data Guard association for an existing Autonomous Database where the standby is in a different (remote) region from the source primary database. IMPORTANT Note the following for creating standby databases in cross-region Autonomous Data Guard associations:
- To create your standby database in a region different from the region of the primary, use the API endpoint of the region in which the standby will be located. For example, if the primary database is in the IAD region, and you want to create the standby in the PHX region, make the API call using the PHX endpoint (https://database.us-phoenix-1.oraclecloud.com). See API Endpoints for the list of Database Service API endpoints.
- In the request to create the standby database, the
sourceId
value should be the OCID of the primary database. The following parameters are optional for the cross-region standby database. If included in the request, these parameters contain the same values as the source Autonomous Database: - customerContacts
- scheduledOperations
- isAutoScalingForStorageEnabled
- definedTags
- freeformTags
- licenseModel
- whitelistedIps
- isMtlsConnectionRequired
- dbName
- adminPassword
- cpuCoreCount
- dataStorageSizeInTB
- dbVersion
CreateCrossRegionDisasterRecoveryDetails
The following are the details necessary to create a disaster recovery (DR) association for an existing Autonomous Database with a standby in a remote region. IMPORTANT For creating a standby databases in a cross-region DR association:
- To create the standby database in a remote region, use the API endpoint in the region where the standby is located. For example, if the primary database is in the IAD region and the standby is in the PHX region, make the API call using the PHX endpoint (https://database.us-phoenix-1.oraclecloud.com). See API Endpoints for the list of Database Service API endpoints.
- To create the request in the standby database, the sourceId value must be the OCID of the primary database. The following parameters are required for the cross-region standby database and must contain the same values as the source Autonomous Database:
- remoteDisasterRecoveryType The following parameters are optional for the cross-region standby database. If included in the request, these parameters must contain the same values as the source Autonomous Database:
- dbName
- dbVersion
- ecpuCount
- dataStorageSizeInTB
- customerContacts
- scheduledOperations
- isAutoScalingForStorageEnabled
- definedTags
- freeformTags
- licenseModel
- whitelistedIps
- isMtlsConnectionRequired
CreateCrossTenancyDisasterRecoveryDetails
The following are the details necessary to create a cross-tenancy disaster recovery (DR) association for an existing Autonomous Database. This may be in the same region, or in another. IMPORTANT For creating a standby databases in a cross-tenancy local DR association:
- To create the standby database in different tenancy, use the compartment OCID in the tenancy where the standby is located.
- To create the request in the standby database, the sourceId value must be the OCID of the primary database.
- Creating a ADG DR in the same tenancy and region is not allowed. Use changeDisasterRecoveryConfiguration instead. The following parameters are required for the cross-tenancy standby database
- disasterRecoveryType The following parameters are optional for the cross-tenancy standby database. If included in the request, these parameters must contain the same values as the source Autonomous Database:
- dbName
- dbVersion
- ecpuCount
- dataStorageSizeInTB
- customerContacts
- scheduledOperations
- isAutoScalingForStorageEnabled
- definedTags
- freeformTags
- licenseModel
- whitelistedIps
- isMtlsConnectionRequired
CreateDataGuardAssociationDetails
The configuration details for creating a Data Guard association between databases.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateDataGuardAssociationDetailsModelConverter
CreateDataGuardAssociationToExistingDbSystemDetails
The configuration details for creating a Data Guard association for a bare metal or Exadata DB system database. For these types of DB system databases, the creationType
should be ExistingDbSystem
. A standby database will be created in the DB system you specify.
To create a Data Guard association for a database in a virtual machine DB system, use the {@link #createDataGuardAssociationWithNewDbSystemDetails(CreateDataGuardAssociationWithNewDbSystemDetailsRequest) createDataGuardAssociationWithNewDbSystemDetails} subtype instead.
CreateDataGuardAssociationToExistingVmClusterDetails
The configuration details for creating a Data Guard association for a ExaCC Vmcluster database. For these types of vm cluster databases, the creationType
should be ExistingVmCluster
. A standby database will be created in the VM cluster you specify.
CreateDataGuardAssociationWithNewDbSystemDetails
The configuration details for creating a Data Guard association for a virtual machine DB system database. For this type of DB system database, the creationType
should be NewDbSystem
. A new DB system will be launched to create the standby database.
To create a Data Guard association for a database in a bare metal or Exadata DB system, use the {@link #createDataGuardAssociationToExistingDbSystemDetails(CreateDataGuardAssociationToExistingDbSystemDetailsRequest) createDataGuardAssociationToExistingDbSystemDetails} subtype instead.
CreateDatabaseBase
Details for creating a database.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateDatabaseBaseModelConverter
CreateDatabaseDetails
Details for creating a database.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateDatabaseFromAnotherDatabaseDetails
CreateDatabaseFromBackup
Details for creating a database by restoring from a database backup.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateDatabaseFromBackupDetails
CreateDatabaseFromDbSystemDetails
Details for creating a database by restoring from a source database system.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateDatabaseSoftwareImageDetails
Parameters for creating a database software image in the specified compartment.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateDbHomeBase
Details for creating a Database Home.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateDbHomeBaseModelConverter
CreateDbHomeDetails
Details for creating a Database Home.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateDbHomeFromBackupDetails
Details for creating a Database Home if you are creating a database by restoring from a database backup.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateDbHomeFromDatabaseDetails
Details for creating a Database Home if you are creating a database by restoring from a database backup.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateDbHomeFromDbSystemDetails
Details for creating a Database Home if you are cloning a database from a another database system.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateDbHomeWithDbSystemIdDetails
Note that a valid dbSystemId
value must be supplied for the CreateDbHomeWithDbSystemId
API operation to successfully complete.
CreateDbHomeWithDbSystemIdFromBackupDetails
Note that a valid dbSystemId
value must be supplied for the CreateDbHomeWithDbSystemIdFromBackup
API operation to successfully complete.
CreateDbHomeWithDbSystemIdFromDatabaseDetails
Note that a valid dbSystemId
value must be supplied for the CreateDbHomeWithDbSystemIdFromDatabase
API operation to successfully complete.
CreateDbHomeWithVmClusterIdDetails
Note that a valid vmClusterId
value must be supplied for the CreateDbHomeWithVmClusterId
API operation to successfully complete.
CreateDbHomeWithVmClusterIdFromBackupDetails
Note that a valid vmClusterId
value must be supplied for the CreateDbHomeWithVmClusterIdFromBackup
API operation to successfully complete.
CreateExadataInfrastructureDetails
Request to create Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only. See {@link #createCloudExadataInfrastructureDetails(CreateCloudExadataInfrastructureDetailsRequest) createCloudExadataInfrastructureDetails} for information on creating a cloud Exadata infrastructure resource in an Exadata Cloud Service instance.
CreateExadbVmClusterDetails
Details for the create Exadata VM cluster on Exascale Infrastructure operation. Applies to Exadata Database Service on Exascale Infrastructure only.
CreateExascaleDbStorageVaultDetails
Details to create a Exadata Database Storage Vault.
CreateExecutionActionDetails
Request to create execution action resource.
CreateExecutionWindowDetails
Request to create an execution window resource under an execution resource.
CreateExternalBackupJobDetails
CreateExternalContainerDatabaseDetails
Details for creating an external container database resource.
CreateExternalDatabaseConnectorDetails
Details for creating an external database connector resource.
CreateExternalDatabaseConnectorDetailsModelConverter
CreateExternalDatabaseDetailsBase
Details for creating an external database.
CreateExternalMacsConnectorDetails
Details for creating a resource used to connect to an external Oracle Database using the Management Agent cloud service (MACS).
CreateExternalNonContainerDatabaseDetails
Details for creating an external non-container database resource.
CreateExternalPluggableDatabaseDetails
Details for creating an external pluggable database resource.
CreateKeyStoreDetails
Details for the create key store operation.
CreateMaintenanceRunDetails
Details to schedule Maintenance Run with Latest Release Update along TimeZone File Update for the specified resource.
CreateNFSBackupDestinationDetails
Used for creating NFS backup destinations.
CreateNewDatabaseDetails
Details for creating a new database.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateOneoffPatchDetails
Data to create the one-off patch for the specificed database version.
CreatePluggableDatabaseCreationTypeDetails
The Pluggable Database creation type.
Use LOCAL_CLONE_PDB
for creating a new PDB using Local Clone on Source Pluggable Database. This will Clone and starts a
pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in the READ_WRITE
openMode to
perform the clone operation.
isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure.
Use REMOTE_CLONE_PDB
for creating a new PDB using Remote Clone on Source Pluggable Database. This will Clone a pluggable
database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone
operation. The source PDB must be in the READ_WRITE
openMode when performing the clone.
For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the
target container database (CDB) to create a remote clone.
isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure.
Use RELOCATE_PDB
for relocating the Pluggable Database from Source CDB and creating it in target CDB. This will relocate a
pluggable database (PDB) to a different database from the source PDB. The source PDB must be in the READ_WRITE
openMode when
performing the relocate.
CreatePluggableDatabaseCreationTypeDetailsModelConverter
CreatePluggableDatabaseDetails
Parameters for creating a pluggable database in a specified container database (CDB).
Additional option pdbCreationTypeDetails
can be used for creating Pluggable Database using different operations, e.g. LocalClone, Remote Clone, Relocate.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreatePluggableDatabaseFromLocalCloneDetails
Specifies the creation type Local Clone.
CreatePluggableDatabaseFromRelocateDetails
Specifies the creation type Relocate.
Additional input 'dblinkUsernameand
dblinkUserPassword` can be provided for Relocate Operation.
If not provided, Backend will create a temporary user to perform Relocate operation.
CreatePluggableDatabaseFromRemoteCloneDetails
Specifies the creation type Remote Clone.
Additional input 'dblinkUsernameand
dblinkUserPassword` can be provided for RemoteClone/Create RefreshableClone Operation.
If not provided, Backend will create a temporary user to perform RemoteClone operation. It is a required input parameter in case of creating Refreshable Clone PDB.
CreatePluggableDatabaseRefreshableCloneDetails
Parameters for creating Pluggable Database Refreshable Clone. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
CreateRecoveryApplianceBackupDestinationDetails
Used for creating Recovery Appliance backup destinations.
CreateRefreshableAutonomousDatabaseCloneDetails
Details to create an Oracle Autonomous Database refreshable clone.
CreateScheduledActionDetails
Request to create Scheduled Action resource.
CreateSchedulingPlanDetails
Request to create Scheduling Plan.
CreateSchedulingPolicyDetails
Request to create Scheduling Policy resource with Maintenance windows per cadence.
CreateSchedulingWindowDetails
Request to create Scheduling Window resource.
CreateVmClusterDetails
Details for the create Exadata VM cluster operation. Applies to Exadata Cloud@Customer instances only. For details on the create cloud Exadata VM cluster operation used with Exadata Cloud Service instances, see {@link #createCloudVmClusterDetails(CreateCloudVmClusterDetailsRequest) createCloudVmClusterDetails}
CustomerContact
Customer contact information that will be used by Oracle to provide notifications needed by database and infrastructure administrators.
DataCollectionOptions
Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
DataGuardAssociation
DataGuardAssociationSummary
The properties that define a Data Guard association.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an
administrator. If you're an administrator who needs to write policies to give users access, see
Getting Started with Policies.
For information about endpoints and signing API requests, see
About the API. For information about available SDKs and tools, see
SDKS and Other Tools.
Database
DatabaseConnectionCredentials
Credentials used to connect to the database. Currently only the DETAILS
type is supported for creating MACS connector crendentials.
DatabaseConnectionCredentialsByDetails
User information to connect to the database. Required when performing the {@link #createExternalDatabaseConnectorDetails(CreateExternalDatabaseConnectorDetailsRequest) createExternalDatabaseConnectorDetails} operation. IMPORTANT: Not supported for the {@link #updateExternalDatabaseConnectorDetails(UpdateExternalDatabaseConnectorDetailsRequest) updateExternalDatabaseConnectorDetails} operation.
DatabaseConnectionCredentialsByName
Existing named credential used to connect to the database.
DatabaseConnectionCredentialsModelConverter
DatabaseConnectionString
The Oracle Database connection string.
DatabaseConnectionStringProfile
The connection string profile to allow clients to group, filter and select connection string values based on structured metadata.
DatabaseConnectionStrings
Connection strings to connect to an Oracle Database.
DatabaseCredentialDetails
Data for the credential used to connect to the database.
DatabaseManagementConfig
The configuration of the Database Management service.
DatabaseSoftwareImage
Database software images are created by specifying a patch set, one-off patches and patches for the database home (listed by ls inventory
).
DatabaseSoftwareImageSummary
The Database service supports the creation of database software images for use in creating and patching DB systems and databases.
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.
For information about access control and compartments, see Overview of the Identity Service.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
DatabaseSslConnectionCredentials
Ssl connection credential details used to connect to the database.
DatabaseSummary
An Oracle Database on a bare metal or virtual machine DB system. For more information, see Bare Metal and Virtual Machine DB Systems.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
DatabaseTool
Summary of database tools of autonomous database.
DatabaseUpgradeHistoryEntry
The Database service supports the upgrade history of databases.
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.
For information about access control and compartments, see
Overview of the Identity Service.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
DatabaseUpgradeHistoryEntrySummary
The Database service supports the upgrade history of databases.
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.
For information about access control and compartments, see
Overview of the Identity Service.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
DatabaseUpgradeSourceBase
Details for the database upgrade source.
DatabaseUpgradeSourceBaseModelConverter
DatabaseUpgradeWithDatabaseSoftwareImageDetails
Details of the database software image to be used to upgrade a database.
DatabaseUpgradeWithDbHomeDetails
Details of Database Home to be used to upgrade a database.
DatabaseUpgradeWithDbVersionDetails
Details of the Oracle Database software version number for upgrading a database.
DayOfWeek
Day of the week.
DbBackupConfig
Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
DbHome
DbHomeFromAgentResourceId
DbHomeSummary
A directory where Oracle Database software is installed. A bare metal or Exadata DB system can have multiple Database Homes
and each Database Home can run a different supported version of Oracle Database. A virtual machine DB system can have only one Database Home.
For more information, see Bare Metal and Virtual Machine DB Systems and Exadata DB Systems.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an
administrator. If you're an administrator who needs to write policies to give users access,
see Getting Started with Policies.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
DbIormConfig
The IORM configuration settings for the database.
DbIormConfigUpdateDetail
Details of the IORM configuration settings update request.
DbNode
DbNodeDetails
Details of the ExaCS Db node. Applies to Exadata Database Service on Exascale Infrastructure only.
DbNodeSummary
A server where Oracle Database software is running.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
DbServer
Details of the Db server resource.
DbServerDetails
Details of the Exacc Db server. Applies to Exadata Cloud@Customer instances only.
DbServerHistorySummary
Details of a database server maintenance history.
DbServerPatchingDetails
The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
DbServerSummary
Details of the Db server.
DbSystem
DbSystemComputePerformanceSummary
Representation of disk performance detail parameters.
DbSystemOptions
The DB system options.
DbSystemShapeSummary
The shape of the DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator.
If you're an administrator who needs to write policies to give users access,
see Getting Started with Policies.
DbSystemStoragePerformanceSummary
Representation of storage performance summary per shapeType .
DbSystemSummary
The Database Service supports several types of DB systems, ranging in size, price, and performance. For details about
each type of system, see Bare Metal and Virtual Machine DB Systems.
Note: Deprecated for Exadata Cloud Service instances using the new resource model.
To provision and manage new Exadata Cloud Service systems, use the
{@link CloudExadataInfrastructure} and {@link CloudVmCluster}.
See Exadata Cloud Service for more information on Exadata systems.
For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model.
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.
For information about access control and compartments, see
Overview of the Identity Service.
For information about availability domains, see
Regions and Availability Domains.
To get a list of availability domains, use the ListAvailabilityDomains
operation
in the Identity Service API.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
DbSystemUpgradeHistoryEntry
The record of an OS upgrade action on a DB system.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
DbSystemUpgradeHistoryEntrySummary
The summary for the record of an OS upgrade action on a DB system.
DbVersionSummary
The Oracle Database software version.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
DefinedFileSystemConfiguration
Details of the file system configuration of the Exadata infrastructure.
DeregisterAutonomousDatabaseDataSafeDetails
Details to deregister an Autonomous Database with Data Safe.
DisasterRecoveryConfiguration
Configurations of a Disaster Recovery.
DiskPerformanceDetails
Representation of disk performance detail parameters.
DownloadOneoffPatch
Data to download one-off patch.
DrScanDetails
The Single Client Access Name (SCAN) details for Disaster recovery network.
EnableDatabaseManagementDetails
Data to enable the Database Management service for the database.
EnableExternalContainerDatabaseDatabaseManagementDetails
Details to enable Database Management on an external container database.
EnableExternalContainerDatabaseStackMonitoringDetails
Details to enable Stack Monitoring on the external container database.
EnableExternalDatabaseManagementDetailsBase
Details to enable Database Management on an external database.
EnableExternalDatabaseOperationsInsightsDetailsBase
Details to enable Operations Insights on the external database.
EnableExternalDatabaseStackMonitoringDetailsBase
Details to enable Stack Monitoring on the external database.
EnableExternalNonContainerDatabaseDatabaseManagementDetails
Details to enable Database Management on an external non-container database.
EnableExternalNonContainerDatabaseOperationsInsightsDetails
Details to enable Operations Insights on the external non-container database
EnableExternalNonContainerDatabaseStackMonitoringDetails
Details to enable Stack Monitoring on the external non-container database.
EnableExternalPluggableDatabaseDatabaseManagementDetails
Details to enable Database Management on an external pluggable database.
EnableExternalPluggableDatabaseOperationsInsightsDetails
Details to enable Operations Insights on the external pluggable database
EnableExternalPluggableDatabaseStackMonitoringDetails
Details to enable Stack Monitoring on the external pluggable database.
EnablePluggableDatabaseManagementDetails
Data to enable the Database Management service for the pluggable database.
EstimatedPatchingTime
The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching).
ExadataDbSystemMigration
Information about the Exadata DB system migration. The migration is used to move the Exadata Cloud Service instance from the DB system resource model to the new cloud Exadata infrastructure resource model.
ExadataDbSystemMigrationSummary
Information about the Exadata DB system migration. The migration is used to move the Exadata Cloud Service instance from the DB system resource model to the new cloud Exadata infrastructure resource model.
ExadataInfrastructure
ExadataInfrastructure
ExadataInfrastructureContact
Contact details for Exadata Infrastructure.
ExadataInfrastructureSummary
Details of the Exadata Cloud@Customer infrastructure. Applies to Exadata Cloud@Customer instances only. See {@link #cloudExadataInfrastructureSummary(CloudExadataInfrastructureSummaryRequest) cloudExadataInfrastructureSummary} for details of the cloud Exadata infrastructure resource used by Exadata Cloud Service instances.
ExadataInfrastructureUnAllocatedResources
Un allocated resources details of the Exadata Cloud@Customer infrastructure. Applies to Exadata Cloud@Customer instances only.
ExadataIormConfig
The IORM settings of the Exadata DB system.
ExadataIormConfigUpdateDetails
IORM Setting details for this Exadata System to be updated
ExadbVmCluster
Details of the Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.
ExadbVmClusterStorageDetails
Storage Details on the Exadata VM cluster.
ExadbVmClusterSummary
Details of the Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.
ExadbVmClusterUpdate
A maintenance update details for an Exadata VM cluster on Exascale Infrastructure.
ExadbVmClusterUpdateHistoryEntry
The record of an maintenance update action on a specified Exadata VM cluster on Exascale Infrastructure.
ExadbVmClusterUpdateHistoryEntrySummary
The record of an maintenance update action on a specified Exadata VM cluster on Exascale Infrastructure.
ExadbVmClusterUpdateSummary
A maintenance update details for an Exadata VM cluster on Exascale Infrastructure.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
talk to an administrator. If you're an administrator who needs to write policies to give users access,
see Getting Started with Policies.
ExascaleDbStorageDetails
Exadata Database Storage Details
ExascaleDbStorageInputDetails
Create exadata Database Storage Details
ExascaleDbStorageVault
Details of the Exadata Database Storage Vault.
ExascaleDbStorageVaultSummary
Details of the Exadata Database Storage Vault.
ExecutionAction
Details of an execution action.
ExecutionActionMember
The action member details.
ExecutionActionSummary
Details of an execution action.
ExecutionWindow
Details of an execution window.
ExecutionWindowSummary
Details of an execution window.
ExternalBackupJob
Provides all the details that apply to an external backup job.
ExternalContainerDatabase
An Oracle Cloud Infrastructure resource that allows you to manage an external container database.
ExternalContainerDatabaseSummary
An Oracle Cloud Infrastructure resource that allows you to manage an external Oracle container database.
ExternalDatabaseBase
A resource that allows you to manage an Oracle Database located outside of Oracle Cloud using Oracle Cloud Infrastructure's Console and APIs.
ExternalDatabaseConnector
An Oracle Cloud Infrastructure resource used to connect to an external Oracle Database. This resource stores the database connection string, user credentials, and related details that allow you to manage your external database using the Oracle Cloud Infrastructure Console and API interfaces.
ExternalDatabaseConnectorModelConverter
ExternalDatabaseConnectorSummary
An Oracle Cloud Infrastructure resource used to connect to an external Oracle Database. This resource stores the database connection string, user credentials, and related details that allow you to manage your external database using the Oracle Cloud Infrastructure Console and API interfaces.
ExternalDatabaseConnectorSummaryModelConverter
ExternalMacsConnector
An Oracle Cloud Infrastructure resource that uses the Management Agent cloud service (MACS) to connect to an external Oracle Database.
ExternalMacsConnectorSummary
An Oracle Cloud Infrastructure resource that uses the Management Agent cloud service (MACS) to connect to an external Oracle Database.
ExternalNonContainerDatabase
an external Oracle non-container database.
ExternalNonContainerDatabaseSummary
An Oracle Cloud Infrastructure external non-container database resource. This resource is used to manage a non-container database located outside of Oracle Cloud.
ExternalPluggableDatabase
an external Oracle pluggable database.
ExternalPluggableDatabaseSummary
An Oracle Cloud Infrastructure resource that allows you to manage an external pluggable database.
FailoverDataGuardAssociationDetails
The Data Guard association failover parameters.
FileSystemConfigurationDetail
Details of the file system configuration of the VM cluster.
FlexComponentCollection
Results of a FlexComponent lists. Contains FlexComponentSummary items.
FlexComponentSummary
The Flex Components for a DB system. The Flex Component determines resources to allocate to the DB system - CPU cores, memory and storage for Flex shapes.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator.
If you're an administrator who needs to write policies to give users access,
see Getting Started with Policies.
GenerateAutonomousDatabaseWalletDetails
Details to create and download an Oracle Autonomous Database wallet.
GenerateRecommendedNetworkDetails
Generates a recommended VM cluster network configuration for an Exadata Cloud@Customer system. Applies to Exadata Cloud@Customer instances only.
GiMinorVersionSummary
The Oracle Grid Infrastructure (GI) minor version.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
GiVersionSummary
The Oracle Grid Infrastructure (GI) version.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
GranularMaintenanceHistoryDetails
Details of a granular maintenance history.
InfoForNetworkGenDetails
Parameters for generation of the client or backup network in a VM cluster network in an Exadata Cloud@Customer system.
InfrastructureTargetVersion
Infrastructure target version details.
InfrastructureTargetVersionSummary
The target Exadata Infrastructure system software version for an infrastructure resource. Applies to Exadata Cloud@Customer and Exadata Cloud instances only.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
talk to an administrator. If you're an administrator who needs to write policies to give users access,
see Getting Started with Policies.
KeyStore
A key store to connect to an on-premise encryption key appliance like Oracle Key Vault.
KeyStoreAssociatedDatabaseDetails
The databases associated with a key store
KeyStoreSummary
Details of the Key Store.
KeyStoreTypeDetails
Key store type details.
KeyStoreTypeDetailsModelConverter
KeyStoreTypeFromOracleKeyVaultDetails
Details for Oracle Key Vault
LaunchAutonomousExadataInfrastructureDetails
Describes the input parameters to launch a new Autonomous Exadata Infrastructure.
LaunchDbSystemBase
Parameters for provisioning a bare metal, virtual machine, or Exadata DB system.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
LaunchDbSystemBaseModelConverter
LaunchDbSystemDetails
Used for creating a new DB system. Does not use backups or an existing database for the creation of the initial database.
LaunchDbSystemFromBackupDetails
Used for creating a new DB system from a database backup.
LaunchDbSystemFromDatabaseDetails
Used for creating a new DB system from a database, including archived redo log data.
LaunchDbSystemFromDbSystemDetails
Used for creating a new database system by cloning an existing DB system.
LocalClonePluggableDatabaseDetails
Deprecated. Use {@link #createPluggableDatabaseDetails(CreatePluggableDatabaseDetailsRequest) createPluggableDatabaseDetails} for Pluggable Database LocalClone Operation.
Parameters for cloning a pluggable database (PDB) within the same database (CDB).
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
LongTermBackUpScheduleDetails
Details for the long-term backup schedule.
MaintenanceRun
Details of a maintenance run.
MaintenanceRunHistory
Details of a maintenance run history.
MaintenanceRunHistorySummary
Details of a maintenance run history.
MaintenanceRunSummary
Details of a maintenance run.
MaintenanceWindow
The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
MigrateVaultKeyDetails
Details for replacing existing Oracle-managed keys with customer-managed Vault service keys and vice-versa is not supported.
ModifyDatabaseManagementDetails
Data to update one or more attributes of the Database Management configuration for the database.
ModifyPluggableDatabaseManagementDetails
Data to update one or more attributes of the Database Management configuration for the pluggable database.
Month
Month of the year.
MountTypeDetails
Mount type details for backup destination.
MountTypeDetailsModelConverter
MoveExecutionActionMemberDetails
Request to move an execution action member to an execution action resource from another.
NetworkBondingModeDetails
Details of bonding mode for Client and Backup and DR networks of an Exadata infrastructure.
NodeDetails
Node details associated with a network.
OCPUs
The details of the available and consumed CPU cores of the Autonomous Exadata Infrastructure instance, including consumption by database workload type.
OciKeyDetails
Details for OCI encryption key.
OciProviderSetKeyVersionDetails
Used for setting KMS key versions
OkvKeyDetails
Details for OKV encryption key.
OneoffPatch
One-off patches are created by specifying a database version, releaseUpdate and one-off patch number.
OneoffPatchSummary
An Oracle one-off patch for a specified database version.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
OperationsInsightsConfig
The configuration of Operations Insights for the external database
OracleManagedKeyDetails
Details for Oracle-managed encryption key.
Patch
PatchDetails
The details about what actions to perform and using what patch to the specified target. This is part of an update request that is applied to a version field on the target such as DB system, Database Home, etc.
PatchHistoryEntry
PatchHistoryEntrySummary
The record of a patch action on a specified target.
PatchSummary
A Patch for a DB system or DB Home.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
talk to an administrator. If you're an administrator who needs to write policies to give users access,
see Getting Started with Policies.
PdbConversionHistoryEntry
Details of operations performed to convert a non-container database to pluggable database.
PdbConversionHistoryEntrySummary
Details of operations performed to convert a non-container database to pluggable database.
PdbConversionToNewDatabaseDetails
Details of the new container database in which the converted pluggable database will be located.
PeerAutonomousContainerDatabaseBackupConfig
Backup options for the standby Autonomous Container Database.
PluggableDatabase
A pluggable database (PDB) is portable collection of schemas, schema objects, and non-schema objects that appears to an Oracle client as a non-container database. To use a PDB, it needs to be plugged into a CDB.
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to a tenancy administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
PluggableDatabaseConnectionStrings
Connection strings to connect to an Oracle Pluggable Database.
PluggableDatabaseManagementConfig
The configuration of the Pluggable Database Management service.
PluggableDatabaseNodeLevelDetails
Pluggable Database Node Level Details.
PluggableDatabaseRefreshableCloneConfig
Pluggable Database Refreshable Clone Configuration.
PluggableDatabaseSummary
A pluggable database (PDB) is portable collection of schemas, schema objects, and non-schema objects that appears to an Oracle client as a non-container database. To use a PDB, it needs to be plugged into a CDB.
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to a tenancy administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
RecommendedScheduledActionSummary
Details of the scheduled action that is used in getRecommendedScheduledActions.
RecommendedScheduledActionsCollection
A list of scheduled actions. Contains RecommendedScheduledAction items.
RefreshableCloneCollection
A list of Autonomous Database RefreshableClone containing RefreshableCloneSummary items.
RefreshableCloneSummary
An Autonomous Database refreshable clone
RegisterAutonomousDatabaseDataSafeDetails
Details for registering an Autonomous Database with Data Safe.
ReinstateDataGuardAssociationDetails
The Data Guard association reinstate parameters.
RemoteClonePluggableDatabaseDetails
Deprecated. Use {@link #createPluggableDatabaseDetails(CreatePluggableDatabaseDetailsRequest) createPluggableDatabaseDetails} for Pluggable Database RemoteClone Operation.
Parameters for cloning a pluggable database (PDB) in a remote database (CDB). A remote CDB is one that does not contain the source PDB.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
RemoveVirtualMachineFromCloudVmClusterDetails
Details of removing Virtual Machines from the Cloud VM Cluster. Applies to Exadata Cloud instances only.
RemoveVirtualMachineFromExadbVmClusterDetails
Details of removing Virtual Machines from the Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.
RemoveVirtualMachineFromVmClusterDetails
Details of removing Virtual Machines from the VM Cluster. Applies to Exadata Cloud@Customer instances only.
ReorderExecutionActionDetails
Describes the ordering list of execution actions for the execution window.
ReorderScheduledActionsDetails
Describes the re-order parameters for the Scheduled Action resources.
ResizeVmClusterNetworkDetails
Details of Db server network nodes to extend or shrink the VM cluster network. Applies to Exadata Cloud@Customer instances only.
ResourcePoolShapeCollection
Results of an Autonomous Database resouce pool shape collection that contains ResourcePoolShapeSummary items.
ResourcePoolShapeSummary
An Autonomous Database Resource Pool. This object provides all the information related to the resource pool.
ResourcePoolSummary
The configuration details for resource pool
RestoreAutonomousDatabaseDetails
Details to restore an Oracle Autonomous Database.
RestoreDatabaseDetails
RotateAutonomousVmClusterOrdsCertsDetails
The details for configuring the SSL certificates on Autonomous VM Cluster
RotateAutonomousVmClusterSslCertsDetails
Details for configuring the ORDS certificates on Autonomous Exadata VM Cluster
RotateCloudAutonomousVmClusterOrdsCertsDetails
The details for configuring the ORDS certificates on Cloud Autonomous VM Cluster
RotateCloudAutonomousVmClusterSslCertsDetails
The details for configuring the SSL certificates on Cloud Autonomous VM Cluster
SaasAdminUserConfiguration
SaaS administrative user configuration.
SaasAdminUserStatus
SaaS administrative user status.
ScanDetails
The Single Client Access Name (SCAN) details.
ScheduledAction
Details of a Scheduled Action.
ScheduledActionCollection
Results of Scheduled Action resources lists. Contains ScheduledActionSummary items.
ScheduledActionSummary
Details of a scheduled action.
ScheduledOperationDetails
Details of scheduled operation.
SchedulingPlan
Details of a Scheduling Plan.
SchedulingPlanCollection
Results of Scheduling Plan resources lists. Contains ScheduledActionSummary items.
SchedulingPlanSummary
Details of a Scheduling Plan.
SchedulingPolicy
Details of a Scheduling Policy.
SchedulingPolicySummary
Details of a Scheduling Policy.
SchedulingWindow
Details of a Scheduling Window.
SchedulingWindowSummary
Details of a Scheduling Window.
SelfMountDetails
Used for creating NFS Self mount backup destinations for non-autonomous ExaCC.
SetKeyVersionDetails
Updating the database key version
SetKeyVersionDetailsModelConverter
StackMonitoringConfig
The configuration of Stack Monitoring for the external database.
StoragePerformanceDetails
Representation of storage performance detail parameters.
SwitchoverDataGuardAssociationDetails
The Data Guard association switchover parameters.
SystemVersionCollection
Results of the System version lists. Contains SystemVersionSummary items.
SystemVersionSummary
List of compatible Exadata system versions for a given shape and GI version.
UndeleteAutonomousDatabaseDetails
Details to undelete an Oracle Autonomous Database.
Update
UpdateAutonomousContainerDatabaseDataGuardAssociationDetails
The configuration details for updating a Autonomous Container DatabaseData Guard association for a Autonomous Container Database.
UpdateAutonomousContainerDatabaseDetails
Describes the modification parameters for the Autonomous Container Database.
UpdateAutonomousDatabaseBackupDetails
Details for updating the Autonomous Database backup.
Warning: Oracle recommends avoiding using confidential information when you supply string values using the API.
UpdateAutonomousDatabaseDetails
Details to update an Oracle Autonomous Database.
Notes
- To specify OCPU core count, you must use either
ocpuCount
orcpuCoreCount
. You cannot use both parameters at the same time. For Autonomous Database Serverless instances,ocpuCount
is not used. - To specify a storage allocation, you must use either
dataStorageSizeInGBs
ordataStorageSizeInTBs
. - See the individual parameter discriptions for more information on the OCPU and storage value parameters. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
UpdateAutonomousDatabaseSoftwareImageDetails
Describes the parameters for updating the Autonomous Database Software Image
UpdateAutonomousDatabaseWalletDetails
Details to update an Autonomous Database wallet.
UpdateAutonomousExadataInfrastructureDetails
Describes the modification parameters for the Autonomous Exadata Infrastructure.
UpdateAutonomousVmClusterDetails
Details for updating the Autonomous VM cluster.
UpdateBackupDestinationDetails
For a RECOVERY_APPLIANCE backup destination, used to update the connection string and/or the list of VPC users. For an NFS backup destination, there are 2 mount types - Self mount used for non-autonomous ExaCC and automated mount used for autonomous on ExaCC.
UpdateCloudAutonomousVmClusterDetails
Details for updating the cloud Autonomous VM cluster.
UpdateCloudExadataInfrastructureDetails
Updates the cloud Exadata infrastructure. Applies to Exadata Cloud Service instances only.
UpdateCloudVmClusterDetails
Details for updating the cloud VM cluster. Applies to Exadata Cloud Service instances only.
UpdateConsoleConnectionDetails
The details for updating a Db node console connection.
UpdateConsoleHistoryDetails
The details for updating a Db node console history.
UpdateDataGuardAssociationDetails
The configuration details for updating a Data Guard association for a database.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
UpdateDatabaseDetails
Details to update a database.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
UpdateDatabaseSoftwareImageDetails
Describes the parameters for updating the Database Software Image
UpdateDbHomeDetails
Describes the modification parameters for the Database Home.
UpdateDbNodeDetails
The details for updating a Db node.
UpdateDbSystemDetails
Describes the parameters for updating the DB system.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
UpdateDetails
Details specifying which maintenance update to apply to the cloud VM cluster and which actions are to be performed by the maintenance update. Applies to Exadata Cloud Service instances only.
UpdateExadataInfrastructureDetails
Updates the Exadata infrastructure. Applies to Exadata Cloud@Customer instances only. See {@link #updateCloudExadataInfrastructureDetails(UpdateCloudExadataInfrastructureDetailsRequest) updateCloudExadataInfrastructureDetails} for information on updating Exadata Cloud Service cloud Exadata infrastructure resources.
UpdateExadbVmClusterDetails
Details for updating the Exadata VM cluster on Exascale Infrastructure. Applies to Exadata Database Service on Exascale Infrastructure only.
UpdateExascaleDbStorageVaultDetails
Details for updating the Exadata Database Storage Vault.
UpdateExecutionActionDetails
Describes the modification parameters for the execution action.
UpdateExecutionWindowDetails
Describes the modification parameters for the execution window.
UpdateExternalContainerDatabaseDetails
Details for updating an external container database. This API is not currently supported.
UpdateExternalDatabaseConnectorDetails
Details for updating an external database connector.
UpdateExternalDatabaseConnectorDetailsModelConverter
UpdateExternalDatabaseDetailsBase
Details for updating an external database. This API is not currently supported.
UpdateExternalMacsConnectorDetails
Details for updating an external Management Agent cloud service (MACS) database connection.
UpdateExternalNonContainerDatabaseDetails
Details for updating an external non-container database. This API is not currently supported.
UpdateExternalPluggableDatabaseDetails
Details for updating an external pluggable database. This API is not currently supported.
UpdateHistoryEntry
UpdateHistoryEntrySummary
The record of an maintenance update action on a specified cloud VM cluster. Applies to Exadata Cloud Service instances only.
UpdateKeyStoreDetails
Details for updating the key store.
UpdateMaintenanceRunDetails
Describes the modification parameters for the maintenance run.
UpdateOneoffPatchDetails
Data to update the one-off patch.
UpdatePluggableDatabaseDetails
Details for updating a pluggable database (PDB).
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
UpdateScheduledActionDetails
Describes the modification parameters for the Scheduled Action.
UpdateSchedulingPolicyDetails
Describes the modification parameters for the Scheduling Policy.
UpdateSchedulingWindowDetails
Describes the modification parameters for the Scheduling Window.
UpdateSummary
A maintenance update for a cloud VM cluster. Applies to Exadata Cloud Service instances only.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
talk to an administrator. If you're an administrator who needs to write policies to give users access,
see Getting Started with Policies.
UpdateVmClusterDetails
Details for updating the VM cluster. Applies to Exadata Cloud@Customer instances only. For details on updating a cloud VM cluster in an Exadata Cloud Service instance, see {@link #updateCloudVmClusterDetails(UpdateCloudVmClusterDetailsRequest) updateCloudVmClusterDetails}
UpdateVmClusterNetworkDetails
Details for an Exadata VM cluster network. Applies to Exadata Cloud@Customer instances only.
UpgradeDatabaseDetails
Details for upgrading a database to a specific Oracle Database version.
UpgradeDbSystemDetails
Details for upgrading the operating system and Oracle Grid Infrastructure (GI) of a DB system.
VmCluster
Details of the VM cluster resource. Applies to Exadata Cloud@Customer instances only.
VmClusterNetwork
The VM cluster network.
VmClusterNetworkDetails
Details for an Exadata VM cluster network. Applies to Exadata Cloud@Customer instances only.
VmClusterNetworkSummary
Details of the VM cluster network. Applies to Exadata Cloud@Customer instances only.
VmClusterSummary
Details of the Exadata Cloud@Customer VM cluster.
VmClusterUpdate
A maintenance update for a VM cluster. Applies to Exadata Cloud@Customer instances only.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
talk to an administrator. If you're an administrator who needs to write policies to give users access,
see Getting Started with Policies.
VmClusterUpdateDetails
Details specifying which maintenance update to apply to the VM Cluster and which action is to be performed by the maintenance update. Applies to Exadata Cloud@Customer instances only.
VmClusterUpdateHistoryEntry
The record of a maintenance update action performed on a specified VM cluster. Applies to Exadata Cloud@Customer instances only.
VmClusterUpdateHistoryEntrySummary
The record of a maintenance update action performed on a specified VM cluster. Applies to Exadata Cloud@Customer instances only.
VmClusterUpdateSummary
A maintenance update for a VM cluster. Applies to Exadata Cloud@Customer instances only.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
talk to an administrator. If you're an administrator who needs to write policies to give users access,
see Getting Started with Policies.
VmNetworkDetails
Details of the client or backup networks in an Exadata VM cluster network. Applies to Exadata Cloud@Customer instances only.
WindowPreferenceDetail
The Single Scheduling Window details.
WorkloadType
The number of consumed OCPUs, by database workload type.