Class UpdateResult

java.lang.Object
com.mongodb.client.result.UpdateResult

public abstract class UpdateResult extends Object
The result of an update operation. If the update was unacknowledged, then wasAcknowledged will return false and all other methods will throw UnsupportedOperationException.
Since:
3.0
See Also:
  • Constructor Details

    • UpdateResult

      public UpdateResult()
  • Method Details

    • wasAcknowledged

      public abstract boolean wasAcknowledged()
      Returns true if the write was acknowledged.
      Returns:
      true if the write was acknowledged
    • getMatchedCount

      public abstract long getMatchedCount()
      Gets the number of documents matched by the query.
      Returns:
      the number of documents matched
    • getModifiedCount

      public abstract long getModifiedCount()
      Gets the number of documents modified by the update.
      Returns:
      the number of documents modified
    • getUpsertedId

      @Nullable public abstract BsonValue getUpsertedId()
      If the replace resulted in an inserted document, gets the _id of the inserted document, otherwise null.
      Returns:
      if the replace resulted in an inserted document, the _id of the inserted document, otherwise null
    • acknowledged

      public static UpdateResult acknowledged(long matchedCount, @Nullable Long modifiedCount, @Nullable BsonValue upsertedId)
      Create an acknowledged UpdateResult
      Parameters:
      matchedCount - the number of documents matched
      modifiedCount - the number of documents modified
      upsertedId - if the replace resulted in an inserted document, the id of the inserted document
      Returns:
      an acknowledged UpdateResult
    • unacknowledged

      public static UpdateResult unacknowledged()
      Create an unacknowledged UpdateResult
      Returns:
      an unacknowledged UpdateResult