Class DatabaseSummary
An Oracle Database on a bare metal or virtual machine DB system. For more information, see Bare Metal and Virtual Machine DB Systems.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Inherited Members
Namespace: Oci.DatabaseService.Models
Assembly: OCI.DotNetSDK.Database.dll
Syntax
public class DatabaseSummary
Properties
CharacterSet
Declaration
[JsonProperty(PropertyName = "characterSet")]
public string CharacterSet { get; set; }
Property Value
Type | Description |
---|---|
string | The character set for the database. |
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the compartment. |
Remarks
Required
ConnectionStrings
Declaration
[JsonProperty(PropertyName = "connectionStrings")]
public DatabaseConnectionStrings ConnectionStrings { get; set; }
Property Value
Type | Description |
---|---|
DatabaseConnectionStrings | The Connection strings used to connect to the Oracle Database. |
DatabaseManagementConfig
Declaration
[JsonProperty(PropertyName = "databaseManagementConfig")]
public CloudDatabaseManagementConfig DatabaseManagementConfig { get; set; }
Property Value
Type | Description |
---|---|
CloudDatabaseManagementConfig |
DatabaseSoftwareImageId
Declaration
[JsonProperty(PropertyName = "databaseSoftwareImageId")]
public string DatabaseSoftwareImageId { get; set; }
Property Value
Type | Description |
---|---|
string | The database software image OCID |
DbBackupConfig
Declaration
[JsonProperty(PropertyName = "dbBackupConfig")]
public DbBackupConfig DbBackupConfig { get; set; }
Property Value
Type | Description |
---|---|
DbBackupConfig |
DbHomeId
Declaration
[JsonProperty(PropertyName = "dbHomeId")]
public string DbHomeId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the Database Home. |
DbName
Declaration
[Required(ErrorMessage = "DbName is required.")]
[JsonProperty(PropertyName = "dbName")]
public string DbName { get; set; }
Property Value
Type | Description |
---|---|
string | The database name. |
Remarks
Required
DbSystemId
Declaration
[JsonProperty(PropertyName = "dbSystemId")]
public string DbSystemId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the DB system. |
DbUniqueName
Declaration
[Required(ErrorMessage = "DbUniqueName is required.")]
[JsonProperty(PropertyName = "dbUniqueName")]
public string DbUniqueName { get; set; }
Property Value
Type | Description |
---|---|
string | 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. |
Remarks
Required
DbWorkload
Declaration
[JsonProperty(PropertyName = "dbWorkload")]
public string DbWorkload { get; set; }
Property Value
Type | Description |
---|---|
string | 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.
|
DefinedTags
Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Dictionary<string, object>> | Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. |
FreeformTags
Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, string> | 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.
|
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the database. |
Remarks
Required
IsCdb
Declaration
[JsonProperty(PropertyName = "isCdb")]
public bool? IsCdb { get; set; }
Property Value
Type | Description |
---|---|
bool? | True if the database is a container database. |
KeyStoreId
Declaration
[JsonProperty(PropertyName = "keyStoreId")]
public string KeyStoreId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the key store of Oracle Vault. |
KeyStoreWalletName
Declaration
[JsonProperty(PropertyName = "keyStoreWalletName")]
public string KeyStoreWalletName { get; set; }
Property Value
Type | Description |
---|---|
string | The wallet name for Oracle Key Vault. |
KmsKeyId
Declaration
[JsonProperty(PropertyName = "kmsKeyId")]
public string KmsKeyId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. |
KmsKeyVersionId
Declaration
[JsonProperty(PropertyName = "kmsKeyVersionId")]
public string KmsKeyVersionId { get; set; }
Property Value
Type | Description |
---|---|
string | 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. |
LastBackupDurationInSeconds
Declaration
[JsonProperty(PropertyName = "lastBackupDurationInSeconds")]
public int? LastBackupDurationInSeconds { get; set; }
Property Value
Type | Description |
---|---|
int? | The duration when the latest database backup created. |
LastBackupTimestamp
Declaration
[JsonProperty(PropertyName = "lastBackupTimestamp")]
public DateTime? LastBackupTimestamp { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time when the latest database backup was created. |
LastFailedBackupTimestamp
Declaration
[JsonProperty(PropertyName = "lastFailedBackupTimestamp")]
public DateTime? LastFailedBackupTimestamp { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time when the latest database backup failed. |
LifecycleDetails
Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type | Description |
---|---|
string | Additional information about the current lifecycle state. |
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseSummary.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
DatabaseSummary.LifecycleStateEnum? | The current state of the database. |
Remarks
Required
NcharacterSet
Declaration
[JsonProperty(PropertyName = "ncharacterSet")]
public string NcharacterSet { get; set; }
Property Value
Type | Description |
---|---|
string | The national character set for the database. |
PdbName
Declaration
[JsonProperty(PropertyName = "pdbName")]
public string PdbName { get; set; }
Property Value
Type | Description |
---|---|
string | 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. |
SidPrefix
Declaration
[JsonProperty(PropertyName = "sidPrefix")]
public string SidPrefix { get; set; }
Property Value
Type | Description |
---|---|
string | Specifies a prefix for the |
SourceDatabasePointInTimeRecoveryTimestamp
Declaration
[JsonProperty(PropertyName = "sourceDatabasePointInTimeRecoveryTimestamp")]
public DateTime? SourceDatabasePointInTimeRecoveryTimestamp { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | 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 |
TimeCreated
Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the database was created. |
VaultId
Declaration
[JsonProperty(PropertyName = "vaultId")]
public string VaultId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the Oracle Cloud Infrastructure vault. This parameter and |
VmClusterId
Declaration
[JsonProperty(PropertyName = "vmClusterId")]
public string VmClusterId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the VM cluster. |