Package io.vertx.mongo.client.model

Class UpdateOptions

java.lang.Object

io.vertx.mongo.client.model.UpdateOptions

public class UpdateOptions
extends java.lang.Object

The options to apply when updating documents.

Since:

3.0

MongoDB documentation

Updates

Update Operators

Update Command

Constructor Summary

Constructors

Constructor	Description
UpdateOptions()
UpdateOptions(JsonObject json)

Method Summary

Modifier and Type	Method	Description
JsonArray	getArrayFilters()	Returns the array filters option
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.
UpdateOptions	setArrayFilters(JsonArray arrayFilters)	Sets the array filters option
UpdateOptions	setBypassDocumentValidation(java.lang.Boolean bypassDocumentValidation)	Sets the bypass document level validation flag.
UpdateOptions	setCollation(Collation collation)	Sets the collation options
UpdateOptions	setHint(JsonObject hint)	Sets the hint for which index to use.
UpdateOptions	setHintString(java.lang.String hint)	Sets the hint to apply.
UpdateOptions	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

UpdateOptions

public UpdateOptions()

UpdateOptions

public UpdateOptions(JsonObject json)

Method Detail

toJson

public JsonObject toJson()

setUpsert

public UpdateOptions 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 UpdateOptions 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

setCollation

public UpdateOptions setCollation(Collation collation)

Sets the collation options

A null value represents the server default.

Parameters:

collation - the collation options to use

Returns:

this

Since:

3.4

Since server release

3.4

getCollation

public Collation getCollation()

Returns the collation options

Returns:

the collation options

Since:

3.4

Since server release

3.4

setArrayFilters

public UpdateOptions setArrayFilters(JsonArray arrayFilters)

Sets the array filters option

Parameters:

arrayFilters - the array filters, which may be null

Returns:

this

Since:

3.6

Since server release

3.6

getArrayFilters

public JsonArray getArrayFilters()

Returns the array filters option

Returns:

the array filters, which may be null

Since:

3.6

Since server release

3.6

setHint

public UpdateOptions 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 UpdateOptions 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