Show / Hide Table of Contents

Class DbHomeSummary

A directory where Oracle Database software is installed. A bare metal or Exadata DB system can have multiple Database Homes and each Database Home can run a different supported version of Oracle Database. A virtual machine DB system can have only one Database Home. For more information, see Bare Metal and Virtual Machine DB Systems and Exadata 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.

Inheritance
object
DbHomeSummary
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.DatabaseService.Models
Assembly: OCI.DotNetSDK.Database.dll
Syntax
public class DbHomeSummary

Properties

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

DatabaseSoftwareImageId

Declaration
[JsonProperty(PropertyName = "databaseSoftwareImageId")]
public string DatabaseSoftwareImageId { get; set; }
Property Value
Type Description
string

The database software image OCID

DbHomeLocation

Declaration
[Required(ErrorMessage = "DbHomeLocation is required.")]
[JsonProperty(PropertyName = "dbHomeLocation")]
public string DbHomeLocation { get; set; }
Property Value
Type Description
string

The location of the Oracle Database Home.

Remarks

Required

DbSystemId

Declaration
[JsonProperty(PropertyName = "dbSystemId")]
public string DbSystemId { get; set; }
Property Value
Type Description
string

The OCID of the DB system.

DbVersion

Declaration
[Required(ErrorMessage = "DbVersion is required.")]
[JsonProperty(PropertyName = "dbVersion")]
public string DbVersion { get; set; }
Property Value
Type Description
string

The Oracle Database version.

Remarks

Required

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.

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

The user-provided name for the Database Home. The name does not need to be unique.

Remarks

Required

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.
Example: {"Department": "Finance"}

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 Home.

Remarks

Required

IsUnifiedAuditingEnabled

Declaration
[JsonProperty(PropertyName = "isUnifiedAuditingEnabled")]
public bool? IsUnifiedAuditingEnabled { get; set; }
Property Value
Type Description
bool?

Indicates whether unified autiding is enabled or not.

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.

LastPatchHistoryEntryId

Declaration
[JsonProperty(PropertyName = "lastPatchHistoryEntryId")]
public string LastPatchHistoryEntryId { get; set; }
Property Value
Type Description
string

The OCID of the last patch history. This value is updated as soon as a patch operation is started.

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 DbHomeSummary.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
DbHomeSummary.LifecycleStateEnum?

The current state of the Database Home.

Remarks

Required

OneOffPatches

Declaration
[JsonProperty(PropertyName = "oneOffPatches")]
public List<string> OneOffPatches { get; set; }
Property Value
Type Description
List<string>

List of one-off patches for Database Homes.

TimeCreated

Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time the Database Home was created.

VmClusterId

Declaration
[JsonProperty(PropertyName = "vmClusterId")]
public string VmClusterId { get; set; }
Property Value
Type Description
string

The OCID of the VM cluster.

In this article
Back to top