@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class AutonomousDatabase extends Object
An Oracle Autonomous Database.
AutonomousDatabase.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 AutonomousDatabase.Builder
, which maintain a set of all explicitly set fields called
__explicitlySet__
. The hashCode()
and equals(Object)
methods are implemented to take
__explicitlySet__
into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null
from unset null
).Modifier and Type | Class and Description |
---|---|
static class |
AutonomousDatabase.Builder |
static class |
AutonomousDatabase.DataSafeStatus
Status of the Data Safe registration for this Autonomous Database.
|
static class |
AutonomousDatabase.DbWorkload
The Autonomous Database workload type.
|
static class |
AutonomousDatabase.InfrastructureType
The infrastructure type this resource belongs to.
|
static class |
AutonomousDatabase.LicenseModel
The Oracle license model that applies to the Oracle Autonomous Database.
|
static class |
AutonomousDatabase.LifecycleState
The current state of the Autonomous Database.
|
static class |
AutonomousDatabase.OpenMode
The
DATABASE OPEN mode. |
static class |
AutonomousDatabase.OperationsInsightsStatus
Status of Operations Insights for this Autonomous Database.
|
static class |
AutonomousDatabase.PermissionLevel
The Autonomous Database permission level.
|
static class |
AutonomousDatabase.RefreshableMode
The refresh mode of the clone.
|
static class |
AutonomousDatabase.RefreshableStatus
The refresh status of the clone.
|
static class |
AutonomousDatabase.Role
The role of the Autonomous Data Guard-enabled Autonomous Container Database.
|
Constructor and Description |
---|
AutonomousDatabase(String id,
String compartmentId,
AutonomousDatabase.LifecycleState lifecycleState,
String lifecycleDetails,
String dbName,
Boolean isFreeTier,
Map<String,Map<String,Object>> systemTags,
Date timeReclamationOfFreeAutonomousDatabase,
Date timeDeletionOfFreeAutonomousDatabase,
AutonomousDatabaseBackupConfig backupConfig,
Integer cpuCoreCount,
Integer dataStorageSizeInTBs,
Integer dataStorageSizeInGBs,
AutonomousDatabase.InfrastructureType infrastructureType,
Boolean isDedicated,
String autonomousContainerDatabaseId,
Date timeCreated,
String displayName,
String serviceConsoleUrl,
AutonomousDatabaseConnectionStrings connectionStrings,
AutonomousDatabaseConnectionUrls connectionUrls,
AutonomousDatabase.LicenseModel licenseModel,
Integer usedDataStorageSizeInTBs,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
String subnetId,
List<String> nsgIds,
String privateEndpoint,
String privateEndpointLabel,
String privateEndpointIp,
String dbVersion,
Boolean isPreview,
AutonomousDatabase.DbWorkload dbWorkload,
Boolean isAccessControlEnabled,
List<String> whitelistedIps,
Boolean arePrimaryWhitelistedIpsUsed,
List<String> standbyWhitelistedIps,
AutonomousDatabaseApex apexDetails,
Boolean isAutoScalingEnabled,
AutonomousDatabase.DataSafeStatus dataSafeStatus,
AutonomousDatabase.OperationsInsightsStatus operationsInsightsStatus,
Date timeMaintenanceBegin,
Date timeMaintenanceEnd,
Boolean isRefreshableClone,
Date timeOfLastRefresh,
Date timeOfLastRefreshPoint,
Date timeOfNextRefresh,
AutonomousDatabase.OpenMode openMode,
AutonomousDatabase.RefreshableStatus refreshableStatus,
AutonomousDatabase.RefreshableMode refreshableMode,
String sourceId,
AutonomousDatabase.PermissionLevel permissionLevel,
Date timeOfLastSwitchover,
Date timeOfLastFailover,
Boolean isDataGuardEnabled,
Integer failedDataRecoveryInSeconds,
AutonomousDatabaseStandbySummary standbyDb,
AutonomousDatabase.Role role,
List<String> availableUpgradeVersions,
String keyStoreId,
String keyStoreWalletName)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static AutonomousDatabase.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
AutonomousDatabaseApex |
getApexDetails()
Information about Oracle APEX Application Development.
|
Boolean |
getArePrimaryWhitelistedIpsUsed()
This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled.
|
String |
getAutonomousContainerDatabaseId()
The Autonomous Container Database OCID.
|
List<String> |
getAvailableUpgradeVersions()
List of Oracle Database versions available for a database upgrade.
|
AutonomousDatabaseBackupConfig |
getBackupConfig() |
String |
getCompartmentId()
The OCID of the compartment.
|
AutonomousDatabaseConnectionStrings |
getConnectionStrings()
The connection string used to connect to the Autonomous Database.
|
AutonomousDatabaseConnectionUrls |
getConnectionUrls() |
Integer |
getCpuCoreCount()
The number of OCPU cores to be made available to the database.
|
AutonomousDatabase.DataSafeStatus |
getDataSafeStatus()
Status of the Data Safe registration for this Autonomous Database.
|
Integer |
getDataStorageSizeInGBs()
The quantity of data in the database, in gigabytes.
|
Integer |
getDataStorageSizeInTBs()
The quantity of data in the database, in terabytes.
|
String |
getDbName()
The database name.
|
String |
getDbVersion()
A valid Oracle Database version for Autonomous Database.
|
AutonomousDatabase.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.
|
Integer |
getFailedDataRecoveryInSeconds()
Indicates the number of seconds of data loss for a Data Guard failover.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the Autonomous Database.
|
AutonomousDatabase.InfrastructureType |
getInfrastructureType()
The infrastructure type this resource belongs to.
|
Boolean |
getIsAccessControlEnabled()
Indicates if the database-level access control is enabled.
|
Boolean |
getIsAutoScalingEnabled()
Indicates if auto scaling is enabled for the Autonomous Database CPU core count.
|
Boolean |
getIsDataGuardEnabled()
Indicates whether the Autonomous Database has Data Guard enabled.
|
Boolean |
getIsDedicated()
True if the database uses dedicated Exadata infrastructure.
|
Boolean |
getIsFreeTier()
Indicates if this is an Always Free resource.
|
Boolean |
getIsPreview()
Indicates if the Autonomous Database version is a preview version.
|
Boolean |
getIsRefreshableClone()
Indicates whether the Autonomous Database is a refreshable clone.
|
String |
getKeyStoreId()
The OCID of the key store.
|
String |
getKeyStoreWalletName()
The wallet name for Oracle Key Vault.
|
AutonomousDatabase.LicenseModel |
getLicenseModel()
The Oracle license model that applies to the Oracle Autonomous Database.
|
String |
getLifecycleDetails()
Information about the current lifecycle state.
|
AutonomousDatabase.LifecycleState |
getLifecycleState()
The current state of the Autonomous Database.
|
List<String> |
getNsgIds()
A list of the OCIDs of the network security groups (NSGs) that this resource belongs to.
|
AutonomousDatabase.OpenMode |
getOpenMode()
The
DATABASE OPEN mode. |
AutonomousDatabase.OperationsInsightsStatus |
getOperationsInsightsStatus()
Status of Operations Insights for this Autonomous Database.
|
AutonomousDatabase.PermissionLevel |
getPermissionLevel()
The Autonomous Database permission level.
|
String |
getPrivateEndpoint()
The private endpoint for the resource.
|
String |
getPrivateEndpointIp()
The private endpoint Ip address for the resource.
|
String |
getPrivateEndpointLabel()
The private endpoint label for the resource.
|
AutonomousDatabase.RefreshableMode |
getRefreshableMode()
The refresh mode of the clone.
|
AutonomousDatabase.RefreshableStatus |
getRefreshableStatus()
The refresh status of the clone.
|
AutonomousDatabase.Role |
getRole()
The role of the Autonomous Data Guard-enabled Autonomous Container Database.
|
String |
getServiceConsoleUrl()
The URL of the Service Console for the Autonomous Database.
|
String |
getSourceId()
The OCID of the source Autonomous Database that was cloned to create the current Autonomous Database.
|
AutonomousDatabaseStandbySummary |
getStandbyDb() |
List<String> |
getStandbyWhitelistedIps()
The client IP access control list (ACL).
|
String |
getSubnetId()
The OCID of the subnet the resource is associated with.
|
Map<String,Map<String,Object>> |
getSystemTags()
System tags for this resource.
|
Date |
getTimeCreated()
The date and time the Autonomous Database was created.
|
Date |
getTimeDeletionOfFreeAutonomousDatabase()
The date and time the Always Free database will be automatically deleted because of inactivity.
|
Date |
getTimeMaintenanceBegin()
The date and time when maintenance will begin.
|
Date |
getTimeMaintenanceEnd()
The date and time when maintenance will end.
|
Date |
getTimeOfLastFailover()
The timestamp of the last failover operation.
|
Date |
getTimeOfLastRefresh()
The date and time when last refresh happened.
|
Date |
getTimeOfLastRefreshPoint()
The refresh point timestamp (UTC).
|
Date |
getTimeOfLastSwitchover()
The timestamp of the last switchover operation for the Autonomous Database.
|
Date |
getTimeOfNextRefresh()
The date and time of next refresh.
|
Date |
getTimeReclamationOfFreeAutonomousDatabase()
The date and time the Always Free database will be stopped because of inactivity.
|
Integer |
getUsedDataStorageSizeInTBs()
The amount of storage that has been used, in terabytes.
|
List<String> |
getWhitelistedIps()
The client IP access control list (ACL).
|
int |
hashCode() |
AutonomousDatabase.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"id","compartmentId","lifecycleState","lifecycleDetails","dbName","isFreeTier","systemTags","timeReclamationOfFreeAutonomousDatabase","timeDeletionOfFreeAutonomousDatabase","backupConfig","cpuCoreCount","dataStorageSizeInTBs","dataStorageSizeInGBs","infrastructureType","isDedicated","autonomousContainerDatabaseId","timeCreated","displayName","serviceConsoleUrl","connectionStrings","connectionUrls","licenseModel","usedDataStorageSizeInTBs","freeformTags","definedTags","subnetId","nsgIds","privateEndpoint","privateEndpointLabel","privateEndpointIp","dbVersion","isPreview","dbWorkload","isAccessControlEnabled","whitelistedIps","arePrimaryWhitelistedIpsUsed","standbyWhitelistedIps","apexDetails","isAutoScalingEnabled","dataSafeStatus","operationsInsightsStatus","timeMaintenanceBegin","timeMaintenanceEnd","isRefreshableClone","timeOfLastRefresh","timeOfLastRefreshPoint","timeOfNextRefresh","openMode","refreshableStatus","refreshableMode","sourceId","permissionLevel","timeOfLastSwitchover","timeOfLastFailover","isDataGuardEnabled","failedDataRecoveryInSeconds","standbyDb","role","availableUpgradeVersions","keyStoreId","keyStoreWalletName"}) @Deprecated public AutonomousDatabase(String id, String compartmentId, AutonomousDatabase.LifecycleState lifecycleState, String lifecycleDetails, String dbName, Boolean isFreeTier, Map<String,Map<String,Object>> systemTags, Date timeReclamationOfFreeAutonomousDatabase, Date timeDeletionOfFreeAutonomousDatabase, AutonomousDatabaseBackupConfig backupConfig, Integer cpuCoreCount, Integer dataStorageSizeInTBs, Integer dataStorageSizeInGBs, AutonomousDatabase.InfrastructureType infrastructureType, Boolean isDedicated, String autonomousContainerDatabaseId, Date timeCreated, String displayName, String serviceConsoleUrl, AutonomousDatabaseConnectionStrings connectionStrings, AutonomousDatabaseConnectionUrls connectionUrls, AutonomousDatabase.LicenseModel licenseModel, Integer usedDataStorageSizeInTBs, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, String subnetId, List<String> nsgIds, String privateEndpoint, String privateEndpointLabel, String privateEndpointIp, String dbVersion, Boolean isPreview, AutonomousDatabase.DbWorkload dbWorkload, Boolean isAccessControlEnabled, List<String> whitelistedIps, Boolean arePrimaryWhitelistedIpsUsed, List<String> standbyWhitelistedIps, AutonomousDatabaseApex apexDetails, Boolean isAutoScalingEnabled, AutonomousDatabase.DataSafeStatus dataSafeStatus, AutonomousDatabase.OperationsInsightsStatus operationsInsightsStatus, Date timeMaintenanceBegin, Date timeMaintenanceEnd, Boolean isRefreshableClone, Date timeOfLastRefresh, Date timeOfLastRefreshPoint, Date timeOfNextRefresh, AutonomousDatabase.OpenMode openMode, AutonomousDatabase.RefreshableStatus refreshableStatus, AutonomousDatabase.RefreshableMode refreshableMode, String sourceId, AutonomousDatabase.PermissionLevel permissionLevel, Date timeOfLastSwitchover, Date timeOfLastFailover, Boolean isDataGuardEnabled, Integer failedDataRecoveryInSeconds, AutonomousDatabaseStandbySummary standbyDb, AutonomousDatabase.Role role, List<String> availableUpgradeVersions, String keyStoreId, String keyStoreWalletName)
public static AutonomousDatabase.Builder builder()
Create a new builder.
public AutonomousDatabase.Builder toBuilder()
public AutonomousDatabase.LifecycleState getLifecycleState()
The current state of the Autonomous Database.
public String getLifecycleDetails()
Information about the current lifecycle state.
public String getDbName()
The database name.
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 Map<String,Map<String,Object>> getSystemTags()
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
public Date getTimeReclamationOfFreeAutonomousDatabase()
The date and time the Always Free database will be stopped because of inactivity. If this time is reached without any database activity, the database will automatically be put into the STOPPED state.
public Date getTimeDeletionOfFreeAutonomousDatabase()
The date and time the Always Free database will be automatically deleted because of inactivity. If the database is in the STOPPED state and without activity until this time, it will be deleted.
public AutonomousDatabaseBackupConfig getBackupConfig()
public Integer getCpuCoreCount()
The number of OCPU cores to be made available to the database.
public Integer getDataStorageSizeInTBs()
The quantity of data in the database, in terabytes.
public Integer getDataStorageSizeInGBs()
The quantity of data in the database, in gigabytes.
public AutonomousDatabase.InfrastructureType getInfrastructureType()
The infrastructure type this resource belongs to.
public Boolean getIsDedicated()
True if the database uses dedicated Exadata infrastructure.
public String getAutonomousContainerDatabaseId()
The Autonomous Container Database OCID.
public Date getTimeCreated()
The date and time the Autonomous Database was created.
public String getDisplayName()
The user-friendly name for the Autonomous Database. The name does not have to be unique.
public String getServiceConsoleUrl()
The URL of the Service Console for the Autonomous Database.
public AutonomousDatabaseConnectionStrings getConnectionStrings()
The connection string used to connect to the Autonomous Database. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous Database for the password value.
public AutonomousDatabaseConnectionUrls getConnectionUrls()
public AutonomousDatabase.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 Integer getUsedDataStorageSizeInTBs()
The amount of storage that has been used, in terabytes.
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 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 List<String> getNsgIds()
A list of the OCIDs of the network security groups (NSGs) that this resource belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
public String getPrivateEndpoint()
The private endpoint for the resource.
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 String getDbVersion()
A valid Oracle Database version for Autonomous Database.
public Boolean getIsPreview()
Indicates if the Autonomous Database version is a preview version.
public AutonomousDatabase.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 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.
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.
It’s value would be TRUE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby.
It’s value would be FALSE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses 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.
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 AutonomousDatabaseApex getApexDetails()
Information about Oracle APEX Application Development.
public Boolean getIsAutoScalingEnabled()
Indicates if auto scaling is enabled for the Autonomous Database CPU core count.
public AutonomousDatabase.DataSafeStatus getDataSafeStatus()
Status of the Data Safe registration for this Autonomous Database.
public AutonomousDatabase.OperationsInsightsStatus getOperationsInsightsStatus()
Status of Operations Insights for this Autonomous Database.
public Date getTimeMaintenanceBegin()
The date and time when maintenance will begin.
public Date getTimeMaintenanceEnd()
The date and time when maintenance will end.
public Boolean getIsRefreshableClone()
Indicates whether the Autonomous Database is a refreshable clone.
public Date getTimeOfLastRefresh()
The date and time when last refresh happened.
public Date getTimeOfLastRefreshPoint()
The refresh point timestamp (UTC). The refresh point is the time to which the database was most recently refreshed. Data created after the refresh point is not included in the refresh.
public Date getTimeOfNextRefresh()
The date and time of next refresh.
public AutonomousDatabase.OpenMode getOpenMode()
The DATABASE OPEN
mode. You can open the database in READ_ONLY
or READ_WRITE
mode.
public AutonomousDatabase.RefreshableStatus getRefreshableStatus()
The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous Database.
public AutonomousDatabase.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 String getSourceId()
The OCID of the source Autonomous Database that was cloned to create the current Autonomous Database.
public AutonomousDatabase.PermissionLevel getPermissionLevel()
The Autonomous Database permission level. Restricted mode allows access only to admin users.
public Date getTimeOfLastSwitchover()
The timestamp of the last switchover operation for the Autonomous Database.
public Date getTimeOfLastFailover()
The timestamp of the last failover operation.
public Boolean getIsDataGuardEnabled()
Indicates whether the Autonomous Database has Data Guard enabled.
public Integer getFailedDataRecoveryInSeconds()
Indicates the number of seconds of data loss for a Data Guard failover.
public AutonomousDatabaseStandbySummary getStandbyDb()
public AutonomousDatabase.Role getRole()
The role of the Autonomous Data Guard-enabled Autonomous Container Database.
public List<String> getAvailableUpgradeVersions()
List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.
public String getKeyStoreWalletName()
The wallet name for Oracle Key Vault.
Copyright © 2016–2021. All rights reserved.