Package com.mongodb.client.model

Class UpdateOptions

java.lang.Object

com.mongodb.client.model.UpdateOptions

public class UpdateOptions
extends Object

The options to apply when updating documents.

Since:

3.0

MongoDB documentation

Updates

Update Operators

Update Command

Constructor Summary

Constructors

Constructor	Description
UpdateOptions()

Method Summary

Modifier and Type	Method	Description
UpdateOptions	arrayFilters(List<? extends Bson> arrayFilters)	Sets the array filters option
UpdateOptions	bypassDocumentValidation(Boolean bypassDocumentValidation)	Sets the bypass document level validation flag.
UpdateOptions	collation(Collation collation)	Sets the collation options
List<? extends Bson>	getArrayFilters()	Returns the array filters option
Boolean	getBypassDocumentValidation()	Gets the the bypass document level validation flag
Collation	getCollation()	Returns the collation options
boolean	isUpsert()	Returns true if a new document should be inserted if there are no matches to the query filter.
String	toString()
UpdateOptions	upsert(boolean upsert)	Set to true if a new document should be inserted if there are no matches to the query filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateOptions

public UpdateOptions()

Method Detail

isUpsert

public 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

upsert

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

getBypassDocumentValidation

@Nullable
public Boolean getBypassDocumentValidation()

Gets the the bypass document level validation flag

Returns:

the bypass document level validation flag

Since:

3.2

Since server release

3.2

bypassDocumentValidation

public UpdateOptions bypassDocumentValidation(@Nullable
                                              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

getCollation

@Nullable
public Collation getCollation()

Returns the collation options

Returns:

the collation options

Since:

3.4

Since server release

3.4

collation

public UpdateOptions collation(@Nullable
                               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

arrayFilters

public UpdateOptions arrayFilters(@Nullable
                                  List<? extends Bson> 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

@Nullable
public List<? extends Bson> getArrayFilters()

Returns the array filters option

Returns:

the array filters, which may be null

Since:

3.6

Since server release

3.6

toString

public String toString()

Overrides:

toString in class Object