Database.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.database.model.Database.Builder

Enclosing class:: Database

public static class Database.Builder
extends Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Database`	`build()`
`Database.Builder`	`characterSet(String characterSet)` The character set for the database.
`Database.Builder`	`compartmentId(String compartmentId)` The OCID of the compartment.
`Database.Builder`	`connectionStrings(DatabaseConnectionStrings connectionStrings)` The Connection strings used to connect to the Oracle Database.
`Database.Builder`	`copy(Database model)`
`Database.Builder`	`databaseManagementConfig(CloudDatabaseManagementConfig databaseManagementConfig)`
`Database.Builder`	`databaseSoftwareImageId(String databaseSoftwareImageId)` The database software image OCID
`Database.Builder`	`dbBackupConfig(DbBackupConfig dbBackupConfig)`
`Database.Builder`	`dbHomeId(String dbHomeId)` The OCID of the Database Home.
`Database.Builder`	`dbName(String dbName)` The database name.
`Database.Builder`	`dbSystemId(String dbSystemId)` The OCID of the DB system.
`Database.Builder`	`dbUniqueName(String dbUniqueName)` A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases).
`Database.Builder`	`dbWorkload(String dbWorkload)` Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service.
`Database.Builder`	`definedTags(Map<String,Map<String,Object>> definedTags)` Defined tags for this resource.
`Database.Builder`	`freeformTags(Map<String,String> freeformTags)` Free-form tags for this resource.
`Database.Builder`	`id(String id)` The OCID of the database.
`Database.Builder`	`isCdb(Boolean isCdb)` True if the database is a container database.
`Database.Builder`	`keyStoreId(String keyStoreId)` The OCID of the key store of Oracle Vault.
`Database.Builder`	`keyStoreWalletName(String keyStoreWalletName)` The wallet name for Oracle Key Vault.
`Database.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.
`Database.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.
`Database.Builder`	`lastBackupDurationInSeconds(Integer lastBackupDurationInSeconds)` The duration when the latest database backup created.
`Database.Builder`	`lastBackupTimestamp(Date lastBackupTimestamp)` The date and time when the latest database backup was created.
`Database.Builder`	`lastFailedBackupTimestamp(Date lastFailedBackupTimestamp)` The date and time when the latest database backup failed.
`Database.Builder`	`lifecycleDetails(String lifecycleDetails)` Additional information about the current lifecycle state.
`Database.Builder`	`lifecycleState(Database.LifecycleState lifecycleState)` The current state of the database.
`Database.Builder`	`ncharacterSet(String ncharacterSet)` The national character set for the database.
`Database.Builder`	`pdbName(String pdbName)` The name of the pluggable database.
`Database.Builder`	`sidPrefix(String sidPrefix)` Specifies a prefix for the `Oracle SID` of the database to be created.
`Database.Builder`	`sourceDatabasePointInTimeRecoveryTimestamp(Date sourceDatabasePointInTimeRecoveryTimestamp)` 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
`Database.Builder`	`timeCreated(Date timeCreated)` The date and time the database was created.
`Database.Builder`	`vaultId(String vaultId)` The OCID of the Oracle Cloud Infrastructure vault.
`Database.Builder`	`vmClusterId(String vmClusterId)` The OCID of the VM cluster.

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 Database.Builder id(String id)
```
    The OCID of the database.
    
    Parameters:
    
    id - the value to set
    
    Returns:
    
    this builder
  - compartmentId
```
public Database.Builder compartmentId(String compartmentId)
```
    The OCID of the compartment.
    
    Parameters:
    
    compartmentId - the value to set
    
    Returns:
    
    this builder
  - characterSet
```
public Database.Builder characterSet(String characterSet)
```
    The character set for the database.
    
    Parameters:
    
    characterSet - the value to set
    
    Returns:
    
    this builder
  - ncharacterSet
```
public Database.Builder ncharacterSet(String ncharacterSet)
```
    The national character set for the database.
    
    Parameters:
    
    ncharacterSet - the value to set
    
    Returns:
    
    this builder
  - dbHomeId
```
public Database.Builder dbHomeId(String dbHomeId)
```
    The OCID of the Database Home.
    
    Parameters:
    
    dbHomeId - the value to set
    
    Returns:
    
    this builder
  - dbSystemId
```
public Database.Builder dbSystemId(String dbSystemId)
```
    The OCID of the DB system.
    
    Parameters:
    
    dbSystemId - the value to set
    
    Returns:
    
    this builder
  - vmClusterId
```
public Database.Builder vmClusterId(String vmClusterId)
```
    The OCID of the VM cluster.
    
    Parameters:
    
    vmClusterId - the value to set
    
    Returns:
    
    this builder
  - dbName
```
public Database.Builder dbName(String dbName)
```
    The database name.
    
    Parameters:
    
    dbName - the value to set
    
    Returns:
    
    this builder
  - pdbName
```
public Database.Builder pdbName(String pdbName)
```
    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.
    
    Parameters:
    
    pdbName - the value to set
    
    Returns:
    
    this builder
  - dbWorkload
```
public Database.Builder dbWorkload(String dbWorkload)
```
    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.
    
    The database workload type.
    
    Parameters:
    
    dbWorkload - the value to set
    
    Returns:
    
    this builder
  - dbUniqueName
```
public Database.Builder dbUniqueName(String dbUniqueName)
```
    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.
    
    Parameters:
    
    dbUniqueName - the value to set
    
    Returns:
    
    this builder
  - lifecycleDetails
```
public Database.Builder lifecycleDetails(String lifecycleDetails)
```
    Additional information about the current lifecycle state.
    
    Parameters:
    
    lifecycleDetails - the value to set
    
    Returns:
    
    this builder
  - lifecycleState
```
public Database.Builder lifecycleState(Database.LifecycleState lifecycleState)
```
    The current state of the database.
    
    Parameters:
    
    lifecycleState - the value to set
    
    Returns:
    
    this builder
  - timeCreated
```
public Database.Builder timeCreated(Date timeCreated)
```
    The date and time the database was created.
    
    Parameters:
    
    timeCreated - the value to set
    
    Returns:
    
    this builder
  - lastBackupTimestamp
```
public Database.Builder lastBackupTimestamp(Date lastBackupTimestamp)
```
    The date and time when the latest database backup was created.
    
    Parameters:
    
    lastBackupTimestamp - the value to set
    
    Returns:
    
    this builder
  - lastBackupDurationInSeconds
```
public Database.Builder lastBackupDurationInSeconds(Integer lastBackupDurationInSeconds)
```
    The duration when the latest database backup created.
    
    Parameters:
    
    lastBackupDurationInSeconds - the value to set
    
    Returns:
    
    this builder
  - lastFailedBackupTimestamp
```
public Database.Builder lastFailedBackupTimestamp(Date lastFailedBackupTimestamp)
```
    The date and time when the latest database backup failed.
    
    Parameters:
    
    lastFailedBackupTimestamp - the value to set
    
    Returns:
    
    this builder
  - dbBackupConfig
```
public Database.Builder dbBackupConfig(DbBackupConfig dbBackupConfig)
```
  - freeformTags
```
public Database.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 Database.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
  - connectionStrings
```
public Database.Builder connectionStrings(DatabaseConnectionStrings connectionStrings)
```
    The Connection strings used to connect to the Oracle Database.
    
    Parameters:
    
    connectionStrings - the value to set
    
    Returns:
    
    this builder
  - kmsKeyId
```
public Database.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 Database.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 Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
    
    Parameters:
    
    kmsKeyVersionId - the value to set
    
    Returns:
    
    this builder
  - vaultId
```
public Database.Builder vaultId(String vaultId)
```
    The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.
    
    Parameters:
    
    vaultId - the value to set
    
    Returns:
    
    this builder
  - sourceDatabasePointInTimeRecoveryTimestamp
```
public Database.Builder sourceDatabasePointInTimeRecoveryTimestamp(Date sourceDatabasePointInTimeRecoveryTimestamp)
```
    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
    
    Parameters:
    
    sourceDatabasePointInTimeRecoveryTimestamp - the value to set
    
    Returns:
    
    this builder
  - databaseSoftwareImageId
```
public Database.Builder databaseSoftwareImageId(String databaseSoftwareImageId)
```
    The database software image OCID
    
    Parameters:
    
    databaseSoftwareImageId - the value to set
    
    Returns:
    
    this builder
  - isCdb
```
public Database.Builder isCdb(Boolean isCdb)
```
    True if the database is a container database.
    
    Parameters:
    
    isCdb - the value to set
    
    Returns:
    
    this builder
  - databaseManagementConfig
```
public Database.Builder databaseManagementConfig(CloudDatabaseManagementConfig databaseManagementConfig)
```
  - sidPrefix
```
public Database.Builder sidPrefix(String sidPrefix)
```
    Specifies a prefix for the Oracle SID of the database to be created.
    
    Parameters:
    
    sidPrefix - the value to set
    
    Returns:
    
    this builder
  - keyStoreId
```
public Database.Builder keyStoreId(String keyStoreId)
```
    The OCID of the key store of Oracle Vault.
    
    Parameters:
    
    keyStoreId - the value to set
    
    Returns:
    
    this builder
  - keyStoreWalletName
```
public Database.Builder keyStoreWalletName(String keyStoreWalletName)
```
    The wallet name for Oracle Key Vault.
    
    Parameters:
    
    keyStoreWalletName - the value to set
    
    Returns:
    
    this builder
  - build
```
public Database build()
```
  - copy
```
public Database.Builder copy(Database model)
```

Class Database.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

id

compartmentId

characterSet

ncharacterSet

dbHomeId

dbSystemId

vmClusterId

dbName

pdbName

dbWorkload

dbUniqueName

lifecycleDetails

lifecycleState

timeCreated

lastBackupTimestamp

lastBackupDurationInSeconds

lastFailedBackupTimestamp

dbBackupConfig

freeformTags

definedTags

connectionStrings

kmsKeyId

kmsKeyVersionId

vaultId

sourceDatabasePointInTimeRecoveryTimestamp

databaseSoftwareImageId

isCdb

databaseManagementConfig

sidPrefix

keyStoreId

keyStoreWalletName

build

copy