Package com.oracle.bmc.database.model

Class PluggableDatabase.Builder

java.lang.Object

com.oracle.bmc.database.model.PluggableDatabase.Builder

Enclosing class:

PluggableDatabase

public static class PluggableDatabase.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PluggableDatabase	build()
PluggableDatabase.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
PluggableDatabase.Builder	connectionStrings(PluggableDatabaseConnectionStrings connectionStrings)
PluggableDatabase.Builder	containerDatabaseId(String containerDatabaseId)	The OCID of the CDB.
PluggableDatabase.Builder	copy(PluggableDatabase model)
PluggableDatabase.Builder	definedTags(Map<String,Map<String,Object>> definedTags)	Defined tags for this resource.
PluggableDatabase.Builder	freeformTags(Map<String,String> freeformTags)	Free-form tags for this resource.
PluggableDatabase.Builder	id(String id)	The OCID of the pluggable database.
PluggableDatabase.Builder	isRestricted(Boolean isRestricted)	The restricted mode of the pluggable database.
PluggableDatabase.Builder	kmsKeyId(String kmsKeyId)	The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
PluggableDatabase.Builder	kmsKeyVersionId(String kmsKeyVersionId)	The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
PluggableDatabase.Builder	lifecycleDetails(String lifecycleDetails)	Detailed message for the lifecycle state.
PluggableDatabase.Builder	lifecycleState(PluggableDatabase.LifecycleState lifecycleState)	The current state of the pluggable database.
PluggableDatabase.Builder	openMode(PluggableDatabase.OpenMode openMode)	Deprecated. Use pluggableDatabaseNodeLevelDetails for OpenMode details.
PluggableDatabase.Builder	pdbName(String pdbName)	The name for the pluggable database (PDB).
PluggableDatabase.Builder	pdbNodeLevelDetails(List<PluggableDatabaseNodeLevelDetails> pdbNodeLevelDetails)	Pluggable Database Node Level Details.
PluggableDatabase.Builder	pluggableDatabaseManagementConfig(PluggableDatabaseManagementConfig pluggableDatabaseManagementConfig)
PluggableDatabase.Builder	refreshableCloneConfig(PluggableDatabaseRefreshableCloneConfig refreshableCloneConfig)
PluggableDatabase.Builder	systemTags(Map<String,Map<String,Object>> systemTags)	System tags for this resource.
PluggableDatabase.Builder	timeCreated(Date timeCreated)	The date and time the pluggable database was created.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

id

public PluggableDatabase.Builder id(String id)

The OCID of the pluggable database.

Parameters:

id - the value to set

Returns:

this builder

containerDatabaseId

public PluggableDatabase.Builder containerDatabaseId(String containerDatabaseId)

The OCID of the CDB.

Parameters:

containerDatabaseId - the value to set

Returns:

this builder

pdbName

public PluggableDatabase.Builder pdbName(String pdbName)

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.

Parameters:

pdbName - the value to set

Returns:

this builder

lifecycleState

public PluggableDatabase.Builder lifecycleState(PluggableDatabase.LifecycleState lifecycleState)

The current state of the pluggable database.

Parameters:

lifecycleState - the value to set

Returns:

this builder

lifecycleDetails

public PluggableDatabase.Builder lifecycleDetails(String lifecycleDetails)

Detailed message for the lifecycle state.

Parameters:

lifecycleDetails - the value to set

Returns:

this builder

timeCreated

public PluggableDatabase.Builder timeCreated(Date timeCreated)

The date and time the pluggable database was created.

Parameters:

timeCreated - the value to set

Returns:

this builder

connectionStrings

public PluggableDatabase.Builder connectionStrings(PluggableDatabaseConnectionStrings connectionStrings)

openMode

public PluggableDatabase.Builder openMode(PluggableDatabase.OpenMode openMode)

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

Parameters:

openMode - the value to set

Returns:

this builder

isRestricted

public PluggableDatabase.Builder isRestricted(Boolean isRestricted)

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.

Parameters:

isRestricted - the value to set

Returns:

this builder

compartmentId

public PluggableDatabase.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder

freeformTags

public PluggableDatabase.Builder freeformTags(Map<String,String> freeformTags)

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"}

Parameters:

freeformTags - the value to set

Returns:

this builder

definedTags

public PluggableDatabase.Builder definedTags(Map<String,Map<String,Object>> definedTags)

Defined tags for this resource.

Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Parameters:

definedTags - the value to set

Returns:

this builder

systemTags

public PluggableDatabase.Builder systemTags(Map<String,Map<String,Object>> systemTags)

System tags for this resource.

Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Parameters:

systemTags - the value to set

Returns:

this builder

pluggableDatabaseManagementConfig

public PluggableDatabase.Builder pluggableDatabaseManagementConfig(PluggableDatabaseManagementConfig pluggableDatabaseManagementConfig)

kmsKeyId

public PluggableDatabase.Builder kmsKeyId(String kmsKeyId)

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

Parameters:

kmsKeyId - the value to set

Returns:

this builder

kmsKeyVersionId

public PluggableDatabase.Builder kmsKeyVersionId(String kmsKeyVersionId)

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 AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances.

Parameters:

kmsKeyVersionId - the value to set

Returns:

this builder

refreshableCloneConfig

public PluggableDatabase.Builder refreshableCloneConfig(PluggableDatabaseRefreshableCloneConfig refreshableCloneConfig)

pdbNodeLevelDetails

public PluggableDatabase.Builder pdbNodeLevelDetails(List<PluggableDatabaseNodeLevelDetails> pdbNodeLevelDetails)

Pluggable Database Node Level Details.

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

Parameters:

pdbNodeLevelDetails - the value to set

Returns:

this builder

build

public PluggableDatabase build()

copy

public PluggableDatabase.Builder copy(PluggableDatabase model)