Interface MongoDBTarget.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<MongoDBTarget.Builder,
,MongoDBTarget> SdkBuilder<MongoDBTarget.Builder,
,MongoDBTarget> SdkPojo
- Enclosing class:
MongoDBTarget
public static interface MongoDBTarget.Builder
extends SdkPojo, CopyableBuilder<MongoDBTarget.Builder,MongoDBTarget>
-
Method Summary
Modifier and TypeMethodDescriptionconnectionName
(String connectionName) The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.The path of the Amazon DocumentDB or MongoDB target (database/collection).Indicates whether to scan all the records, or to sample rows from the table.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
connectionName
The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
- Parameters:
connectionName
- The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
path
The path of the Amazon DocumentDB or MongoDB target (database/collection).
- Parameters:
path
- The path of the Amazon DocumentDB or MongoDB target (database/collection).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scanAll
Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of
true
means to scan all records, while a value offalse
means to sample the records. If no value is specified, the value defaults totrue
.- Parameters:
scanAll
- Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.A value of
true
means to scan all records, while a value offalse
means to sample the records. If no value is specified, the value defaults totrue
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-