Package com.mongodb.client.model
Class UpdateOneModel<T>
- java.lang.Object
-
- com.mongodb.client.model.WriteModel<T>
-
- com.mongodb.client.model.UpdateOneModel<T>
-
- Type Parameters:
T
- the type of document to update. In practice this doesn't actually apply to updates but is here for consistency with the other write models
public final class UpdateOneModel<T> extends WriteModel<T>
A model describing an update to at most one document that matches the query filter. The update to apply must include only update operators.- Since:
- 3.0
- MongoDB documentation
- Updates
- Update Operators
-
-
Constructor Summary
Constructors Constructor Description UpdateOneModel(Bson filter, Bson update)
Construct a new instance.UpdateOneModel(Bson filter, Bson update, UpdateOptions options)
Construct a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Bson
getFilter()
Gets the query filter.UpdateOptions
getOptions()
Gets the options to apply.Bson
getUpdate()
Gets the document specifying the updates to apply to the matching document.String
toString()
-
-
-
Constructor Detail
-
UpdateOneModel
public UpdateOneModel(Bson filter, Bson update)
Construct a new instance.- Parameters:
filter
- a document describing the query filter, which may not be null.update
- a document describing the update, which may not be null. The update to apply must include only update operators.
-
UpdateOneModel
public UpdateOneModel(Bson filter, Bson update, UpdateOptions options)
Construct a new instance.- Parameters:
filter
- a document describing the query filter, which may not be null.update
- a document describing the update, which may not be null. The update to apply must include only update operators.options
- the options to apply
-
-
Method Detail
-
getFilter
public Bson getFilter()
Gets the query filter.- Returns:
- the query filter
-
getUpdate
public Bson getUpdate()
Gets the document specifying the updates to apply to the matching document. The update to apply must include only update operators.- Returns:
- the document specifying the updates to apply
-
getOptions
public UpdateOptions getOptions()
Gets the options to apply.- Returns:
- the options
-
-