Package io.vertx.mongo.client.model

Class ReplaceOptions

java.lang.Object

io.vertx.mongo.client.model.ReplaceOptions

public class ReplaceOptions
extends java.lang.Object

The options to apply when replacing documents.

Since:

3.7

MongoDB documentation

Updates

Update Operators

Update Command

Constructor Summary

Constructors

Constructor	Description
ReplaceOptions()
ReplaceOptions(JsonObject json)

Method Summary

Modifier and Type	Method	Description
Collation	getCollation()	Returns the collation options
JsonObject	getHint()	Returns the hint for which index to use.
java.lang.String	getHintString()	Gets the hint string to apply.
java.lang.Boolean	isBypassDocumentValidation()	Gets the the bypass document level validation flag
java.lang.Boolean	isUpsert()	Returns true if a new document should be inserted if there are no matches to the query filter.
ReplaceOptions	setBypassDocumentValidation(java.lang.Boolean bypassDocumentValidation)	Sets the bypass document level validation flag.
ReplaceOptions	setCollation(Collation collation)	Sets the collation options
ReplaceOptions	setHint(JsonObject hint)	Sets the hint for which index to use.
ReplaceOptions	setHintString(java.lang.String hint)	Sets the hint to apply.
ReplaceOptions	setUpsert(java.lang.Boolean upsert)	Set to true if a new document should be inserted if there are no matches to the query filter.
JsonObject	toJson()

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplaceOptions

public ReplaceOptions()

ReplaceOptions

public ReplaceOptions(JsonObject json)

Method Detail

toJson

public JsonObject toJson()

setUpsert

public ReplaceOptions setUpsert(java.lang.Boolean upsert)

Set to true if a new document should be inserted if there are no matches to the query filter.

Parameters:

upsert - true if a new document should be inserted if there are no matches to the query filter

Returns:

this

isUpsert

public java.lang.Boolean isUpsert()

Returns true if a new document should be inserted if there are no matches to the query filter. The default is false.

Returns:

true if a new document should be inserted if there are no matches to the query filter

setBypassDocumentValidation

public ReplaceOptions 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 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 server release

3.2

setCollation

public ReplaceOptions setCollation(Collation collation)

Sets the collation options

A null value represents the server default.

Parameters:

collation - the collation options to use

Returns:

this

Since server release

3.4

getCollation

public Collation getCollation()

Returns the collation options

Returns:

the collation options

Since server release

3.4

setHint

public ReplaceOptions setHint(JsonObject hint)

Sets the hint for which index to use. A null value means no hint is set.

Parameters:

hint - the hint

Returns:

this

Since:

4.1

getHint

public JsonObject getHint()

Returns the hint for which index to use. The default is not to set a hint.

Returns:

the hint

Since:

4.1

setHintString

public ReplaceOptions setHintString(java.lang.String hint)

Sets the hint to apply.

Parameters:

hint - the name of the index which should be used for the operation

Returns:

this

Since:

4.1

getHintString

public java.lang.String getHintString()

Gets the hint string to apply.

Returns:

the hint string, which should be the name of an existing index

Since:

4.1