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
Modifier and Type	Method and 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`	`build()` Build an instance of `MongoClientSettings`.
`MongoClientSettings.Builder`	`clusterSettings(ClusterSettings clusterSettings)` Sets the cluster settings.
`MongoClientSettings.Builder`	`codecRegistry(CodecRegistry codecRegistry)` Sets the codec registry
`MongoClientSettings.Builder`	`connectionPoolSettings(ConnectionPoolSettings connectionPoolSettings)` Sets the connection pool settings.
`MongoClientSettings.Builder`	`credentialList(List<MongoCredential> credentialList)` Sets the credential list.
`MongoClientSettings.Builder`	`heartbeatSocketSettings(SocketSettings heartbeatSocketSettings)` Sets the heartbeat socket settings.
`MongoClientSettings.Builder`	`readConcern(ReadConcern readConcern)` Sets the read concern.
`MongoClientSettings.Builder`	`readPreference(ReadPreference readPreference)` Sets the read preference.
`MongoClientSettings.Builder`	`serverSettings(ServerSettings serverSettings)` Sets the server settings.
`MongoClientSettings.Builder`	`socketSettings(SocketSettings socketSettings)` Sets the socket settings.
`MongoClientSettings.Builder`	`sslSettings(SslSettings sslSettings)` Sets the socket settings.
`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
  - clusterSettings
```
public MongoClientSettings.Builder clusterSettings(ClusterSettings clusterSettings)
```
    Sets the cluster settings.
    
    Parameters:
    
    clusterSettings - the cluster settings
    
    Returns:
    
    this
    
    See Also:
    
    MongoClientSettings.getClusterSettings()
  - socketSettings
```
public MongoClientSettings.Builder socketSettings(SocketSettings socketSettings)
```
    Sets the socket settings.
    
    Parameters:
    
    socketSettings - the socket settings
    
    Returns:
    
    this
    
    See Also:
    
    MongoClientSettings.getSocketSettings()
  - heartbeatSocketSettings
```
public MongoClientSettings.Builder heartbeatSocketSettings(SocketSettings heartbeatSocketSettings)
```
    Sets the heartbeat socket settings.
    
    Parameters:
    
    heartbeatSocketSettings - the socket settings
    
    Returns:
    
    this
    
    See Also:
    
    MongoClientSettings.getHeartbeatSocketSettings()
  - connectionPoolSettings
```
public MongoClientSettings.Builder connectionPoolSettings(ConnectionPoolSettings connectionPoolSettings)
```
    Sets the connection pool settings.
    
    Parameters:
    
    connectionPoolSettings - the connection settings
    
    Returns:
    
    this
    
    See Also:
    
    ()
  - serverSettings
```
public MongoClientSettings.Builder serverSettings(ServerSettings serverSettings)
```
    Sets the server settings.
    
    Parameters:
    
    serverSettings - the server settings
    
    Returns:
    
    this
    
    See Also:
    
    ()
  - sslSettings
```
public MongoClientSettings.Builder sslSettings(SslSettings sslSettings)
```
    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()
  - 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
```
public MongoClientSettings.Builder credentialList(List<MongoCredential> credentialList)
```
    Sets the credential list.
    
    Parameters:
    
    credentialList - the credential list
    
    Returns:
    
    this
    
    See Also:
    
    MongoClientSettings.getCredentialList()
  - 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
  - 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

clusterSettings

socketSettings

heartbeatSocketSettings

connectionPoolSettings

serverSettings

sslSettings

readPreference

writeConcern

readConcern

credentialList

codecRegistry

streamFactoryFactory

addCommandListener

applicationName

build