Package com.mongodb
Class InsertOptions
- java.lang.Object
-
- com.mongodb.InsertOptions
-
@Deprecated(since="2021-05-27") public final class InsertOptions extends java.lang.ObjectDeprecated.Usage of this API is not supported in AEM as a Cloud Service.Options related to insertion of documents into MongoDB. The setter methods returnthisso that a chaining style can be used.- Since:
- 2.13
-
-
Constructor Summary
Constructors Constructor Description InsertOptions()Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description InsertOptionsbypassDocumentValidation(java.lang.Boolean bypassDocumentValidation)Deprecated.Sets whether to bypass document validation.InsertOptionscontinueOnError(boolean continueOnError)Deprecated.Set whether documents will continue to be inserted after a failure to insert one.InsertOptionsdbEncoder(DBEncoder dbEncoder)Deprecated.Set the encoder to use for the documents.java.lang.BooleangetBypassDocumentValidation()Deprecated.Gets whether to bypass document validation, or null if unspecified.DBEncodergetDbEncoder()Deprecated.The encoder to use for the documents.WriteConcerngetWriteConcern()Deprecated.The write concern to use for the insertion.booleanisContinueOnError()Deprecated.Whether documents will continue to be inserted after a failure to insert one (most commonly due to a duplicate key error).InsertOptionswriteConcern(WriteConcern writeConcern)Deprecated.Set the write concern to use for the insert.
-
-
-
Method Detail
-
writeConcern
public InsertOptions writeConcern(@Nullable WriteConcern writeConcern)
Deprecated.Set the write concern to use for the insert.- Parameters:
writeConcern- the write concern- Returns:
- this
-
continueOnError
public InsertOptions continueOnError(boolean continueOnError)
Deprecated.Set whether documents will continue to be inserted after a failure to insert one.- Parameters:
continueOnError- whether to continue on error- Returns:
- this
-
dbEncoder
public InsertOptions dbEncoder(@Nullable DBEncoder dbEncoder)
Deprecated.Set the encoder to use for the documents.- Parameters:
dbEncoder- the encoder- Returns:
- this
-
getWriteConcern
@Nullable public WriteConcern getWriteConcern()
Deprecated.The write concern to use for the insertion. By default the write concern configured for the DBCollection instance will be used.- Returns:
- the write concern, or null if the default will be used.
-
isContinueOnError
public boolean isContinueOnError()
Deprecated.Whether documents will continue to be inserted after a failure to insert one (most commonly due to a duplicate key error). Note that this only is relevant for multi-document inserts. The default value is false.- Returns:
- whether insertion will continue on error.
-
getDbEncoder
@Nullable public DBEncoder getDbEncoder()
Deprecated.The encoder to use for the documents. By default the codec configured for the DBCollection instance will be used.- Returns:
- the encoder, or null if the default will be used
-
getBypassDocumentValidation
@Nullable public java.lang.Boolean getBypassDocumentValidation()
Deprecated.Gets whether to bypass document validation, or null if unspecified. The default is null.- Returns:
- whether to bypass document validation, or null if unspecified.
- Since:
- 2.14
-
bypassDocumentValidation
public InsertOptions bypassDocumentValidation(@Nullable java.lang.Boolean bypassDocumentValidation)
Deprecated.Sets whether to bypass document validation.- Parameters:
bypassDocumentValidation- whether to bypass document validation, or null if unspecified- Returns:
- this
- Since:
- 2.14
-
-