Package io.vertx.mongo.client.model

Class BulkWriteOptions

java.lang.Object

io.vertx.mongo.client.model.BulkWriteOptions

public class BulkWriteOptions
extends java.lang.Object

The options to apply to a bulk write.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
BulkWriteOptions()
BulkWriteOptions(JsonObject json)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	isBypassDocumentValidation()	Gets the the bypass document level validation flag
java.lang.Boolean	isOrdered()	If true, then when a write fails, return without performing the remaining writes.
BulkWriteOptions	setBypassDocumentValidation(java.lang.Boolean bypassDocumentValidation)	Sets the bypass document level validation flag.
BulkWriteOptions	setOrdered(java.lang.Boolean ordered)	If true, then when a write fails, return without performing the remaining writes.
JsonObject	toJson()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BulkWriteOptions

public BulkWriteOptions()

BulkWriteOptions

public BulkWriteOptions(JsonObject json)

Method Detail

toJson

public JsonObject toJson()

setOrdered

public BulkWriteOptions setOrdered(java.lang.Boolean ordered)

If true, then when a write fails, return without performing the remaining writes. If false, then when a write fails, continue with the remaining writes, if any. Defaults to true.

Parameters:

ordered - true if the writes should be ordered

Returns:

this

isOrdered

public java.lang.Boolean isOrdered()

If true, then when a write fails, return without performing the remaining writes. If false, then when a write fails, continue with the remaining writes, if any. Defaults to true.

Returns:

true if the writes are ordered

setBypassDocumentValidation

public BulkWriteOptions setBypassDocumentValidation(java.lang.Boolean bypassDocumentValidation)

Sets the bypass document level validation flag.

Parameters:

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

Returns:

this

Since:

3.2

Since server release

3.2

isBypassDocumentValidation

public java.lang.Boolean isBypassDocumentValidation()

Gets the the bypass document level validation flag

Returns:

the bypass document level validation flag

Since:

3.2

Since server release

3.2