Package com.mongodb.client.model
Class FindOneAndDeleteOptions
java.lang.Object
com.mongodb.client.model.FindOneAndDeleteOptions
The options to apply to an operation that atomically finds a document and deletes it.
- Since:
- 3.0
- MongoDB documentation
- reference/command/findAndModify/
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionSets the collation optionsSets the comment for this operation.Sets the comment for this operation.Returns the collation optionsgetHint()
Gets the hint to apply.Gets the hint string to apply.getLet()
Add top-level variables to the operationlong
getMaxTime
(TimeUnit timeUnit) Gets the maximum execution time for the find one and delete operation.Gets a document describing the fields to return for all matching documents.getSort()
Gets the sort criteria to apply to the query.Sets the hint to apply.hintString
(String hint) Sets the hint to apply.Add top-level variables for the operationSets the maximum execution time on the server for this operation.projection
(Bson projection) Sets a document describing the fields to return for all matching documents.Sets the sort criteria to apply to the query.toString()
-
Constructor Details
-
FindOneAndDeleteOptions
public FindOneAndDeleteOptions()
-
-
Method Details
-
getProjection
Gets a document describing the fields to return for all matching documents.- Returns:
- the project document, which may be null
- MongoDB documentation
- Projection
-
projection
Sets a document describing the fields to return for all matching documents.- Parameters:
projection
- the project document, which may be null.- Returns:
- this
- MongoDB documentation
- Projection
-
getSort
Gets the sort criteria to apply to the query. The default is null, which means that the documents will be returned in an undefined order.- Returns:
- a document describing the sort criteria
- MongoDB documentation
- Sort
-
sort
Sets the sort criteria to apply to the query.- Parameters:
sort
- the sort criteria, which may be null.- Returns:
- this
- MongoDB documentation
- Sort
-
maxTime
Sets the maximum execution time on the server for this operation.- Parameters:
maxTime
- the max timetimeUnit
- the time unit, which may not be null- Returns:
- this
-
getMaxTime
Gets the maximum execution time for the find one and delete operation.- Parameters:
timeUnit
- the time unit for the result- Returns:
- the max time
-
getCollation
Returns the collation options- Returns:
- the collation options
- Since:
- 3.4
- Since server release
- 3.4
-
collation
Sets the collation optionsA null value represents the server default.
- Parameters:
collation
- the collation options to use- Returns:
- this
- Since:
- 3.4
- Since server release
- 3.4
-
getHint
Gets the hint to apply.- Returns:
- the hint, which should describe an existing index
- Since:
- 4.1
- Since server release
- 4.4
-
getHintString
Gets the hint string to apply.- Returns:
- the hint string, which should be the name of an existing index
- Since:
- 4.1
- Since server release
- 4.4
-
hint
Sets the hint to apply.- Parameters:
hint
- a document describing the index which should be used for this operation.- Returns:
- this
- Since:
- 4.1
- Since server release
- 4.4
-
hintString
Sets the hint to apply.Note: If
hint(Bson)
is set that will be used instead of any hint string.- Parameters:
hint
- the name of the index which should be used for the operation- Returns:
- this
- Since:
- 4.1
- Since server release
- 4.4
-
getComment
- Returns:
- the comment for this operation. A null value means no comment is set.
- Since:
- 4.6
- Since server release
- 4.4
-
comment
Sets the comment for this operation. A null value means no comment is set.- Parameters:
comment
- the comment- Returns:
- this
- Since:
- 4.6
- Since server release
- 4.4
-
comment
Sets the comment for this operation. A null value means no comment is set.- Parameters:
comment
- the comment- Returns:
- this
- Since:
- 4.6
- Since server release
- 4.4
-
getLet
Add top-level variables to the operation- Returns:
- the top level variables if set or null.
- Since:
- 4.6
- Since server release
- 5.0
-
let
Add top-level variables for the operationAllows for improved command readability by separating the variables from the query text.
- Parameters:
variables
- for the operation or null- Returns:
- this
- Since:
- 4.6
- Since server release
- 5.0
-
toString
-