MongoClientSettings.Builder

java.lang.Object
- com.mongodb.async.client.MongoClientSettings.Builder

Enclosing class:

MongoClientSettings
```
@NotThreadSafe
public static final class MongoClientSettings.Builder
extends Object
```
A builder for MongoClientSettings so that MongoClientSettings can be immutable, and to support easier construction through chaining.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`MongoClientSettings.Builder`	`addCommandListener(CommandListener commandListener)`	Adds the given command listener.
`MongoClientSettings.Builder`	`applicationName(String applicationName)`	Sets the logical name of the application using this MongoClient.
`MongoClientSettings.Builder`	`applyConnectionString(ConnectionString connectionString)`	Takes the settings from the given `ConnectionString` and applies them to the builder
`MongoClientSettings.Builder`	`applyToClusterSettings(Block<ClusterSettings.Builder> block)`	Applies the `ClusterSettings.Builder` block and then sets the clusterSettings.
`MongoClientSettings.Builder`	`applyToConnectionPoolSettings(Block<ConnectionPoolSettings.Builder> block)`	Applies the `ConnectionPoolSettings.Builder` block and then sets the connectionPoolSettings.
`MongoClientSettings.Builder`	`applyToServerSettings(Block<ServerSettings.Builder> block)`	Applies the `ServerSettings.Builder` block and then sets the serverSettings.
`MongoClientSettings.Builder`	`applyToSocketSettings(Block<SocketSettings.Builder> block)`	Applies the `SocketSettings.Builder` block and then sets the socketSettings.
`MongoClientSettings.Builder`	`applyToSslSettings(Block<SslSettings.Builder> block)`	Applies the `SslSettings.Builder` block and then sets the sslSettings.
`MongoClientSettings`	`build()`	Build an instance of `MongoClientSettings`.
`MongoClientSettings.Builder`	`clusterSettings(ClusterSettings clusterSettings)`	Deprecated. Prefer `applyToClusterSettings(Block)`
`MongoClientSettings.Builder`	`codecRegistry(CodecRegistry codecRegistry)`	Sets the codec registry
`MongoClientSettings.Builder`	`compressorList(List<MongoCompressor> compressorList)`	Sets the compressors to use for compressing messages to the server.
`MongoClientSettings.Builder`	`connectionPoolSettings(ConnectionPoolSettings connectionPoolSettings)`	Deprecated. Prefer `applyToConnectionPoolSettings(Block)`
`MongoClientSettings.Builder`	`credential(MongoCredential credential)`	Sets the credential.
`MongoClientSettings.Builder`	`credentialList(List<MongoCredential> credentialList)`	Deprecated. Prefer `credential(MongoCredential)`
`MongoClientSettings.Builder`	`heartbeatSocketSettings(SocketSettings heartbeatSocketSettings)`	Deprecated. configuring heartbeatSocketSettings will be removed in the future.
`MongoClientSettings.Builder`	`readConcern(ReadConcern readConcern)`	Sets the read concern.
`MongoClientSettings.Builder`	`readPreference(ReadPreference readPreference)`	Sets the read preference.
`MongoClientSettings.Builder`	`retryWrites(boolean retryWrites)`	Sets whether writes should be retried if they fail due to a network error.
`MongoClientSettings.Builder`	`serverSettings(ServerSettings serverSettings)`	Deprecated. Prefer `applyToServerSettings(Block)`
`MongoClientSettings.Builder`	`socketSettings(SocketSettings socketSettings)`	Deprecated. Prefer `applyToSocketSettings(Block)`
`MongoClientSettings.Builder`	`sslSettings(SslSettings sslSettings)`	Deprecated. Prefer `applyToSslSettings(Block)`
`MongoClientSettings.Builder`	`streamFactoryFactory(StreamFactoryFactory streamFactoryFactory)`	Sets the factory to use to create a `StreamFactory`.
`MongoClientSettings.Builder`	`writeConcern(WriteConcern writeConcern)`	Sets the write concern.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - applyConnectionString
```
public MongoClientSettings.Builder applyConnectionString(ConnectionString connectionString)
```
    Takes the settings from the given ConnectionString and applies them to the builder
    
    Parameters:
    
    connectionString - the connection string containing details of how to connect to MongoDB
    
    Returns:
    
    this
    
    Since:
    
    3.7
  - applyToClusterSettings
```
public MongoClientSettings.Builder applyToClusterSettings(Block<ClusterSettings.Builder> block)
```
    Applies the ClusterSettings.Builder block and then sets the clusterSettings.
    
    Parameters:
    
    block - the block to apply to the ClusterSettings.
    
    Returns:
    
    this
    
    Since:
    
    3.7
    
    See Also:
    
    MongoClientSettings.getClusterSettings()
  - applyToSocketSettings
```
public MongoClientSettings.Builder applyToSocketSettings(Block<SocketSettings.Builder> block)
```
    Applies the SocketSettings.Builder block and then sets the socketSettings.
    
    Parameters:
    
    block - the block to apply to the SocketSettings.
    
    Returns:
    
    this
    
    Since:
    
    3.7
    
    See Also:
    
    MongoClientSettings.getSocketSettings()
  - applyToConnectionPoolSettings
```
public MongoClientSettings.Builder applyToConnectionPoolSettings(Block<ConnectionPoolSettings.Builder> block)
```
    Applies the ConnectionPoolSettings.Builder block and then sets the connectionPoolSettings.
    
    Parameters:
    
    block - the block to apply to the ConnectionPoolSettings.
    
    Returns:
    
    this
    
    Since:
    
    3.7
    
    See Also:
    
    MongoClientSettings.getConnectionPoolSettings()
  - applyToServerSettings
```
public MongoClientSettings.Builder applyToServerSettings(Block<ServerSettings.Builder> block)
```
    Applies the ServerSettings.Builder block and then sets the serverSettings.
    
    Parameters:
    
    block - the block to apply to the ServerSettings.
    
    Returns:
    
    this
    
    Since:
    
    3.7
    
    See Also:
    
    MongoClientSettings.getServerSettings()
  - applyToSslSettings
```
public MongoClientSettings.Builder applyToSslSettings(Block<SslSettings.Builder> block)
```
    Applies the SslSettings.Builder block and then sets the sslSettings.
    
    Parameters:
    
    block - the block to apply to the SslSettings.
    
    Returns:
    
    this
    
    Since:
    
    3.7
    
    See Also:
    
    MongoClientSettings.getSslSettings()
  - clusterSettings
```
@Deprecated
public MongoClientSettings.Builder clusterSettings(ClusterSettings clusterSettings)
```
    Deprecated. Prefer applyToClusterSettings(Block)
    
    Sets the cluster settings.
    
    Parameters:
    
    clusterSettings - the cluster settings
    
    Returns:
    
    this
    
    See Also:
    
    MongoClientSettings.getClusterSettings()
  - socketSettings
```
@Deprecated
public MongoClientSettings.Builder socketSettings(SocketSettings socketSettings)
```
    Deprecated. Prefer applyToSocketSettings(Block)
    
    Sets the socket settings.
    
    Parameters:
    
    socketSettings - the socket settings
    
    Returns:
    
    this
    
    See Also:
    
    MongoClientSettings.getSocketSettings()
  - heartbeatSocketSettings
```
@Deprecated
public MongoClientSettings.Builder heartbeatSocketSettings(SocketSettings heartbeatSocketSettings)
```
    Deprecated. configuring heartbeatSocketSettings will be removed in the future.
    
    Sets the heartbeat socket settings.
    
    Parameters:
    
    heartbeatSocketSettings - the socket settings
    
    Returns:
    
    this
    
    See Also:
    
    MongoClientSettings.getHeartbeatSocketSettings()
  - connectionPoolSettings
```
@Deprecated
public MongoClientSettings.Builder connectionPoolSettings(ConnectionPoolSettings connectionPoolSettings)
```
    Deprecated. Prefer applyToConnectionPoolSettings(Block)
    
    Sets the connection pool settings.
    
    Parameters:
    
    connectionPoolSettings - the connection settings
    
    Returns:
    
    this
    
    See Also:
    
    ()
  - serverSettings
```
@Deprecated
public MongoClientSettings.Builder serverSettings(ServerSettings serverSettings)
```
    Deprecated. Prefer applyToServerSettings(Block)
    
    Sets the server settings.
    
    Parameters:
    
    serverSettings - the server settings
    
    Returns:
    
    this
    
    See Also:
    
    ()
  - sslSettings
```
@Deprecated
public MongoClientSettings.Builder sslSettings(SslSettings sslSettings)
```
    Deprecated. Prefer applyToSslSettings(Block)
    
    Sets the socket settings.
    
    Parameters:
    
    sslSettings - the SSL settings
    
    Returns:
    
    this
    
    See Also:
    
    ()
  - readPreference
```
public MongoClientSettings.Builder readPreference(ReadPreference readPreference)
```
    Sets the read preference.
    
    Parameters:
    
    readPreference - read preference
    
    Returns:
    
    this
    
    See Also:
    
    MongoClientSettings.getReadPreference()
  - writeConcern
```
public MongoClientSettings.Builder writeConcern(WriteConcern writeConcern)
```
    Sets the write concern.
    
    Parameters:
    
    writeConcern - the write concern
    
    Returns:
    
    this
    
    See Also:
    
    MongoClientSettings.getWriteConcern()
  - retryWrites
```
public MongoClientSettings.Builder retryWrites(boolean retryWrites)
```
    Sets whether writes should be retried if they fail due to a network error.
    
    Parameters:
    
    retryWrites - sets if writes should be retried if they fail due to a network error.
    
    Returns:
    
    this
    
    Since:
    
    3.6
    
    See Also:
    
    MongoClientSettings.getRetryWrites()
    
    Since server release
    3.6
  - readConcern
```
public MongoClientSettings.Builder readConcern(ReadConcern readConcern)
```
    Sets the read concern.
    
    Parameters:
    
    readConcern - the read concern
    
    Returns:
    
    this
    
    Since:
    
    3.2
    
    MongoDB documentation
    Read Concern
    Since server release
    3.2
  - credentialList
```
@Deprecated
public MongoClientSettings.Builder credentialList(List<MongoCredential> credentialList)
```
    Deprecated. Prefer credential(MongoCredential)
    
    Sets the credential list.
    
    Parameters:
    
    credentialList - the credential list
    
    Returns:
    
    this
    
    See Also:
    
    MongoClientSettings.getCredentialList()
  - credential
```
public MongoClientSettings.Builder credential(MongoCredential credential)
```
    Sets the credential.
    
    Parameters:
    
    credential - the credential
    
    Returns:
    
    this
    
    Since:
    
    3.6
    
    See Also:
    
    MongoClientSettings.getCredential()
  - codecRegistry
```
public MongoClientSettings.Builder codecRegistry(CodecRegistry codecRegistry)
```
    Sets the codec registry
    
    Parameters:
    
    codecRegistry - the codec registry
    
    Returns:
    
    this
    
    Since:
    
    3.0
    
    See Also:
    
    MongoClientSettings.getCodecRegistry()
  - streamFactoryFactory
```
public MongoClientSettings.Builder streamFactoryFactory(StreamFactoryFactory streamFactoryFactory)
```
    Sets the factory to use to create a StreamFactory.
    
    Parameters:
    
    streamFactoryFactory - the stream factory factory
    
    Returns:
    
    this
    
    Since:
    
    3.1
  - addCommandListener
```
public MongoClientSettings.Builder addCommandListener(CommandListener commandListener)
```
    Adds the given command listener.
    
    Parameters:
    
    commandListener - the command listener
    
    Returns:
    
    this
    
    Since:
    
    3.3
  - applicationName
```
public MongoClientSettings.Builder applicationName(String applicationName)
```
    Sets the logical name of the application using this MongoClient. The application name may be used by the client to identify the application to the server, for use in server logs, slow query logs, and profile collection.
    
    Parameters:
    
    applicationName - the logical name of the application using this MongoClient. It may be null. The UTF-8 encoding may not exceed 128 bytes.
    
    Returns:
    
    this
    
    Since:
    
    3.4
    
    See Also:
    
    MongoClientSettings.getApplicationName()
    
    Since server release
    3.4
  - compressorList
```
public MongoClientSettings.Builder compressorList(List<MongoCompressor> compressorList)
```
    Sets the compressors to use for compressing messages to the server. The driver will use the first compressor in the list that the server is configured to support.
    
    Parameters:
    
    compressorList - the list of compressors to request
    
    Returns:
    
    this
    
    Since:
    
    3.6
    
    See Also:
    
    ()
    
    Since server release
    3.4
  - build
```
public MongoClientSettings build()
```
    Build an instance of MongoClientSettings.
    
    Returns:
    
    the settings from this builder

Class MongoClientSettings.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

applyConnectionString

applyToClusterSettings

applyToSocketSettings

applyToConnectionPoolSettings

applyToServerSettings

applyToSslSettings

clusterSettings

socketSettings

heartbeatSocketSettings

connectionPoolSettings

serverSettings

sslSettings

readPreference

writeConcern

retryWrites

readConcern

credentialList

credential

codecRegistry

streamFactoryFactory

addCommandListener

applicationName

compressorList

build