Package com.mongodb.client.model

Class UpdateOptions

  • public class UpdateOptions
extends java.lang.Object
    The options to apply when updating documents.
    Since:
    3.0

    • Constructor Detail

      • UpdateOptions

        public UpdateOptions()

    • Method Detail

      • isUpsert

        public 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

      • upsert

        public UpdateOptions upsert​(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

      • getBypassDocumentValidation

        @Nullable
public java.lang.Boolean getBypassDocumentValidation()
        Gets the the bypass document level validation flag
        Returns:
        the bypass document level validation flag
        Since:
        3.2

      • bypassDocumentValidation

        public UpdateOptions bypassDocumentValidation​(@Nullable
                                              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

      • getCollation

        @Nullable
public Collation getCollation()
        Returns the collation options
        Returns:
        the collation options
        Since:
        3.4

      • collation

        public UpdateOptions collation​(@Nullable
                               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

      • arrayFilters

        public UpdateOptions arrayFilters​(@Nullable
                                  java.util.List<? extends Bson> arrayFilters)
        Sets the array filters option
        Parameters:
        arrayFilters - the array filters, which may be null
        Returns:
        this
        Since:
        3.6

      • getArrayFilters

        @Nullable
public java.util.List<? extends Bson> getArrayFilters()
        Returns the array filters option
        Returns:
        the array filters, which may be null
        Since:
        3.6

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object