@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. - 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 ExplicitlySetBmcModel.__explicitlySet__
. The hashCode()
and
equals(Object)
methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__
into account.
The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__
(since the
constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
UpdateAutonomousDatabaseDetails.Builder |
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
The
DATABASE OPEN mode. |
static class |
UpdateAutonomousDatabaseDetails.PermissionLevel
The Autonomous Database permission level.
|
static class |
UpdateAutonomousDatabaseDetails.RefreshableMode
The refresh mode of the clone.
|
Constructor and Description |
---|
UpdateAutonomousDatabaseDetails(Integer cpuCoreCount,
LongTermBackUpScheduleDetails longTermBackupSchedule,
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,
UpdateAutonomousDatabaseDetails.DbWorkload dbWorkload,
UpdateAutonomousDatabaseDetails.LicenseModel licenseModel,
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,
List<CustomerContact> customerContacts,
Boolean isMtlsConnectionRequired,
List<ScheduledOperationDetails> scheduledOperations,
Boolean isAutoScalingForStorageEnabled,
Integer maxCpuCoreCount,
AutonomousDatabaseSummary.DatabaseEdition databaseEdition,
List<DatabaseTool> dbToolsDetails,
String secretId,
Integer secretVersionNumber)
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.
|
Float |
getComputeCount()
The compute amount available to the database.
|
Integer |
getCpuCoreCount()
The number of CPUs to be made available to the Autonomous Database.
|
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()
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.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
Boolean |
getIsAccessControlEnabled()
Indicates if the database-level access control is enabled.
|
Boolean |
getIsAutoScalingEnabled()
Indicates whether auto scaling is enabled for the Autonomous Database OCPU core count.
|
Boolean |
getIsAutoScalingForStorageEnabled()
Indicates if auto scaling is enabled for the Autonomous Database storage.
|
Boolean |
getIsDataGuardEnabled()
** Deprecated.
|
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()
Indicates whether the Autonomous Database requires mTLS connections.
|
Boolean |
getIsRefreshableClone()
Indicates whether the Autonomous Database is a refreshable clone.
|
UpdateAutonomousDatabaseDetails.LicenseModel |
getLicenseModel()
The Oracle license model that applies to the Oracle Autonomous Database.
|
LongTermBackUpScheduleDetails |
getLongTermBackupSchedule() |
Integer |
getMaxCpuCoreCount()
The number of Max OCPU cores to be made available to the autonomous database with auto
scaling of cpu enabled.
|
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()
The
DATABASE OPEN mode. |
String |
getPeerDbId()
The OCID of the
Autonomous Data Guard standby database located in a different (remote) region from the source
primary Autonomous Database.
|
UpdateAutonomousDatabaseDetails.PermissionLevel |
getPermissionLevel()
The Autonomous Database permission level.
|
String |
getPrivateEndpointIp()
The private endpoint Ip address for the resource.
|
String |
getPrivateEndpointLabel()
The private endpoint label for the resource.
|
UpdateAutonomousDatabaseDetails.RefreshableMode |
getRefreshableMode()
The refresh mode of the clone.
|
List<ScheduledOperationDetails> |
getScheduledOperations()
list of scheduled operations
|
String |
getSecretId()
The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID.
|
Integer |
getSecretVersionNumber()
The version of the vault secret.
|
List<String> |
getStandbyWhitelistedIps()
The client IP access control list (ACL).
|
String |
getSubnetId()
The OCID of the
subnet the resource is associated with.
|
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={"cpuCoreCount","longTermBackupSchedule","computeCount","ocpuCount","dataStorageSizeInTBs","dataStorageSizeInGBs","displayName","isFreeTier","adminPassword","dbName","freeformTags","definedTags","dbWorkload","licenseModel","isAccessControlEnabled","whitelistedIps","arePrimaryWhitelistedIpsUsed","standbyWhitelistedIps","isAutoScalingEnabled","isRefreshableClone","refreshableMode","isLocalDataGuardEnabled","isDataGuardEnabled","peerDbId","dbVersion","openMode","permissionLevel","subnetId","privateEndpointLabel","privateEndpointIp","nsgIds","customerContacts","isMtlsConnectionRequired","scheduledOperations","isAutoScalingForStorageEnabled","maxCpuCoreCount","databaseEdition","dbToolsDetails","secretId","secretVersionNumber"}) public UpdateAutonomousDatabaseDetails(Integer cpuCoreCount, LongTermBackUpScheduleDetails longTermBackupSchedule, 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, UpdateAutonomousDatabaseDetails.DbWorkload dbWorkload, UpdateAutonomousDatabaseDetails.LicenseModel licenseModel, 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, List<CustomerContact> customerContacts, Boolean isMtlsConnectionRequired, List<ScheduledOperationDetails> scheduledOperations, Boolean isAutoScalingForStorageEnabled, Integer maxCpuCoreCount, AutonomousDatabaseSummary.DatabaseEdition databaseEdition, List<DatabaseTool> dbToolsDetails, String secretId, Integer secretVersionNumber)
public static UpdateAutonomousDatabaseDetails.Builder builder()
Create a new builder.
public UpdateAutonomousDatabaseDetails.Builder toBuilder()
public Integer getCpuCoreCount()
The number of CPUs to be made available to the Autonomous Database.
*Note:** This parameter cannot be used with the ocpuCount
or computeCount
parameter.
public LongTermBackUpScheduleDetails getLongTermBackupSchedule()
public Float getComputeCount()
The compute amount available to the database. Minimum and maximum values depend on the
compute model and whether the database is on Shared or Dedicated infrastructure. For an
Autonomous Database on Shared infrastructure, the ‘ECPU’ compute model requires values in
multiples of two. Required when using the computeModel
parameter. When using cpuCoreCount
parameter, it is an error to specify computeCount to a non-null value.@endif
public Float getOcpuCount()
The number of OCPU cores to be made available to the Autonomous Database.
For databases on dedicated Exadata infrastructure, you can specify a fractional value for this parameter. Fractional values are not supported for Autonomous Database on shared Exadata infrastructure.
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://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 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.
*Note:** This parameter cannot be used with the dataStorageSizeInGBs
parameter.
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.
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.
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.
public String getDbName()
New name for this Autonomous Database. For databases using 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 databases using shared Exadata infrastructure, the name must begin with an alphabetic character, and can contain a maximum of 14 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy.
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 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.
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 PaaS and IaaS services in the cloud. License Included
allows you to subscribe to new Oracle Database software licenses and the Database service.
Note that when provisioning an Autonomous Database on dedicated Exadata
infrastructure, this
attribute must be null because the attribute is already set at the Autonomous Exadata
Infrastructure level. When using shared Exadata
infrastructure, if a
value is not specified, the system will supply the value of BRING_YOUR_OWN_LICENSE
.
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.
public List<String> getWhitelistedIps()
The client IP access control list (ACL). This feature is available for autonomous databases on shared Exadata infrastructure and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance.
For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain
Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the
VCN-specific subnets or IPs. 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 (Classless Inter-Domain
Routing) 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.
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 databases on shared Exadata infrastructure and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance.
For shared Exadata infrastructure, this is an array of CIDR (Classless Inter-Domain
Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the
VCN-specific subnets or IPs. 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 (Classless Inter-Domain
Routing) 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.
public Boolean getIsAutoScalingEnabled()
Indicates whether auto scaling is enabled for the Autonomous Database OCPU core count.
Setting to TRUE
enables auto scaling. Setting to FALSE
disables auto scaling.
The default value is true. Auto scaling is available for databases on shared Exadata
infrastructure only.
public Boolean getIsRefreshableClone()
Indicates whether the Autonomous Database is a refreshable clone.
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 shared Exadata infrastructure
(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 shared Exadata infrastructure, see createCrossRegionAutonomousDatabaseDataGuardDetails
.
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 shared Exadata infrastructure
(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 shared Exadata infrastructure, see createCrossRegionAutonomousDatabaseDataGuardDetails
.
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 OCID of the Autonomous Data Guard standby database located in a different (remote) region from the source primary Autonomous 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()
The DATABASE OPEN
mode. You can open the database in READ_ONLY
or READ_WRITE
mode.
public UpdateAutonomousDatabaseDetails.PermissionLevel getPermissionLevel()
The Autonomous Database permission level. Restricted mode allows access only to admin users.
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 private endpoint label for the resource. Setting this to an empty string, after the private endpoint database gets created, will change the same private endpoint database to the public endpoint database.
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 List<CustomerContact> getCustomerContacts()
Customer Contacts. Setting this to an empty list removes all customer contacts of an Oracle Autonomous Database.
public Boolean getIsMtlsConnectionRequired()
Indicates whether the Autonomous Database requires mTLS connections.
public List<ScheduledOperationDetails> getScheduledOperations()
list of scheduled operations
public Boolean getIsAutoScalingForStorageEnabled()
Indicates if auto scaling is enabled for the Autonomous Database storage. The default value
is FALSE
.
public Integer getMaxCpuCoreCount()
The number of Max OCPU cores to be made available to the autonomous database with auto scaling of cpu enabled.
public AutonomousDatabaseSummary.DatabaseEdition getDatabaseEdition()
The Oracle Database Edition that applies to the Autonomous databases.
public List<DatabaseTool> getDbToolsDetails()
List of database tools details.
public String getSecretId()
The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID.
public Integer getSecretVersionNumber()
The version of the vault secret. If no version is specified, the latest version will be used.
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public 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.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2023. All rights reserved.