Enum Class FullDocument

java.lang.Object
java.lang.Enum<FullDocument>
com.mongodb.client.model.changestream.FullDocument
All Implemented Interfaces:
Serializable, Comparable<FullDocument>, java.lang.constant.Constable

public enum FullDocument extends Enum<FullDocument>
Change Stream fullDocument configuration.

Determines what to return for update operations when using a Change Stream. Defaults to DEFAULT. When set to UPDATE_LOOKUP, the change stream for partial updates will include both a delta describing the changes to the document as well as a copy of the entire document that was changed from some time after the change occurred.

Since:
3.6
Since server release
3.6
  • Enum Constant Details

    • DEFAULT

      public static final FullDocument DEFAULT
      Default

      Returns the servers default value in the fullDocument field.

    • UPDATE_LOOKUP

      public static final FullDocument UPDATE_LOOKUP
      Lookup

      The change stream for partial updates will include both a delta describing the changes to the document as well as a copy of the entire document that was changed from some time after the change occurred.

  • Method Details

    • values

      public static FullDocument[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static FullDocument valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getValue

      public String getValue()
      Returns:
      the String representation of the collation case first value
    • fromString

      public static FullDocument fromString(String changeStreamFullDocument)
      Returns the ChangeStreamFullDocument from the string value.
      Parameters:
      changeStreamFullDocument - the string value.
      Returns:
      the read concern