Package com.mongodb.client.model

Class InsertOneOptions

java.lang.Object

com.mongodb.client.model.InsertOneOptions

public final class InsertOneOptions
extends Object

The options to apply to an operation that inserts a single document into a collection.

Since:

3.2

MongoDB documentation

Insert Tutorial

Insert Command

Since server release

3.2

Constructor Summary

Constructors

Constructor	Description
InsertOneOptions()

Method Summary

Modifier and Type	Method	Description
InsertOneOptions	bypassDocumentValidation(Boolean bypassDocumentValidation)	Sets the bypass document level validation flag.
InsertOneOptions	comment(String comment)	Sets the comment for this operation.
InsertOneOptions	comment(BsonValue comment)	Sets the comment for this operation.
Boolean	getBypassDocumentValidation()	Gets the bypass document level validation flag
BsonValue	getComment()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

InsertOneOptions

public InsertOneOptions()

Method Details

getBypassDocumentValidation

@Nullable
public Boolean getBypassDocumentValidation()

Gets the bypass document level validation flag

Returns:

the bypass document level validation flag

bypassDocumentValidation

public InsertOneOptions bypassDocumentValidation(@Nullable
 Boolean bypassDocumentValidation)

Sets the bypass document level validation flag.

For bulk operations use: BulkWriteOptions.bypassDocumentValidation(Boolean)

Parameters:

bypassDocumentValidation - If true, allows the write to opt-out of document level validation.

Returns:

this

getComment

@Nullable
public BsonValue getComment()

Returns:

the comment for this operation. A null value means no comment is set.

Since:

4.6

Since server release

4.4

comment

public InsertOneOptions comment(@Nullable
 String comment)

Sets the comment for this operation. A null value means no comment is set.

For bulk operations use: BulkWriteOptions.comment(String)

Parameters:

comment - the comment

Returns:

this

Since:

4.6

Since server release

4.4

comment

public InsertOneOptions comment(@Nullable
 BsonValue comment)

Sets the comment for this operation. A null value means no comment is set.

For bulk operations use: BulkWriteOptions.comment(BsonValue)

Parameters:

comment - the comment

Returns:

this

Since:

4.6

Since server release

4.4

toString

public String toString()

Overrides:

toString in class Object