Class DistributedDatabase.Builder
- java.lang.Object
-
- com.oracle.bmc.distributeddatabasev26.model.DistributedDatabase.Builder
-
- Enclosing class:
- DistributedDatabase
public static class DistributedDatabase.Builder extends Object
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DistributedDatabase.BuilderautoResourceManagementConfig(AutoResourceManagementConfigurationDetails autoResourceManagementConfig)DistributedDatabasebuild()DistributedDatabase.BuildercatalogDetails(List<DistributedDatabaseCatalog> catalogDetails)Catalog details associated with the distributed database.DistributedDatabase.BuildercharacterSet(String characterSet)The character set for the database.DistributedDatabase.BuildercompartmentId(String compartmentId)The OCID of the Globally distributed database compartment.DistributedDatabase.BuildercompositeDataGuardShardSpaces(List<CompositeDataGuardShardSpace> compositeDataGuardShardSpaces)Collection of composite data guard shard spaces.DistributedDatabase.BuildercompositeRaftShardSpaces(List<CompositeRaftShardSpace> compositeRaftShardSpaces)Collection of composite raft shards.DistributedDatabase.BuilderconnectionStrings(DistributedDbConnectionString connectionStrings)DistributedDatabase.Buildercopy(DistributedDatabase model)DistributedDatabase.BuilderdatabaseVersion(String databaseVersion)Oracle Database version for the shards and catalog used in Globally distributed database.DistributedDatabase.BuilderdbBackupConfig(DistributedDbBackupConfig dbBackupConfig)DistributedDatabase.BuilderdbDeploymentType(DistributedDatabase.DbDeploymentType dbDeploymentType)The distributed database deployment type.DistributedDatabase.BuilderdefinedTags(Map<String,Map<String,Object>> definedTags)Defined tags for this resource.DistributedDatabase.BuilderdisplayName(String displayName)The display name of the Globally distributed database.DistributedDatabase.BuilderfreeformTags(Map<String,String> freeformTags)Simple key-value pair that is applied without any predefined name, type or scope.DistributedDatabase.BuildergdsControlNodeDetails(List<DistributedDatabaseGdsControlNode> gdsControlNodeDetails)Global Database Services Control(GDS CTL) instances associated with the distributed database.DistributedDatabase.BuildergsmDetails(List<DistributedDatabaseGsm> gsmDetails)Global Service Manager (GSM) instances associated with the distributed database.DistributedDatabase.BuildergsmSshPublicKey(String gsmSshPublicKey)The SSH public key for Global service manager instances.DistributedDatabase.Builderid(String id)The OCID of the Globally distributed database.DistributedDatabase.BuilderlatestGsmImageDetails(DistributedDbGsmImage latestGsmImageDetails)DistributedDatabase.BuilderlifecycleDetails(String lifecycleDetails)The lifecycleDetails for the Globally distributed database.DistributedDatabase.BuilderlifecycleState(DistributedDatabase.LifecycleState lifecycleState)Lifecycle states for the Globally distributed database.DistributedDatabase.BuilderlistenerPort(Integer listenerPort)The Global service manager listener port number for the Globally distributed database.DistributedDatabase.BuilderlistenerPortTls(Integer listenerPortTls)The TLS listener port number for Globally distributed database.DistributedDatabase.Buildermetadata(DistributedDbMetadata metadata)DistributedDatabase.BuilderncharacterSet(String ncharacterSet)The national character set for the database.DistributedDatabase.BuildernotificationTopicIds(List<String> notificationTopicIds)The collection of OCID for the notification topics associated with the globally distributed database.DistributedDatabase.BuilderonsPortLocal(Integer onsPortLocal)Ons local port number.DistributedDatabase.BuilderonsPortRemote(Integer onsPortRemote)Ons remote port number.DistributedDatabase.Builderprefix(String prefix)Unique name prefix for the Globally distributed databases.DistributedDatabase.BuilderprivateEndpointIds(List<String> privateEndpointIds)The collection of OCID of the private endpoint associated with Globally distributed autonomous database.DistributedDatabase.BuilderreplicationMethod(DistributedDatabase.ReplicationMethod replicationMethod)The Replication method for Globally distributed database.DistributedDatabase.BuilderscanListenerPort(Integer scanListenerPort)The TCP SCAN listener port for database clusters with source type XS_NEW_VAULT_AND_CLUSTER or XS_NEW_CLUSTER.DistributedDatabase.BuildershardingMethod(DistributedDatabase.ShardingMethod shardingMethod)Sharding methods for the Globally distributed database.DistributedDatabase.BuildersystemChunkCount(Integer systemChunkCount)Count of chunks associated with system raft clusters or system data guard databases.DistributedDatabase.BuildersystemDataGuardDatabases(SystemDataGuardDatabase systemDataGuardDatabases)DistributedDatabase.BuildersystemRaftClusters(List<SystemRaftCluster> systemRaftClusters)Collection of system raft clusters.DistributedDatabase.BuildersystemRaftReplicationUnitCount(Integer systemRaftReplicationUnitCount)Number of replication units associated with system raft clusters.DistributedDatabase.BuildersystemTags(Map<String,Map<String,Object>> systemTags)Usage of system tag keys.DistributedDatabase.BuildertimeCreated(Date timeCreated)The time the Globally distributed database was created.DistributedDatabase.BuildertimeUpdated(Date timeUpdated)The time the Globally distributed database was last updated.DistributedDatabase.BuilderuserShardSpaces(List<UserShardSpace> userShardSpaces)Collection of user defined shard spaces.DistributedDatabase.BuildervcnNsgIds(List<VcnNsgIdsDetails> vcnNsgIds)The list of network security group (NSG) details associated with the distributed database.
-
-
-
Method Detail
-
id
public DistributedDatabase.Builder id(String id)
The OCID of the Globally distributed database.- Parameters:
id- the value to set- Returns:
- this builder
-
compartmentId
public DistributedDatabase.Builder compartmentId(String compartmentId)
The OCID of the Globally distributed database compartment.- Parameters:
compartmentId- the value to set- Returns:
- this builder
-
displayName
public DistributedDatabase.Builder displayName(String displayName)
The display name of the Globally distributed database.- Parameters:
displayName- the value to set- Returns:
- this builder
-
timeCreated
public DistributedDatabase.Builder timeCreated(Date timeCreated)
The time the Globally distributed database was created.An RFC3339 formatted datetime string.
- Parameters:
timeCreated- the value to set- Returns:
- this builder
-
timeUpdated
public DistributedDatabase.Builder timeUpdated(Date timeUpdated)
The time the Globally distributed database was last updated.An RFC3339 formatted datetime string.
- Parameters:
timeUpdated- the value to set- Returns:
- this builder
-
databaseVersion
public DistributedDatabase.Builder databaseVersion(String databaseVersion)
Oracle Database version for the shards and catalog used in Globally distributed database.- Parameters:
databaseVersion- the value to set- Returns:
- this builder
-
lifecycleState
public DistributedDatabase.Builder lifecycleState(DistributedDatabase.LifecycleState lifecycleState)
Lifecycle states for the Globally distributed database.- Parameters:
lifecycleState- the value to set- Returns:
- this builder
-
shardingMethod
public DistributedDatabase.Builder shardingMethod(DistributedDatabase.ShardingMethod shardingMethod)
Sharding methods for the Globally distributed database.- Parameters:
shardingMethod- the value to set- Returns:
- this builder
-
replicationMethod
public DistributedDatabase.Builder replicationMethod(DistributedDatabase.ReplicationMethod replicationMethod)
The Replication method for Globally distributed database.Use RAFT for Raft based replication. With RAFT replication, shards cannot have peers details set on them. In case shards need to have peers, please do not set RAFT replicationMethod. For all non RAFT replication cases (with or without peers), please set replicationMethod as DG or do not set any value for replicationMethod.
- Parameters:
replicationMethod- the value to set- Returns:
- this builder
-
dbDeploymentType
public DistributedDatabase.Builder dbDeploymentType(DistributedDatabase.DbDeploymentType dbDeploymentType)
The distributed database deployment type.- Parameters:
dbDeploymentType- the value to set- Returns:
- this builder
-
lifecycleDetails
public DistributedDatabase.Builder lifecycleDetails(String lifecycleDetails)
The lifecycleDetails for the Globally distributed database.- Parameters:
lifecycleDetails- the value to set- Returns:
- this builder
-
connectionStrings
public DistributedDatabase.Builder connectionStrings(DistributedDbConnectionString connectionStrings)
-
prefix
public DistributedDatabase.Builder prefix(String prefix)
Unique name prefix for the Globally distributed databases.Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- Parameters:
prefix- the value to set- Returns:
- this builder
-
privateEndpointIds
public DistributedDatabase.Builder privateEndpointIds(List<String> privateEndpointIds)
The collection of OCID of the private endpoint associated with Globally distributed autonomous database.- Parameters:
privateEndpointIds- the value to set- Returns:
- this builder
-
notificationTopicIds
public DistributedDatabase.Builder notificationTopicIds(List<String> notificationTopicIds)
The collection of OCID for the notification topics associated with the globally distributed database.- Parameters:
notificationTopicIds- the value to set- Returns:
- this builder
-
latestGsmImageDetails
public DistributedDatabase.Builder latestGsmImageDetails(DistributedDbGsmImage latestGsmImageDetails)
-
characterSet
public DistributedDatabase.Builder characterSet(String characterSet)
The character set for the database.- Parameters:
characterSet- the value to set- Returns:
- this builder
-
ncharacterSet
public DistributedDatabase.Builder ncharacterSet(String ncharacterSet)
The national character set for the database.- Parameters:
ncharacterSet- the value to set- Returns:
- this builder
-
listenerPort
public DistributedDatabase.Builder listenerPort(Integer listenerPort)
The Global service manager listener port number for the Globally distributed database.- Parameters:
listenerPort- the value to set- Returns:
- this builder
-
listenerPortTls
public DistributedDatabase.Builder listenerPortTls(Integer listenerPortTls)
The TLS listener port number for Globally distributed database.- Parameters:
listenerPortTls- the value to set- Returns:
- this builder
-
onsPortLocal
public DistributedDatabase.Builder onsPortLocal(Integer onsPortLocal)
Ons local port number.- Parameters:
onsPortLocal- the value to set- Returns:
- this builder
-
onsPortRemote
public DistributedDatabase.Builder onsPortRemote(Integer onsPortRemote)
Ons remote port number.- Parameters:
onsPortRemote- the value to set- Returns:
- this builder
-
scanListenerPort
public DistributedDatabase.Builder scanListenerPort(Integer scanListenerPort)
The TCP SCAN listener port for database clusters with source type XS_NEW_VAULT_AND_CLUSTER or XS_NEW_CLUSTER.- Parameters:
scanListenerPort- the value to set- Returns:
- this builder
-
systemChunkCount
public DistributedDatabase.Builder systemChunkCount(Integer systemChunkCount)
Count of chunks associated with system raft clusters or system data guard databases.- Parameters:
systemChunkCount- the value to set- Returns:
- this builder
-
systemRaftReplicationUnitCount
public DistributedDatabase.Builder systemRaftReplicationUnitCount(Integer systemRaftReplicationUnitCount)
Number of replication units associated with system raft clusters.- Parameters:
systemRaftReplicationUnitCount- the value to set- Returns:
- this builder
-
compositeRaftShardSpaces
public DistributedDatabase.Builder compositeRaftShardSpaces(List<CompositeRaftShardSpace> compositeRaftShardSpaces)
Collection of composite raft shards.- Parameters:
compositeRaftShardSpaces- the value to set- Returns:
- this builder
-
compositeDataGuardShardSpaces
public DistributedDatabase.Builder compositeDataGuardShardSpaces(List<CompositeDataGuardShardSpace> compositeDataGuardShardSpaces)
Collection of composite data guard shard spaces.- Parameters:
compositeDataGuardShardSpaces- the value to set- Returns:
- this builder
-
systemRaftClusters
public DistributedDatabase.Builder systemRaftClusters(List<SystemRaftCluster> systemRaftClusters)
Collection of system raft clusters.- Parameters:
systemRaftClusters- the value to set- Returns:
- this builder
-
systemDataGuardDatabases
public DistributedDatabase.Builder systemDataGuardDatabases(SystemDataGuardDatabase systemDataGuardDatabases)
-
userShardSpaces
public DistributedDatabase.Builder userShardSpaces(List<UserShardSpace> userShardSpaces)
Collection of user defined shard spaces.- Parameters:
userShardSpaces- the value to set- Returns:
- this builder
-
catalogDetails
public DistributedDatabase.Builder catalogDetails(List<DistributedDatabaseCatalog> catalogDetails)
Catalog details associated with the distributed database.- Parameters:
catalogDetails- the value to set- Returns:
- this builder
-
gsmDetails
public DistributedDatabase.Builder gsmDetails(List<DistributedDatabaseGsm> gsmDetails)
Global Service Manager (GSM) instances associated with the distributed database.- Parameters:
gsmDetails- the value to set- Returns:
- this builder
-
gdsControlNodeDetails
public DistributedDatabase.Builder gdsControlNodeDetails(List<DistributedDatabaseGdsControlNode> gdsControlNodeDetails)
Global Database Services Control(GDS CTL) instances associated with the distributed database.- Parameters:
gdsControlNodeDetails- the value to set- Returns:
- this builder
-
dbBackupConfig
public DistributedDatabase.Builder dbBackupConfig(DistributedDbBackupConfig dbBackupConfig)
-
autoResourceManagementConfig
public DistributedDatabase.Builder autoResourceManagementConfig(AutoResourceManagementConfigurationDetails autoResourceManagementConfig)
-
gsmSshPublicKey
public DistributedDatabase.Builder gsmSshPublicKey(String gsmSshPublicKey)
The SSH public key for Global service manager instances.- Parameters:
gsmSshPublicKey- the value to set- Returns:
- this builder
-
vcnNsgIds
public DistributedDatabase.Builder vcnNsgIds(List<VcnNsgIdsDetails> vcnNsgIds)
The list of network security group (NSG) details associated with the distributed database.- Parameters:
vcnNsgIds- the value to set- Returns:
- this builder
-
metadata
public DistributedDatabase.Builder metadata(DistributedDbMetadata metadata)
-
freeformTags
public DistributedDatabase.Builder freeformTags(Map<String,String> freeformTags)
Simple key-value pair that is applied without any predefined name, type or scope.Exists for cross-compatibility only. Example: {“bar-key”: “value”}
- Parameters:
freeformTags- the value to set- Returns:
- this builder
-
definedTags
public DistributedDatabase.Builder definedTags(Map<String,Map<String,Object>> definedTags)
Defined tags for this resource.Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Parameters:
definedTags- the value to set- Returns:
- this builder
-
systemTags
public DistributedDatabase.Builder systemTags(Map<String,Map<String,Object>> systemTags)
Usage of system tag keys.These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Parameters:
systemTags- the value to set- Returns:
- this builder
-
build
public DistributedDatabase build()
-
copy
public DistributedDatabase.Builder copy(DistributedDatabase model)
-
-