Class DeleteRequest

java.lang.Object
com.mongodb.bulk.WriteRequest
com.mongodb.bulk.DeleteRequest

@Deprecated public final class DeleteRequest extends WriteRequest
Deprecated.
A representation of a delete.
Since:
3.0
  • Constructor Details

    • DeleteRequest

      public DeleteRequest(BsonDocument filter)
      Deprecated.
      Construct a new instance.
      Parameters:
      filter - the non-null query filter
  • Method Details

    • getFilter

      public BsonDocument getFilter()
      Deprecated.
      Gets the query Object filter.
      Returns:
      the Object filter
    • multi

      public DeleteRequest multi(boolean isMulti)
      Deprecated.
      Sets whether all documents matching the query filter will be removed.
      Parameters:
      isMulti - true if all documents matching the query filter will be removed
      Returns:
      this
    • isMulti

      public boolean isMulti()
      Deprecated.
      Gets whether all documents matching the query filter will be removed. The default is true.
      Returns:
      whether all documents matching the query filter will be removed
    • getCollation

      public Collation getCollation()
      Deprecated.
      Returns the collation options
      Returns:
      the collation options
      Since:
      3.4
    • collation

      public DeleteRequest collation(Collation collation)
      Deprecated.
      Sets the collation options

      A null value represents the server default.

      Parameters:
      collation - the collation options to use
      Returns:
      this
      Since:
      3.4
    • getType

      public WriteRequest.Type getType()
      Deprecated.
      Description copied from class: WriteRequest
      Gets the type of the write.
      Specified by:
      getType in class WriteRequest
      Returns:
      the type