Package com.oracle.bmc.database.model

Class PluggableDatabase

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

    • Method Detail

      • getId

        public String getId()
        The OCID of the pluggable database.
        Returns:
        the value

      • getContainerDatabaseId

        public String getContainerDatabaseId()
        The OCID of the CDB.
        Returns:
        the value

      • getPdbName

        public String getPdbName()
        The name for the pluggable database (PDB).

        The name is unique in the context of a 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.

        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        Detailed message for the lifecycle state.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the pluggable database was created.
        Returns:
        the value

      • getOpenMode

        public PluggableDatabase.OpenMode getOpenMode()
        Deprecated. Use 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).

        Returns:
        the value

      • getIsRestricted

        public Boolean getIsRestricted()
        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.

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment.
        Returns:
        the value

      • 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

      • 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

      • getPdbNodeLevelDetails

        public List<PluggableDatabaseNodeLevelDetails> getPdbNodeLevelDetails()
        Pluggable Database Node Level Details.

        Example: [{“nodeName” : “node1”, “openMode” : “READ_WRITE”}, {“nodeName” : “node2”, “openMode” : “READ_ONLY”}]

        Returns:
        the value

      • 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