Package io.vertx.mongo.client.model

Class FindOneAndUpdateOptions

  • public class FindOneAndUpdateOptions
extends java.lang.Object
    The options to apply to an operation that atomically finds a document and updates it.
    Since:
    3.0
    MongoDB documentation
    reference/command/findAndModify/

    • Constructor Detail

      • FindOneAndUpdateOptions

        public FindOneAndUpdateOptions()

      • FindOneAndUpdateOptions

        public FindOneAndUpdateOptions​(JsonObject json)

    • Method Detail

      • setProjection

        public FindOneAndUpdateOptions setProjection​(JsonObject 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

      • getProjection

        public JsonObject getProjection()
        Gets a document describing the fields to return for all matching documents.
        Returns:
        the project document, which may be null
        MongoDB documentation
        Projection

      • setSort

        public FindOneAndUpdateOptions setSort​(JsonObject sort)
        Sets the sort criteria to apply to the query.
        Parameters:
        sort - the sort criteria, which may be null.
        Returns:
        this
        MongoDB documentation
        Sort

      • getSort

        public JsonObject 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

      • setUpsert

        public FindOneAndUpdateOptions setUpsert​(java.lang.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

      • isUpsert

        public java.lang.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

      • setReturnDocument

        public FindOneAndUpdateOptions setReturnDocument​(ReturnDocument returnDocument)
        Set whether to return the document before it was updated / inserted or after
        Parameters:
        returnDocument - set whether to return the document before it was updated / inserted or after
        Returns:
        this

      • setMaxTime

        public FindOneAndUpdateOptions setMaxTime​(java.lang.Long maxTime)
        Sets the maximum execution time on the server for this operation.
        Parameters:
        maxTime - the max time (in milliseconds)
        Returns:
        this

      • getMaxTime

        public java.lang.Long getMaxTime()
        Gets the maximum execution time for the find one and update operation.
        Returns:
        the max time

      • setBypassDocumentValidation

        public FindOneAndUpdateOptions setBypassDocumentValidation​(java.lang.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

      • isBypassDocumentValidation

        public java.lang.Boolean isBypassDocumentValidation()
        Gets the the bypass document level validation flag
        Returns:
        the bypass document level validation flag
        Since:
        3.2
        Since server release
        3.2

      • setCollation

        public FindOneAndUpdateOptions setCollation​(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

      • getCollation

        public Collation getCollation()
        Returns the collation options
        Returns:
        the collation options
        Since:
        3.4
        Since server release
        3.4

      • setArrayFilters

        public FindOneAndUpdateOptions setArrayFilters​(JsonArray 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

        public JsonArray getArrayFilters()
        Returns the array filters option
        Returns:
        the array filters, which may be null
        Since:
        3.6
        Since server release
        3.6

      • setHint

        public FindOneAndUpdateOptions setHint​(JsonObject hint)
        Sets the hint for which index to use. A null value means no hint is set.
        Parameters:
        hint - the hint
        Returns:
        this
        Since:
        4.1

      • getHint

        public JsonObject getHint()
        Returns the hint for which index to use. The default is not to set a hint.
        Returns:
        the hint
        Since:
        4.1

      • setHintString

        public FindOneAndUpdateOptions setHintString​(java.lang.String hint)
        Sets the hint to apply.
        Parameters:
        hint - the name of the index which should be used for the operation
        Returns:
        this
        Since:
        4.1

      • getHintString

        public java.lang.String getHintString()
        Gets the hint string to apply.
        Returns:
        the hint string, which should be the name of an existing index
        Since:
        4.1