@Generated(value="software.amazon.awssdk:codegen") public class MongoDbSettings extends Object implements StructuredPojo, ToCopyableBuilder<MongoDbSettings.Builder,MongoDbSettings>
Modifier and Type | Class and Description |
---|---|
static interface |
MongoDbSettings.Builder |
Modifier and Type | Method and Description |
---|---|
AuthMechanismValue |
authMechanism()
The authentication mechanism you use to access the MongoDB source endpoint.
|
String |
authMechanismString()
The authentication mechanism you use to access the MongoDB source endpoint.
|
String |
authSource()
The MongoDB database name.
|
AuthTypeValue |
authType()
The authentication type you use to access the MongoDB source endpoint.
|
String |
authTypeString()
The authentication type you use to access the MongoDB source endpoint.
|
static MongoDbSettings.Builder |
builder() |
String |
databaseName()
The database name on the MongoDB source endpoint.
|
String |
docsToInvestigate()
Indicates the number of documents to preview to determine the document organization.
|
boolean |
equals(Object obj) |
String |
extractDocId()
Specifies the document ID.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
NestingLevelValue |
nestingLevel()
Specifies either document or table mode.
|
String |
nestingLevelString()
Specifies either document or table mode.
|
String |
password()
The password for the user account you use to access the MongoDB source endpoint.
|
Integer |
port()
The port value for the MongoDB source endpoint.
|
static Class<? extends MongoDbSettings.Builder> |
serializableBuilderClass() |
String |
serverName()
The name of the server on the MongoDB source endpoint.
|
MongoDbSettings.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
username()
The user name you use to access the MongoDB source endpoint.
|
copy
public String username()
The user name you use to access the MongoDB source endpoint.
public String password()
The password for the user account you use to access the MongoDB source endpoint.
public String serverName()
The name of the server on the MongoDB source endpoint.
public Integer port()
The port value for the MongoDB source endpoint.
public String databaseName()
The database name on the MongoDB source endpoint.
public 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.
If the service returns an enum value that is not available in the current SDK version, authType
will
return AuthTypeValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
authTypeString()
.
Valid values: NO, PASSWORD
When NO is selected, user name and password parameters are not used and can be empty.
AuthTypeValue
public String authTypeString()
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.
If the service returns an enum value that is not available in the current SDK version, authType
will
return AuthTypeValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
authTypeString()
.
Valid values: NO, PASSWORD
When NO is selected, user name and password parameters are not used and can be empty.
AuthTypeValue
public 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.
If the service returns an enum value that is not available in the current SDK version, authMechanism
will return AuthMechanismValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from authMechanismString()
.
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.
AuthMechanismValue
public String authMechanismString()
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.
If the service returns an enum value that is not available in the current SDK version, authMechanism
will return AuthMechanismValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from authMechanismString()
.
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.
AuthMechanismValue
public 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.
If the service returns an enum value that is not available in the current SDK version, nestingLevel
will
return NestingLevelValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
nestingLevelString()
.
Valid values: NONE, ONE
Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
NestingLevelValue
public String nestingLevelString()
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.
If the service returns an enum value that is not available in the current SDK version, nestingLevel
will
return NestingLevelValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
nestingLevelString()
.
Valid values: NONE, ONE
Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
NestingLevelValue
public String extractDocId()
Specifies the document ID. Use this attribute when NestingLevel
is set to NONE.
Default value is false.
NestingLevel
is set to NONE.
Default value is false.
public 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.
NestingLevel
is set to ONE.
Must be a positive value greater than 0. Default value is 1000.
public String authSource()
The MongoDB database name. This attribute is not used when authType=NO
.
The default is admin.
authType=NO
.
The default is admin.
public MongoDbSettings.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<MongoDbSettings.Builder,MongoDbSettings>
public static MongoDbSettings.Builder builder()
public static Class<? extends MongoDbSettings.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.