MongoDbSettings (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.databasemigrationservice.model.MongoDbSettings

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MongoDbSettings
extends Object
implements Serializable, Cloneable, StructuredPojo

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MongoDbSettings()

Constructors
Constructor and Description
`MongoDbSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MongoDbSettings`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAuthMechanism()` The authentication mechanism you use to access the MongoDB source endpoint.
`String`	`getAuthSource()` The MongoDB database name.
`String`	`getAuthType()` The authentication type you use to access the MongoDB source endpoint.
`String`	`getDatabaseName()` The database name on the MongoDB source endpoint.
`String`	`getDocsToInvestigate()` Indicates the number of documents to preview to determine the document organization.
`String`	`getExtractDocId()` Specifies the document ID.
`String`	`getNestingLevel()` Specifies either document or table mode.
`String`	`getPassword()` The password for the user account you use to access the MongoDB source endpoint.
`Integer`	`getPort()` The port value for the MongoDB source endpoint.
`String`	`getServerName()` The name of the server on the MongoDB source endpoint.
`String`	`getUsername()` The user name you use to access the MongoDB source endpoint.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAuthMechanism(AuthMechanismValue authMechanism)` The authentication mechanism you use to access the MongoDB source endpoint.
`void`	`setAuthMechanism(String authMechanism)` The authentication mechanism you use to access the MongoDB source endpoint.
`void`	`setAuthSource(String authSource)` The MongoDB database name.
`void`	`setAuthType(AuthTypeValue authType)` The authentication type you use to access the MongoDB source endpoint.
`void`	`setAuthType(String authType)` The authentication type you use to access the MongoDB source endpoint.
`void`	`setDatabaseName(String databaseName)` The database name on the MongoDB source endpoint.
`void`	`setDocsToInvestigate(String docsToInvestigate)` Indicates the number of documents to preview to determine the document organization.
`void`	`setExtractDocId(String extractDocId)` Specifies the document ID.
`void`	`setNestingLevel(NestingLevelValue nestingLevel)` Specifies either document or table mode.
`void`	`setNestingLevel(String nestingLevel)` Specifies either document or table mode.
`void`	`setPassword(String password)` The password for the user account you use to access the MongoDB source endpoint.
`void`	`setPort(Integer port)` The port value for the MongoDB source endpoint.
`void`	`setServerName(String serverName)` The name of the server on the MongoDB source endpoint.
`void`	`setUsername(String username)` The user name you use to access the MongoDB source endpoint.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`MongoDbSettings`	`withAuthMechanism(AuthMechanismValue authMechanism)` The authentication mechanism you use to access the MongoDB source endpoint.
`MongoDbSettings`	`withAuthMechanism(String authMechanism)` The authentication mechanism you use to access the MongoDB source endpoint.
`MongoDbSettings`	`withAuthSource(String authSource)` The MongoDB database name.
`MongoDbSettings`	`withAuthType(AuthTypeValue authType)` The authentication type you use to access the MongoDB source endpoint.
`MongoDbSettings`	`withAuthType(String authType)` The authentication type you use to access the MongoDB source endpoint.
`MongoDbSettings`	`withDatabaseName(String databaseName)` The database name on the MongoDB source endpoint.
`MongoDbSettings`	`withDocsToInvestigate(String docsToInvestigate)` Indicates the number of documents to preview to determine the document organization.
`MongoDbSettings`	`withExtractDocId(String extractDocId)` Specifies the document ID.
`MongoDbSettings`	`withNestingLevel(NestingLevelValue nestingLevel)` Specifies either document or table mode.
`MongoDbSettings`	`withNestingLevel(String nestingLevel)` Specifies either document or table mode.
`MongoDbSettings`	`withPassword(String password)` The password for the user account you use to access the MongoDB source endpoint.
`MongoDbSettings`	`withPort(Integer port)` The port value for the MongoDB source endpoint.
`MongoDbSettings`	`withServerName(String serverName)` The name of the server on the MongoDB source endpoint.
`MongoDbSettings`	`withUsername(String username)` The user name you use to access the MongoDB source endpoint.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MongoDbSettings
```
public MongoDbSettings()
```
- Method Detail
  - setUsername
```
public void setUsername(String username)
```
    The user name you use to access the MongoDB source endpoint.
    
    Parameters:
    
    username - The user name you use to access the MongoDB source endpoint.
  - getUsername
```
public String getUsername()
```
    The user name you use to access the MongoDB source endpoint.
    
    Returns:
    
    The user name you use to access the MongoDB source endpoint.
  - withUsername
```
public MongoDbSettings withUsername(String username)
```
    The user name you use to access the MongoDB source endpoint.
    
    Parameters:
    
    username - The user name you use to access the MongoDB source endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPassword
```
public void setPassword(String password)
```
    The password for the user account you use to access the MongoDB source endpoint.
    
    Parameters:
    
    password - The password for the user account you use to access the MongoDB source endpoint.
  - getPassword
```
public String getPassword()
```
    The password for the user account you use to access the MongoDB source endpoint.
    
    Returns:
    
    The password for the user account you use to access the MongoDB source endpoint.
  - withPassword
```
public MongoDbSettings withPassword(String password)
```
    The password for the user account you use to access the MongoDB source endpoint.
    
    Parameters:
    
    password - The password for the user account you use to access the MongoDB source endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServerName
```
public void setServerName(String serverName)
```
    The name of the server on the MongoDB source endpoint.
    
    Parameters:
    
    serverName - The name of the server on the MongoDB source endpoint.
  - getServerName
```
public String getServerName()
```
    The name of the server on the MongoDB source endpoint.
    
    Returns:
    
    The name of the server on the MongoDB source endpoint.
  - withServerName
```
public MongoDbSettings withServerName(String serverName)
```
    The name of the server on the MongoDB source endpoint.
    
    Parameters:
    
    serverName - The name of the server on the MongoDB source endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPort
```
public void setPort(Integer port)
```
    The port value for the MongoDB source endpoint.
    
    Parameters:
    
    port - The port value for the MongoDB source endpoint.
  - getPort
```
public Integer getPort()
```
    The port value for the MongoDB source endpoint.
    
    Returns:
    
    The port value for the MongoDB source endpoint.
  - withPort
```
public MongoDbSettings withPort(Integer port)
```
    The port value for the MongoDB source endpoint.
    
    Parameters:
    
    port - The port value for the MongoDB source endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDatabaseName
```
public void setDatabaseName(String databaseName)
```
    The database name on the MongoDB source endpoint.
    
    Parameters:
    
    databaseName - The database name on the MongoDB source endpoint.
  - getDatabaseName
```
public String getDatabaseName()
```
    The database name on the MongoDB source endpoint.
    
    Returns:
    
    The database name on the MongoDB source endpoint.
  - withDatabaseName
```
public MongoDbSettings withDatabaseName(String databaseName)
```
    The database name on the MongoDB source endpoint.
    
    Parameters:
    
    databaseName - The database name on the MongoDB source endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthType
```
public void setAuthType(String authType)
```
    The authentication type you use to access the MongoDB source endpoint.
    
    Valid values: NO, PASSWORD
    
    When NO is selected, user name and password parameters are not used and can be empty.
    
    Parameters:
    
    authType - The authentication type you use to access the MongoDB source endpoint.
    
    Valid values: NO, PASSWORD
    
    When NO is selected, user name and password parameters are not used and can be empty.
    
    See Also:
    
    AuthTypeValue
  - getAuthType
```
public String getAuthType()
```
    The authentication type you use to access the MongoDB source endpoint.
    
    Valid values: NO, PASSWORD
    
    When NO is selected, user name and password parameters are not used and can be empty.
    
    Returns:
    
    The authentication type you use to access the MongoDB source endpoint.
    
    Valid values: NO, PASSWORD
    
    When NO is selected, user name and password parameters are not used and can be empty.
    
    See Also:
    
    AuthTypeValue
  - withAuthType
```
public MongoDbSettings withAuthType(String authType)
```
    The authentication type you use to access the MongoDB source endpoint.
    
    Valid values: NO, PASSWORD
    
    When NO is selected, user name and password parameters are not used and can be empty.
    
    Parameters:
    
    authType - The authentication type you use to access the MongoDB source endpoint.
    
    Valid values: NO, PASSWORD
    
    When NO is selected, user name and password parameters are not used and can be empty.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthTypeValue
  - setAuthType
```
public void setAuthType(AuthTypeValue authType)
```
    The authentication type you use to access the MongoDB source endpoint.
    
    Valid values: NO, PASSWORD
    
    When NO is selected, user name and password parameters are not used and can be empty.
    
    Parameters:
    
    authType - The authentication type you use to access the MongoDB source endpoint.
    
    Valid values: NO, PASSWORD
    
    When NO is selected, user name and password parameters are not used and can be empty.
    
    See Also:
    
    AuthTypeValue
  - withAuthType
```
public MongoDbSettings withAuthType(AuthTypeValue authType)
```
    The authentication type you use to access the MongoDB source endpoint.
    
    Valid values: NO, PASSWORD
    
    When NO is selected, user name and password parameters are not used and can be empty.
    
    Parameters:
    
    authType - The authentication type you use to access the MongoDB source endpoint.
    
    Valid values: NO, PASSWORD
    
    When NO is selected, user name and password parameters are not used and can be empty.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthTypeValue
  - setAuthMechanism
```
public void setAuthMechanism(String authMechanism)
```
    The authentication mechanism you use to access the MongoDB source endpoint.
    
    Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
    
    DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
    
    Parameters:
    
    authMechanism - The authentication mechanism you use to access the MongoDB source endpoint.
    
    Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
    
    DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
    
    See Also:
    
    AuthMechanismValue
  - getAuthMechanism
```
public String getAuthMechanism()
```
    The authentication mechanism you use to access the MongoDB source endpoint.
    
    Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
    
    DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
    
    Returns:
    
    The authentication mechanism you use to access the MongoDB source endpoint.
    
    Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
    
    DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
    
    See Also:
    
    AuthMechanismValue
  - withAuthMechanism
```
public MongoDbSettings withAuthMechanism(String authMechanism)
```
    The authentication mechanism you use to access the MongoDB source endpoint.
    
    Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
    
    DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
    
    Parameters:
    
    authMechanism - The authentication mechanism you use to access the MongoDB source endpoint.
    
    Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
    
    DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthMechanismValue
  - setAuthMechanism
```
public void setAuthMechanism(AuthMechanismValue authMechanism)
```
    The authentication mechanism you use to access the MongoDB source endpoint.
    
    Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
    
    DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
    
    Parameters:
    
    authMechanism - The authentication mechanism you use to access the MongoDB source endpoint.
    
    Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
    
    DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
    
    See Also:
    
    AuthMechanismValue
  - withAuthMechanism
```
public MongoDbSettings withAuthMechanism(AuthMechanismValue authMechanism)
```
    The authentication mechanism you use to access the MongoDB source endpoint.
    
    Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
    
    DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
    
    Parameters:
    
    authMechanism - The authentication mechanism you use to access the MongoDB source endpoint.
    
    Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
    
    DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthMechanismValue
  - setNestingLevel
```
public void setNestingLevel(String nestingLevel)
```
    Specifies either document or table mode.
    
    Valid values: NONE, ONE
    
    Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
    
    Parameters:
    
    nestingLevel - Specifies either document or table mode.
    
    Valid values: NONE, ONE
    
    Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
    
    See Also:
    
    NestingLevelValue
  - getNestingLevel
```
public String getNestingLevel()
```
    Specifies either document or table mode.
    
    Valid values: NONE, ONE
    
    Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
    
    Returns:
    
    Specifies either document or table mode.
    
    Valid values: NONE, ONE
    
    Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
    
    See Also:
    
    NestingLevelValue
  - withNestingLevel
```
public MongoDbSettings withNestingLevel(String nestingLevel)
```
    Specifies either document or table mode.
    
    Valid values: NONE, ONE
    
    Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
    
    Parameters:
    
    nestingLevel - Specifies either document or table mode.
    
    Valid values: NONE, ONE
    
    Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NestingLevelValue
  - setNestingLevel
```
public void setNestingLevel(NestingLevelValue nestingLevel)
```
    Specifies either document or table mode.
    
    Valid values: NONE, ONE
    
    Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
    
    Parameters:
    
    nestingLevel - Specifies either document or table mode.
    
    Valid values: NONE, ONE
    
    Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
    
    See Also:
    
    NestingLevelValue
  - withNestingLevel
```
public MongoDbSettings withNestingLevel(NestingLevelValue nestingLevel)
```
    Specifies either document or table mode.
    
    Valid values: NONE, ONE
    
    Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
    
    Parameters:
    
    nestingLevel - Specifies either document or table mode.
    
    Valid values: NONE, ONE
    
    Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NestingLevelValue
  - setExtractDocId
```
public void setExtractDocId(String extractDocId)
```
    Specifies the document ID. Use this attribute when NestingLevel is set to NONE.
    
    Default value is false.
    
    Parameters:
    
    extractDocId - Specifies the document ID. Use this attribute when NestingLevel is set to NONE.
    
    Default value is false.
  - getExtractDocId
```
public String getExtractDocId()
```
    Specifies the document ID. Use this attribute when NestingLevel is set to NONE.
    
    Default value is false.
    
    Returns:
    
    Specifies the document ID. Use this attribute when NestingLevel is set to NONE.
    
    Default value is false.
  - withExtractDocId
```
public MongoDbSettings withExtractDocId(String extractDocId)
```
    Specifies the document ID. Use this attribute when NestingLevel is set to NONE.
    
    Default value is false.
    
    Parameters:
    
    extractDocId - Specifies the document ID. Use this attribute when NestingLevel is set to NONE.
    
    Default value is false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocsToInvestigate
```
public void setDocsToInvestigate(String docsToInvestigate)
```
    Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.
    
    Must be a positive value greater than 0. Default value is 1000.
    
    Parameters:
    
    docsToInvestigate - Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.
    
    Must be a positive value greater than 0. Default value is 1000.
  - getDocsToInvestigate
```
public String getDocsToInvestigate()
```
    Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.
    
    Must be a positive value greater than 0. Default value is 1000.
    
    Returns:
    
    Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.
    
    Must be a positive value greater than 0. Default value is 1000.
  - withDocsToInvestigate
```
public MongoDbSettings withDocsToInvestigate(String docsToInvestigate)
```
    Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.
    
    Must be a positive value greater than 0. Default value is 1000.
    
    Parameters:
    
    docsToInvestigate - Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.
    
    Must be a positive value greater than 0. Default value is 1000.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthSource
```
public void setAuthSource(String authSource)
```
    The MongoDB database name. This attribute is not used when authType=NO.
    
    The default is admin.
    
    Parameters:
    
    authSource - The MongoDB database name. This attribute is not used when authType=NO.
    
    The default is admin.
  - getAuthSource
```
public String getAuthSource()
```
    The MongoDB database name. This attribute is not used when authType=NO.
    
    The default is admin.
    
    Returns:
    
    The MongoDB database name. This attribute is not used when authType=NO.
    
    The default is admin.
  - withAuthSource
```
public MongoDbSettings withAuthSource(String authSource)
```
    The MongoDB database name. This attribute is not used when authType=NO.
    
    The default is admin.
    
    Parameters:
    
    authSource - The MongoDB database name. This attribute is not used when authType=NO.
    
    The default is admin.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public MongoDbSettings clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class MongoDbSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MongoDbSettings

Method Detail

setUsername

getUsername

withUsername

setPassword

getPassword

withPassword

setServerName

getServerName

withServerName

setPort

getPort

withPort

setDatabaseName

getDatabaseName

withDatabaseName

setAuthType

getAuthType

withAuthType

setAuthType

withAuthType

setAuthMechanism

getAuthMechanism

withAuthMechanism

setAuthMechanism

withAuthMechanism

setNestingLevel

getNestingLevel

withNestingLevel

setNestingLevel

withNestingLevel

setExtractDocId

getExtractDocId

withExtractDocId

setDocsToInvestigate

getDocsToInvestigate

withDocsToInvestigate

setAuthSource

getAuthSource

withAuthSource

toString

equals

hashCode

clone

marshall