Package org.springframework.data.mongodb.core.aggregation

Enum Class OutOperation.OutMode

java.lang.Object
java.lang.Enum<OutOperation.OutMode>
org.springframework.data.mongodb.core.aggregation.OutOperation.OutMode
All Implemented Interfaces:
Serializable, Comparable<OutOperation.OutMode>, Constable
Enclosing class:
OutOperation
@Deprecated(since="4.5.1", forRemoval=true) public static enum OutOperation.OutMode extends Enum<OutOperation.OutMode>
Deprecated, for removal: This API element is subject to removal in a future version.
extended $out syntax was superseded by $merge. Support for the extended syntax has been removed with MongoDB 5, use MergeOperation instead.
The mode for merging the aggregation pipeline output.
Since:
2.2
Author:
Christoph Strobl

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    INSERT
    Deprecated, for removal: This API element is subject to removal in a future version.
    Write documents to the target collection.
    REPLACE
    Deprecated, for removal: This API element is subject to removal in a future version.
    Update on any document in the target collection with the same uniqueKey.
    REPLACE_COLLECTION
    Deprecated, for removal: This API element is subject to removal in a future version.
    Replaces the to collection with the output from the aggregation pipeline.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getMongoMode()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static OutOperation.OutMode
    valueOf(String name)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the enum constant of this class with the specified name.
    static OutOperation.OutMode[]
    values()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • INSERT

      public static final OutOperation.OutMode INSERT
      Deprecated, for removal: This API element is subject to removal in a future version.
      Write documents to the target collection. Errors if a document same uniqueKey already exists.

    • REPLACE

      public static final OutOperation.OutMode REPLACE
      Deprecated, for removal: This API element is subject to removal in a future version.
      Update on any document in the target collection with the same uniqueKey.

    • REPLACE_COLLECTION

      public static final OutOperation.OutMode REPLACE_COLLECTION
      Deprecated, for removal: This API element is subject to removal in a future version.
      Replaces the to collection with the output from the aggregation pipeline. Cannot be in a different database.

  • Method Details

    • values

      public static OutOperation.OutMode[] values()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 OutOperation.OutMode valueOf(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

    • getMongoMode

      public String getMongoMode()
      Deprecated, for removal: This API element is subject to removal in a future version.