Show / Hide Table of Contents

Class PluggableDatabaseSummary

A pluggable database (PDB) is portable collection of schemas, schema objects, and non-schema objects that appears to an Oracle client as a non-container database. To use a PDB, it needs to be plugged into a CDB. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to a tenancy administrator. If you are 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
PluggableDatabaseSummary
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 PluggableDatabaseSummary

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

ConnectionStrings

Declaration
[JsonProperty(PropertyName = "connectionStrings")]
public PluggableDatabaseConnectionStrings ConnectionStrings { get; set; }
Property Value
Type Description
PluggableDatabaseConnectionStrings

ContainerDatabaseId

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

The OCID of the CDB.

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.

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 pluggable database.

Remarks

Required

IsRestricted

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

The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.

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.

LifecycleDetails

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

Detailed message for the lifecycle state.

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public PluggableDatabaseSummary.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
PluggableDatabaseSummary.LifecycleStateEnum?

The current state of the pluggable database.

Remarks

Required

OpenMode

Declaration
[Required(ErrorMessage = "OpenMode is required.")]
[JsonProperty(PropertyName = "openMode")]
[JsonConverter(typeof(ResponseEnumConverter))]
public PluggableDatabaseSummary.OpenModeEnum? OpenMode { get; set; }
Property Value
Type Description
PluggableDatabaseSummary.OpenModeEnum?

Deprecated. Use {@link #pluggableDatabaseNodeLevelDetails(PluggableDatabaseNodeLevelDetailsRequest) pluggableDatabaseNodeLevelDetails} for OpenMode details. The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).

Remarks

Required

PdbName

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

The name for the pluggable database (PDB). The name is unique in the context of a {@link Database}. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.

Remarks

Required

PdbNodeLevelDetails

Declaration
[JsonProperty(PropertyName = "pdbNodeLevelDetails")]
public List<PluggableDatabaseNodeLevelDetails> PdbNodeLevelDetails { get; set; }
Property Value
Type Description
List<PluggableDatabaseNodeLevelDetails>

Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]

PluggableDatabaseManagementConfig

Declaration
[JsonProperty(PropertyName = "pluggableDatabaseManagementConfig")]
public PluggableDatabaseManagementConfig PluggableDatabaseManagementConfig { get; set; }
Property Value
Type Description
PluggableDatabaseManagementConfig

RefreshableCloneConfig

Declaration
[JsonProperty(PropertyName = "refreshableCloneConfig")]
public PluggableDatabaseRefreshableCloneConfig RefreshableCloneConfig { get; set; }
Property Value
Type Description
PluggableDatabaseRefreshableCloneConfig

TimeCreated

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

The date and time the pluggable database was created.

Remarks

Required

In this article
Back to top