java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.database.model.Database

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class Database
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
Note: Objects should always be created or deserialized using the Database.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 Database.Builder, which maintain a set of all explicitly set fields called Database.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).

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Database.Builder

static class Database.LifecycleState
The current state of the database.

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor	Description
Database(String id, String compartmentId, String characterSet, String ncharacterSet, String dbHomeId, String dbSystemId, String vmClusterId, String dbName, String pdbName, String dbWorkload, String dbUniqueName, String lifecycleDetails, Database.LifecycleState lifecycleState, Date timeCreated, Date lastBackupTimestamp, Integer lastBackupDurationInSeconds, Date lastFailedBackupTimestamp, DbBackupConfig dbBackupConfig, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, DatabaseConnectionStrings connectionStrings, String kmsKeyId, String kmsKeyVersionId, String vaultId, Date sourceDatabasePointInTimeRecoveryTimestamp, String databaseSoftwareImageId, Boolean isCdb, CloudDatabaseManagementConfig databaseManagementConfig, String sidPrefix, String keyStoreId, String keyStoreWalletName, DataGuardGroup dataGuardGroup, EncryptionKeyLocationDetails encryptionKeyLocationDetails)	Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Database.Builder`	`builder()`	Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getCharacterSet()`	The character set for the database.
`String`	`getCompartmentId()`	The OCID of the compartment.
`DatabaseConnectionStrings`	`getConnectionStrings()`	The Connection strings used to connect to the Oracle Database.
`CloudDatabaseManagementConfig`	`getDatabaseManagementConfig()`
`String`	`getDatabaseSoftwareImageId()`	The database software image OCID
`DataGuardGroup`	`getDataGuardGroup()`
`DbBackupConfig`	`getDbBackupConfig()`
`String`	`getDbHomeId()`	The OCID of the Database Home.
`String`	`getDbName()`	The database name.
`String`	`getDbSystemId()`	The OCID of the DB system.
`String`	`getDbUniqueName()`	A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases).
`String`	`getDbWorkload()`	Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service.
`Map<String,Map<String,Object>>`	`getDefinedTags()`	Defined tags for this resource.
`EncryptionKeyLocationDetails`	`getEncryptionKeyLocationDetails()`
`Map<String,String>`	`getFreeformTags()`	Free-form tags for this resource.
`String`	`getId()`	The OCID of the database.
`Boolean`	`getIsCdb()`	True if the database is a container database.
`String`	`getKeyStoreId()`	The OCID of the key store of Oracle Vault.
`String`	`getKeyStoreWalletName()`	The wallet name for Oracle Key Vault.
`String`	`getKmsKeyId()`	The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
`String`	`getKmsKeyVersionId()`	The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
`Integer`	`getLastBackupDurationInSeconds()`	The duration when the latest database backup created.
`Date`	`getLastBackupTimestamp()`	The date and time when the latest database backup was created.
`Date`	`getLastFailedBackupTimestamp()`	The date and time when the latest database backup failed.
`String`	`getLifecycleDetails()`	Additional information about the current lifecycle state.
`Database.LifecycleState`	`getLifecycleState()`	The current state of the database.
`String`	`getNcharacterSet()`	The national character set for the database.
`String`	`getPdbName()`	The name of the pluggable database.
`String`	`getSidPrefix()`	Specifies a prefix for the Oracle SID of the database to be created.
`Date`	`getSourceDatabasePointInTimeRecoveryTimestamp()`	Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
`Date`	`getTimeCreated()`	The date and time the database was created.
`String`	`getVaultId()`	The OCID of the Oracle Cloud Infrastructure vault.
`String`	`getVmClusterId()`	The OCID of the VM cluster.
`int`	`hashCode()`
`Database.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)`	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Database

@Deprecated
@ConstructorProperties({"id","compartmentId","characterSet","ncharacterSet","dbHomeId","dbSystemId","vmClusterId","dbName","pdbName","dbWorkload","dbUniqueName","lifecycleDetails","lifecycleState","timeCreated","lastBackupTimestamp","lastBackupDurationInSeconds","lastFailedBackupTimestamp","dbBackupConfig","freeformTags","definedTags","connectionStrings","kmsKeyId","kmsKeyVersionId","vaultId","sourceDatabasePointInTimeRecoveryTimestamp","databaseSoftwareImageId","isCdb","databaseManagementConfig","sidPrefix","keyStoreId","keyStoreWalletName","dataGuardGroup","encryptionKeyLocationDetails"})
public Database(String id,
                String compartmentId,
                String characterSet,
                String ncharacterSet,
                String dbHomeId,
                String dbSystemId,
                String vmClusterId,
                String dbName,
                String pdbName,
                String dbWorkload,
                String dbUniqueName,
                String lifecycleDetails,
                Database.LifecycleState lifecycleState,
                Date timeCreated,
                Date lastBackupTimestamp,
                Integer lastBackupDurationInSeconds,
                Date lastFailedBackupTimestamp,
                DbBackupConfig dbBackupConfig,
                Map<String,String> freeformTags,
                Map<String,Map<String,Object>> definedTags,
                DatabaseConnectionStrings connectionStrings,
                String kmsKeyId,
                String kmsKeyVersionId,
                String vaultId,
                Date sourceDatabasePointInTimeRecoveryTimestamp,
                String databaseSoftwareImageId,
                Boolean isCdb,
                CloudDatabaseManagementConfig databaseManagementConfig,
                String sidPrefix,
                String keyStoreId,
                String keyStoreWalletName,
                DataGuardGroup dataGuardGroup,
                EncryptionKeyLocationDetails encryptionKeyLocationDetails)

Deprecated.

Method Detail
- builder
```
public static Database.Builder builder()
```
  Create a new builder.
- toBuilder
```
public Database.Builder toBuilder()
```
- getId
```
public String getId()
```
  The OCID of the database.
  
  Returns:
  
  the value
- getCompartmentId
```
public String getCompartmentId()
```
  The OCID of the compartment.
  
  Returns:
  
  the value
- getCharacterSet
```
public String getCharacterSet()
```
  The character set for the database.
  
  Returns:
  
  the value
- getNcharacterSet
```
public String getNcharacterSet()
```
  The national character set for the database.
  
  Returns:
  
  the value
- getDbHomeId
```
public String getDbHomeId()
```
  The OCID of the Database Home.
  
  Returns:
  
  the value
- getDbSystemId
```
public String getDbSystemId()
```
  The OCID of the DB system.
  
  Returns:
  
  the value
- getVmClusterId
```
public String getVmClusterId()
```
  The OCID of the VM cluster.
  
  Returns:
  
  the value
- getDbName
```
public String getDbName()
```
  The database name.
  
  Returns:
  
  the value
- getPdbName
```
public String getPdbName()
```
  The name of the pluggable database.
  The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
  
  Returns:
  
  the value
- getDbWorkload
```
public String getDbWorkload()
```
  Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service.
  Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
  
  The database workload type.
  
  Returns:
  
  the value
- getDbUniqueName
```
public String getDbUniqueName()
```
  A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases).
  The unique name cannot be changed.
  
  Returns:
  
  the value
- getLifecycleDetails
```
public String getLifecycleDetails()
```
  Additional information about the current lifecycle state.
  
  Returns:
  
  the value
- getLifecycleState
```
public Database.LifecycleState getLifecycleState()
```
  The current state of the database.
  
  Returns:
  
  the value
- getTimeCreated
```
public Date getTimeCreated()
```
  The date and time the database was created.
  
  Returns:
  
  the value
- getLastBackupTimestamp
```
public Date getLastBackupTimestamp()
```
  The date and time when the latest database backup was created.
  
  Returns:
  
  the value
- getLastBackupDurationInSeconds
```
public Integer getLastBackupDurationInSeconds()
```
  The duration when the latest database backup created.
  
  Returns:
  
  the value
- getLastFailedBackupTimestamp
```
public Date getLastFailedBackupTimestamp()
```
  The date and time when the latest database backup failed.
  
  Returns:
  
  the value
- getDbBackupConfig
```
public DbBackupConfig getDbBackupConfig()
```
- getFreeformTags
```
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"}
  
  Returns:
  
  the value
- getDefinedTags
```
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.
  
  Returns:
  
  the value
- getConnectionStrings
```
public DatabaseConnectionStrings getConnectionStrings()
```
  The Connection strings used to connect to the Oracle Database.
  
  Returns:
  
  the value
- getKmsKeyId
```
public String getKmsKeyId()
```
  The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
  
  Returns:
  
  the value
- getKmsKeyVersionId
```
public String getKmsKeyVersionId()
```
  The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
  If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
  
  Returns:
  
  the value
- getVaultId
```
public String getVaultId()
```
  The OCID of the Oracle Cloud Infrastructure vault.
  This parameter and secretId are required for Customer Managed Keys.
  
  Returns:
  
  the value
- getSourceDatabasePointInTimeRecoveryTimestamp
```
public Date getSourceDatabasePointInTimeRecoveryTimestamp()
```
  Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339
  
  Returns:
  
  the value
- getDatabaseSoftwareImageId
```
public String getDatabaseSoftwareImageId()
```
  The database software image OCID
  
  Returns:
  
  the value
- getIsCdb
```
public Boolean getIsCdb()
```
  True if the database is a container database.
  
  Returns:
  
  the value
- getDatabaseManagementConfig
```
public CloudDatabaseManagementConfig getDatabaseManagementConfig()
```
- getSidPrefix
```
public String getSidPrefix()
```
  Specifies a prefix for the Oracle SID of the database to be created.
  
  Returns:
  
  the value
- getKeyStoreId
```
public String getKeyStoreId()
```
  The OCID of the key store of Oracle Vault.
  
  Returns:
  
  the value
- getKeyStoreWalletName
```
public String getKeyStoreWalletName()
```
  The wallet name for Oracle Key Vault.
  
  Returns:
  
  the value
- getDataGuardGroup
```
public DataGuardGroup getDataGuardGroup()
```
- getEncryptionKeyLocationDetails
```
public EncryptionKeyLocationDetails getEncryptionKeyLocationDetails()
```
- toString
```
public String toString()
```
  Overrides:
  
  toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- toString
```
public String toString(boolean includeByteArrayContents)
```
  Return a string representation of the object.
  
  Parameters:
  
  includeByteArrayContents - true to include the full contents of byte arrays
  
  Returns:
  
  string representation
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Modifier and Type	Class	Description
`static class`	`Database.Builder`
`static class`	`Database.LifecycleState`	The current state of the database.

Class Database

Nested Class Summary

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

Database

Method Detail

builder

toBuilder

getId

getCompartmentId

getCharacterSet

getNcharacterSet

getDbHomeId

getDbSystemId

getVmClusterId

getDbName

getPdbName

getDbWorkload

getDbUniqueName

getLifecycleDetails

getLifecycleState

getTimeCreated

getLastBackupTimestamp

getLastBackupDurationInSeconds

getLastFailedBackupTimestamp

getDbBackupConfig

getFreeformTags

getDefinedTags

getConnectionStrings

getKmsKeyId

getKmsKeyVersionId

getVaultId

getSourceDatabasePointInTimeRecoveryTimestamp

getDatabaseSoftwareImageId

getIsCdb

getDatabaseManagementConfig

getSidPrefix

getKeyStoreId

getKeyStoreWalletName

getDataGuardGroup

getEncryptionKeyLocationDetails

toString

toString

equals

hashCode