Class MongoDBTarget
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MongoDBTarget.Builder,
MongoDBTarget>
Specifies an Amazon DocumentDB or MongoDB data store to crawl.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic MongoDBTarget.Builder
builder()
final String
The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
path()
The path of the Amazon DocumentDB or MongoDB target (database/collection).final Boolean
scanAll()
Indicates whether to scan all the records, or to sample rows from the table.static Class
<? extends MongoDBTarget.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
connectionName
The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
- Returns:
- The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
-
path
The path of the Amazon DocumentDB or MongoDB target (database/collection).
- Returns:
- The path of the Amazon DocumentDB or MongoDB target (database/collection).
-
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:
- 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
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<MongoDBTarget.Builder,
MongoDBTarget> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-