@Generated(value="OracleSDKGenerator",
comments="API Version: 20160918")
public final class UpdateAutonomousDatabaseDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Details to update an Oracle Autonomous Database.
*Notes** - To specify OCPU core count, you must use either ocpuCount or cpuCoreCount. 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 or dataStorageSizeInTBs. - 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.
Note: Objects should always be created or deserialized using the UpdateAutonomousDatabaseDetails.Builder. This model
distinguishes fields that are null because they are unset from fields that are explicitly
set to null. This is done in the setter methods of the UpdateAutonomousDatabaseDetails.Builder, which maintain a
set of all explicitly set fields called UpdateAutonomousDatabaseDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
UpdateAutonomousDatabaseDetails.Builder |
static class |
UpdateAutonomousDatabaseDetails.ComputeModel
The compute model of the Autonomous Database.
|
static class |
UpdateAutonomousDatabaseDetails.DbWorkload
The Autonomous Database workload type.
|
static class |
UpdateAutonomousDatabaseDetails.LicenseModel
The Oracle license model that applies to the Oracle Autonomous Database.
|
static class |
UpdateAutonomousDatabaseDetails.OpenMode
Indicates the Autonomous Database mode.
|
static class |
UpdateAutonomousDatabaseDetails.PermissionLevel
The Autonomous Database permission level.
|
static class |
UpdateAutonomousDatabaseDetails.RefreshableMode
The refresh mode of the clone.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
UpdateAutonomousDatabaseDetails(Integer backupRetentionPeriodInDays,
UpdateAutonomousDatabaseDetails.ComputeModel computeModel,
Integer inMemoryPercentage,
Integer localAdgAutoFailoverMaxDataLossLimit,
Integer cpuCoreCount,
LongTermBackUpScheduleDetails longTermBackupSchedule,
Boolean isDevTier,
Float computeCount,
Float ocpuCount,
Integer dataStorageSizeInTBs,
Integer dataStorageSizeInGBs,
String displayName,
Boolean isFreeTier,
String adminPassword,
String dbName,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> securityAttributes,
UpdateAutonomousDatabaseDetails.DbWorkload dbWorkload,
UpdateAutonomousDatabaseDetails.LicenseModel licenseModel,
Float byolComputeCountLimit,
Boolean isAccessControlEnabled,
List<String> whitelistedIps,
Boolean arePrimaryWhitelistedIpsUsed,
List<String> standbyWhitelistedIps,
Boolean isAutoScalingEnabled,
Boolean isRefreshableClone,
UpdateAutonomousDatabaseDetails.RefreshableMode refreshableMode,
Boolean isLocalDataGuardEnabled,
Boolean isDataGuardEnabled,
String peerDbId,
String dbVersion,
UpdateAutonomousDatabaseDetails.OpenMode openMode,
UpdateAutonomousDatabaseDetails.PermissionLevel permissionLevel,
String subnetId,
String privateEndpointLabel,
String privateEndpointIp,
List<String> nsgIds,
Integer autoRefreshFrequencyInSeconds,
Integer autoRefreshPointLagInSeconds,
Date timeOfAutoRefreshStart,
List<CustomerContact> customerContacts,
Boolean isMtlsConnectionRequired,
String resourcePoolLeaderId,
ResourcePoolSummary resourcePoolSummary,
Boolean isBackupRetentionLocked,
List<ScheduledOperationDetails> scheduledOperations,
Boolean isAutoScalingForStorageEnabled,
AutonomousDatabaseSummary.DatabaseEdition databaseEdition,
List<DatabaseTool> dbToolsDetails,
String secretId,
Integer secretVersionNumber,
AutonomousDatabaseEncryptionKeyDetails encryptionKey)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static UpdateAutonomousDatabaseDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getAdminPassword()
The password must be between 12 and 30 characters long, and must contain at least 1
uppercase, 1 lowercase, and 1 numeric character.
|
Boolean |
getArePrimaryWhitelistedIpsUsed()
This field will be null if the Autonomous Database is not Data Guard enabled or Access
Control is disabled.
|
Integer |
getAutoRefreshFrequencyInSeconds()
The frequency a refreshable clone is refreshed after auto-refresh is enabled.
|
Integer |
getAutoRefreshPointLagInSeconds()
The time, in seconds, the data of the refreshable clone lags the primary database at the
point of refresh.
|
Integer |
getBackupRetentionPeriodInDays()
Retention period, in days, for long-term backups
|
Float |
getByolComputeCountLimit()
The maximum number of CPUs allowed with a Bring Your Own License (BYOL), including those used
for auto-scaling, disaster recovery, tools, etc.
|
Float |
getComputeCount()
The compute amount (CPUs) available to the database.
|
UpdateAutonomousDatabaseDetails.ComputeModel |
getComputeModel()
The compute model of the Autonomous Database.
|
Integer |
getCpuCoreCount()
The number of CPUs to be made available to the Autonomous Database.
For Autonomous Databases on Dedicated Exadata Infrastructure: - The CPU type (OCPUs or ECPUs) is determined by the parent Autonomous Exadata VM Cluster’s compute model. |
List<CustomerContact> |
getCustomerContacts()
Customer Contacts.
|
AutonomousDatabaseSummary.DatabaseEdition |
getDatabaseEdition()
The Oracle Database Edition that applies to the Autonomous databases.
|
Integer |
getDataStorageSizeInGBs()
Applies to dedicated Exadata infrastructure only.
|
Integer |
getDataStorageSizeInTBs()
The size, in terabytes, of the data volume that will be created and attached to the database.
|
String |
getDbName()
New name for this Autonomous Database.
|
List<DatabaseTool> |
getDbToolsDetails()
The list of database tools details.
|
String |
getDbVersion()
A valid Oracle Database version for Autonomous Database.
|
UpdateAutonomousDatabaseDetails.DbWorkload |
getDbWorkload()
The Autonomous Database workload type.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
The user-friendly name for the Autonomous Database.
|
AutonomousDatabaseEncryptionKeyDetails |
getEncryptionKey() |
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
Integer |
getInMemoryPercentage()
The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous
Database.
|
Boolean |
getIsAccessControlEnabled()
Indicates if the database-level access control is enabled.
|
Boolean |
getIsAutoScalingEnabled()
Indicates whether auto scaling is enabled for the Autonomous Database CPU core count.
|
Boolean |
getIsAutoScalingForStorageEnabled()
Indicates if auto scaling is enabled for the Autonomous Database storage.
|
Boolean |
getIsBackupRetentionLocked()
True if the Autonomous Database is backup retention locked.
|
Boolean |
getIsDataGuardEnabled()
** Deprecated.
|
Boolean |
getIsDevTier()
Autonomous Database for Developers are fixed-shape Autonomous Databases that developers can
use to build and test new applications.
|
Boolean |
getIsFreeTier()
Indicates if this is an Always Free resource.
|
Boolean |
getIsLocalDataGuardEnabled()
Indicates whether the Autonomous Database has a local (in-region) standby database.
|
Boolean |
getIsMtlsConnectionRequired()
Specifies if the Autonomous Database requires mTLS connections.
|
Boolean |
getIsRefreshableClone()
Indicates if the Autonomous Database is a refreshable clone.
|
UpdateAutonomousDatabaseDetails.LicenseModel |
getLicenseModel()
The Oracle license model that applies to the Oracle Autonomous Database.
|
Integer |
getLocalAdgAutoFailoverMaxDataLossLimit()
Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to
which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard
|
LongTermBackUpScheduleDetails |
getLongTermBackupSchedule() |
List<String> |
getNsgIds()
The list of OCIDs
for the network security groups (NSGs) to which this resource belongs.
|
Float |
getOcpuCount()
The number of OCPU cores to be made available to the Autonomous Database.
|
UpdateAutonomousDatabaseDetails.OpenMode |
getOpenMode()
Indicates the Autonomous Database mode.
|
String |
getPeerDbId()
The database OCID(/Content/General/Concepts/identifiers.htm) of the Disaster Recovery peer
(source Primary) database, which is located in a different (remote) region from the current
peer database.
|
UpdateAutonomousDatabaseDetails.PermissionLevel |
getPermissionLevel()
The Autonomous Database permission level.
|
String |
getPrivateEndpointIp()
The private endpoint Ip address for the resource.
|
String |
getPrivateEndpointLabel()
The resource’s private endpoint label.
|
UpdateAutonomousDatabaseDetails.RefreshableMode |
getRefreshableMode()
The refresh mode of the clone.
|
String |
getResourcePoolLeaderId()
The unique identifier for leader autonomous database OCID
OCID.
|
ResourcePoolSummary |
getResourcePoolSummary() |
List<ScheduledOperationDetails> |
getScheduledOperations()
The list of scheduled operations.
|
String |
getSecretId()
The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID.
|
Integer |
getSecretVersionNumber()
The version of the vault secret.
|
Map<String,Map<String,Object>> |
getSecurityAttributes()
Security Attributes for this resource.
|
List<String> |
getStandbyWhitelistedIps()
The client IP access control list (ACL).
|
String |
getSubnetId()
The OCID of the
subnet the resource is associated with.
|
Date |
getTimeOfAutoRefreshStart()
The the date and time that auto-refreshing will begin for an Autonomous Database refreshable
clone.
|
List<String> |
getWhitelistedIps()
The client IP access control list (ACL).
|
int |
hashCode() |
UpdateAutonomousDatabaseDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"backupRetentionPeriodInDays","computeModel","inMemoryPercentage","localAdgAutoFailoverMaxDataLossLimit","cpuCoreCount","longTermBackupSchedule","isDevTier","computeCount","ocpuCount","dataStorageSizeInTBs","dataStorageSizeInGBs","displayName","isFreeTier","adminPassword","dbName","freeformTags","definedTags","securityAttributes","dbWorkload","licenseModel","byolComputeCountLimit","isAccessControlEnabled","whitelistedIps","arePrimaryWhitelistedIpsUsed","standbyWhitelistedIps","isAutoScalingEnabled","isRefreshableClone","refreshableMode","isLocalDataGuardEnabled","isDataGuardEnabled","peerDbId","dbVersion","openMode","permissionLevel","subnetId","privateEndpointLabel","privateEndpointIp","nsgIds","autoRefreshFrequencyInSeconds","autoRefreshPointLagInSeconds","timeOfAutoRefreshStart","customerContacts","isMtlsConnectionRequired","resourcePoolLeaderId","resourcePoolSummary","isBackupRetentionLocked","scheduledOperations","isAutoScalingForStorageEnabled","databaseEdition","dbToolsDetails","secretId","secretVersionNumber","encryptionKey"}) public UpdateAutonomousDatabaseDetails(Integer backupRetentionPeriodInDays, UpdateAutonomousDatabaseDetails.ComputeModel computeModel, Integer inMemoryPercentage, Integer localAdgAutoFailoverMaxDataLossLimit, Integer cpuCoreCount, LongTermBackUpScheduleDetails longTermBackupSchedule, Boolean isDevTier, Float computeCount, Float ocpuCount, Integer dataStorageSizeInTBs, Integer dataStorageSizeInGBs, String displayName, Boolean isFreeTier, String adminPassword, String dbName, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> securityAttributes, UpdateAutonomousDatabaseDetails.DbWorkload dbWorkload, UpdateAutonomousDatabaseDetails.LicenseModel licenseModel, Float byolComputeCountLimit, Boolean isAccessControlEnabled, List<String> whitelistedIps, Boolean arePrimaryWhitelistedIpsUsed, List<String> standbyWhitelistedIps, Boolean isAutoScalingEnabled, Boolean isRefreshableClone, UpdateAutonomousDatabaseDetails.RefreshableMode refreshableMode, Boolean isLocalDataGuardEnabled, Boolean isDataGuardEnabled, String peerDbId, String dbVersion, UpdateAutonomousDatabaseDetails.OpenMode openMode, UpdateAutonomousDatabaseDetails.PermissionLevel permissionLevel, String subnetId, String privateEndpointLabel, String privateEndpointIp, List<String> nsgIds, Integer autoRefreshFrequencyInSeconds, Integer autoRefreshPointLagInSeconds, Date timeOfAutoRefreshStart, List<CustomerContact> customerContacts, Boolean isMtlsConnectionRequired, String resourcePoolLeaderId, ResourcePoolSummary resourcePoolSummary, Boolean isBackupRetentionLocked, List<ScheduledOperationDetails> scheduledOperations, Boolean isAutoScalingForStorageEnabled, AutonomousDatabaseSummary.DatabaseEdition databaseEdition, List<DatabaseTool> dbToolsDetails, String secretId, Integer secretVersionNumber, AutonomousDatabaseEncryptionKeyDetails encryptionKey)
public static UpdateAutonomousDatabaseDetails.Builder builder()
Create a new builder.
public UpdateAutonomousDatabaseDetails.Builder toBuilder()
public Integer getBackupRetentionPeriodInDays()
Retention period, in days, for long-term backups
public UpdateAutonomousDatabaseDetails.ComputeModel getComputeModel()
The compute model of the Autonomous Database. This is required if using the computeCount parameter. If using cpuCoreCount then it is an error to specify computeModel to a non-null value. ECPU compute model is the recommended model and OCPU
compute model is legacy.
public Integer getInMemoryPercentage()
The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous Database. This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform.
public Integer getLocalAdgAutoFailoverMaxDataLossLimit()
Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard
public Integer getCpuCoreCount()
The number of CPUs to be made available to the Autonomous Database.
For Autonomous Databases on Dedicated Exadata Infrastructure: - The CPU type (OCPUs or ECPUs)
is determined by the parent Autonomous Exadata VM Cluster’s compute model. - It is suggested
to use ‘computeCount’ parameter if you want to use fractional value to provision less than 1
core.
*Note:** This parameter cannot be used with the ocpuCount or computeCount
parameter.
This cannot be updated in parallel with any of the following: licenseModel, databaseEdition, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.
public LongTermBackUpScheduleDetails getLongTermBackupSchedule()
public Boolean getIsDevTier()
Autonomous Database for Developers are fixed-shape Autonomous Databases that developers can use to build and test new applications. On Serverless, these are low-cost and billed per instance, on Dedicated and Cloud@Customer there is no additional cost to create Developer databases. Developer databases come with limited resources and is not intended for large-scale testing and production deployments. When you need more compute or storage resources, you may upgrade to a full paid production database.
public Float getComputeCount()
The compute amount (CPUs) available to the database. Minimum and maximum values depend on the
compute model and whether the database is an Autonomous Database Serverless instance or an
Autonomous Database on Dedicated Exadata Infrastructure. The ‘ECPU’ compute model requires a
minimum value of one, for databases in the elastic resource pool and minimum value of two,
otherwise. Required when using the computeModel parameter. When using cpuCoreCount parameter, it is an error to specify computeCount to a non-null value.
Providing computeModel and computeCount is the preferred method for both OCPU
and ECPU.
This cannot be updated in parallel with any of the following: licenseModel, databaseEdition, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.
public Float getOcpuCount()
The number of OCPU cores to be made available to the Autonomous Database.
For Autonomous Databases on Dedicated Exadata Infrastructure, you can specify a fractional value for this parameter. Fractional values are not supported for Autonomous Database Serverless instances. For Autonomous Database Serverless instances, this parameter is not used.
To provision less than 1 core, enter a fractional value in an increment of 0.1. To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available to the infrastructure shape. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. Likewise, you can provision 2 cores or 3 cores, but not 2.5 cores. The maximum number of cores is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/index.html) for shape details.
*Note:** This parameter cannot be used with the cpuCoreCount parameter.
public Integer getDataStorageSizeInTBs()
The size, in terabytes, of the data volume that will be created and attached to the database. For Autonomous Databases on dedicated Exadata infrastructure, the maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details. A full Exadata service is allocated when the Autonomous Database size is set to the upper limit (384 TB).
*Note:** This parameter cannot be used with the dataStorageSizeInGBs parameter.
This cannot be updated in parallel with any of the following: licenseModel, databaseEdition, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.
public Integer getDataStorageSizeInGBs()
Applies to dedicated Exadata infrastructure only.
The size, in gigabytes, of the data volume that will be created and attached to the database. The maximum storage value depends on the system shape. See [Characteristics of Infrastructure Shapes](https://www.oracle.com/pls/topic/lookup?ctx=en/cloud/paas/autonomous-database&id=ATPFG-GUID-B0F033C1-CC5A-42F0-B2E7-3CECFEDA1FD1) for shape details.
*Note:** This parameter cannot be used with the dataStorageSizeInTBs parameter.
public String getDisplayName()
The user-friendly name for the Autonomous Database. The name does not have to be unique. The display name can only be updated for Autonomous Databases using dedicated Exadata Infrastructure. This parameter may not be updated in parallel with dbVersion.
public Boolean getIsFreeTier()
Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isLocalDataGuardEnabled
public String getAdminPassword()
The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (“) or the username "admin”, regardless of casing. It must be different from the last four passwords and it must not be a password used within the last 24 hours.
This cannot be used in conjunction with with OCI vault secrets (secretId).
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, whitelistedIps, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, or isFreeTier.
public String getDbName()
New name for this Autonomous Database. For Autonomous Databases on Dedicated Exadata Infrastructure, the name must begin with an alphabetic character, and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. For Autonomous Database Serverless instances, the name must begin with an alphabetic character, and can contain a maximum of 30 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails.
public Map<String,String> getFreeformTags()
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {"Department": "Finance"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
public Map<String,Map<String,Object>> getSecurityAttributes()
Security Attributes for this resource. Each key is predefined and scoped to a namespace. For
more information, see Resource
Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}
public UpdateAutonomousDatabaseDetails.DbWorkload getDbWorkload()
The Autonomous Database workload type. The following values are valid:
- OLTP - indicates an Autonomous Transaction Processing database - DW - indicates an Autonomous Data Warehouse database - AJD - indicates an Autonomous JSON Database - APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
public UpdateAutonomousDatabaseDetails.LicenseModel getLicenseModel()
The Oracle license model that applies to the Oracle Autonomous Database. Bring your own
license (BYOL) allows you to apply your current on-premises Oracle software licenses to
equivalent, highly automated Oracle services in the cloud. License Included allows you to
subscribe to new Oracle Database software licenses and the Oracle Database service. Note that
when provisioning an Autonomous Database on dedicated Exadata
infrastructure, this
attribute must be null. It is already set at the Autonomous Exadata Infrastructure level.
When provisioning an [Autonomous Database Serverless]
(https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value
is not specified, the system defaults the value to BRING_YOUR_OWN_LICENSE. Bring your
own license (BYOL) also allows you to select the DB edition using the optional parameter.
This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.
public Float getByolComputeCountLimit()
The maximum number of CPUs allowed with a Bring Your Own License (BYOL), including those used for auto-scaling, disaster recovery, tools, etc. Any CPU usage above this limit is considered as License Included and billed.
public Boolean getIsAccessControlEnabled()
Indicates if the database-level access control is enabled. If disabled, database access is
defined by the network security rules. If enabled, database access is restricted to the IP
addresses defined by the rules specified with the whitelistedIps property. While
specifying whitelistedIps rules is optional, if database-level access control is
enabled and no rules are specified, the database will become inaccessible. The rules can be
added later using the UpdateAutonomousDatabase API operation or edit option in
console. When creating a database clone, the desired access control setting should be
specified. By default, database-level access control will be disabled for the clone.
This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer
platform. For Autonomous Database Serverless instances, whitelistedIps is used.
public List<String> getWhitelistedIps()
The client IP access control list (ACL). This feature is available for [Autonomous Database
Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on
Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may
access the Autonomous Database instance. If arePrimaryWhitelistedIpsUsed is ‘TRUE’
then Autonomous Database uses this primary’s IP access control list (ACL) for the disaster
recovery peer called standbywhitelistedips.
For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain
routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Multiple
IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other
configurations that need multiple pieces of information then its each piece is connected with
semicolon (;) as a delimiter. Example: ["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example:
["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
public Boolean getArePrimaryWhitelistedIpsUsed()
This field will be null if the Autonomous Database is not Data Guard enabled or Access
Control is disabled. TRUE if the Autonomous Database has Data Guard and Access
Control enabled, and the Autonomous Database uses the primary’s IP access control list (ACL)
for standby. FALSE if the Autonomous Database has Data Guard and Access Control
enabled, and the Autonomous Database uses a different IP access control list (ACL) for
standby compared to primary.
public List<String> getStandbyWhitelistedIps()
The client IP access control list (ACL). This feature is available for [Autonomous Database
Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on
Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may
access the Autonomous Database instance. If arePrimaryWhitelistedIpsUsed is ‘TRUE’
then Autonomous Database uses this primary’s IP access control list (ACL) for the disaster
recovery peer called standbywhitelistedips.
For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain
routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Multiple
IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other
configurations that need multiple pieces of information then its each piece is connected with
semicolon (;) as a delimiter. Example: ["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR notations. Example:
["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
public Boolean getIsAutoScalingEnabled()
Indicates whether auto scaling is enabled for the Autonomous Database CPU core count. Setting
to TRUE enables auto scaling. Setting to FALSE disables auto scaling. The
default value is TRUE. Auto scaling is only available for Autonomous Database
Serverless instances.
public Boolean getIsRefreshableClone()
Indicates if the Autonomous Database is a refreshable clone.
This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
public UpdateAutonomousDatabaseDetails.RefreshableMode getRefreshableMode()
The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.
public Boolean getIsLocalDataGuardEnabled()
Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable when creating a cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
To create a local standby, set to TRUE. To delete a local standby, set to FALSE. For more information on using Autonomous Data Guard on an Autonomous Database
Serverless instance (local and cross-region) , see [About Standby
Databases](https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-about.html#GUID-045AD017-8120-4BDC-AF58-7430FFE28D2B)
To enable cross-region Autonomous Data Guard on an Autonomous Database Serverless instance, see [Enable Autonomous Data Guard](https://docs-uat.us.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-update-type.html#GUID-967ED737-4A05-4D6E-A7CA-C3F21ACF9BF0).
This cannot be updated in parallel with any of the following: isMTLSRequired, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.
public Boolean getIsDataGuardEnabled()
** Deprecated. ** Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable when creating a cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
To create a local standby, set to TRUE. To delete a local standby, set to FALSE. For more information on using Autonomous Data Guard on an Autonomous Database
Serverless instance (local and cross-region) , see [About Standby
Databases](https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-about.html#GUID-045AD017-8120-4BDC-AF58-7430FFE28D2B)
To enable cross-region Autonomous Data Guard on an Autonomous Database Serverless instance, see [Enable Autonomous Data Guard](https://docs-uat.us.oracle.com/en/cloud/paas/autonomous-database/adbsa/autonomous-data-guard-update-type.html#GUID-967ED737-4A05-4D6E-A7CA-C3F21ACF9BF0).
To delete a cross-region standby database, provide the peerDbId for the standby
database in a remote region, and set isDataGuardEnabled to FALSE.
public String getPeerDbId()
The database OCID(/Content/General/Concepts/identifiers.htm) of the Disaster Recovery peer (source Primary) database, which is located in a different (remote) region from the current peer database.
To create or delete a local (in-region) standby, see the isDataGuardEnabled
parameter.
public String getDbVersion()
A valid Oracle Database version for Autonomous Database.
public UpdateAutonomousDatabaseDetails.OpenMode getOpenMode()
Indicates the Autonomous Database mode. The database can be opened in READ_ONLY or
READ_WRITE mode.
This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.
public UpdateAutonomousDatabaseDetails.PermissionLevel getPermissionLevel()
The Autonomous Database permission level. Restricted mode allows access only by admin users.
This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.
public String getSubnetId()
The OCID of the subnet the resource is associated with.
*Subnet Restrictions:** - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20. - For Autonomous Database, setting this will disable public secure access to the database.
These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
public String getPrivateEndpointLabel()
The resource’s private endpoint label. - Setting the endpoint label to a non-empty string creates a private endpoint database. - Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database. - Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled.
This setting cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.
public String getPrivateEndpointIp()
The private endpoint Ip address for the resource.
public List<String> getNsgIds()
The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions: - A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
public Integer getAutoRefreshFrequencyInSeconds()
The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is
1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled
by the timeOfAutoRefreshStart parameter.
public Integer getAutoRefreshPointLagInSeconds()
The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens.
public Date getTimeOfAutoRefreshStart()
The the date and time that auto-refreshing will begin for an Autonomous Database refreshable
clone. This value controls only the start time for the first refresh operation. Subsequent
(ongoing) refresh operations have start times controlled by the value of the autoRefreshFrequencyInSeconds parameter.
public List<CustomerContact> getCustomerContacts()
Customer Contacts. Setting this to an empty list removes all customer contacts of an Oracle
This cannot be updated in parallel with any of the following: isMTLSConnectionRequired, scheduledOperations, or dbToolsDetails.
public Boolean getIsMtlsConnectionRequired()
Specifies if the Autonomous Database requires mTLS connections.
This may not be updated in parallel with any of the following: licenseModel, databaseEdition, cpuCoreCount, computeCount, dataStorageSizeInTBs, whitelistedIps, openMode, permissionLevel, db-workload, privateEndpointLabel, nsgIds, customerContacts, dbVersion, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
Service Change: The default value of the isMTLSConnectionRequired attribute will change from true to false on July 1, 2023 in the following APIs: - CreateAutonomousDatabase - GetAutonomousDatabase - UpdateAutonomousDatabase Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Database Serverless. Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true.
public String getResourcePoolLeaderId()
The unique identifier for leader autonomous database OCID OCID.
public ResourcePoolSummary getResourcePoolSummary()
public Boolean getIsBackupRetentionLocked()
True if the Autonomous Database is backup retention locked.
public List<ScheduledOperationDetails> getScheduledOperations()
The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
public Boolean getIsAutoScalingForStorageEnabled()
Indicates if auto scaling is enabled for the Autonomous Database storage. The default value
is FALSE.
public AutonomousDatabaseSummary.DatabaseEdition getDatabaseEdition()
The Oracle Database Edition that applies to the Autonomous databases. This parameter accepts
options STANDARD_EDITION and ENTERPRISE_EDITION.
This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.
public List<DatabaseTool> getDbToolsDetails()
The list of database tools details.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, isLocalDataGuardEnabled, or isFreeTier.
public String getSecretId()
The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID. This cannot be used in conjunction with adminPassword.
public Integer getSecretVersionNumber()
The version of the vault secret. If no version is specified, the latest version will be used.
public AutonomousDatabaseEncryptionKeyDetails getEncryptionKey()
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.