Package com.mongodb.client.model

Enum AggregateOutStageOptions.Mode

java.lang.Object

java.lang.Enum<AggregateOutStageOptions.Mode>

com.mongodb.client.model.AggregateOutStageOptions.Mode

All Implemented Interfaces:

Serializable, Comparable<AggregateOutStageOptions.Mode>

Enclosing class:

AggregateOutStageOptions

public static enum AggregateOutStageOptions.Mode
extends Enum<AggregateOutStageOptions.Mode>

The output mode

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSERT_DOCUMENTS	Insert new documents into the collection.
REPLACE_COLLECTION	Replace the collection.
REPLACE_DOCUMENTS	Replace all the documents in the collection.

Method Summary

Modifier and Type	Method	Description
static AggregateOutStageOptions.Mode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AggregateOutStageOptions.Mode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

REPLACE_COLLECTION

public static final AggregateOutStageOptions.Mode REPLACE_COLLECTION

Replace the collection. Collection options and indexes are recreated on the output collection. This is the default behavior.

REPLACE_DOCUMENTS

public static final AggregateOutStageOptions.Mode REPLACE_DOCUMENTS

Replace all the documents in the collection. Existing documents are overwritten with a replacement-style update (upsert: true, multi: false). The query used for the update will be the extracted unique key.

See Also:

AggregateOutStageOptions.getUniqueKey()

Since server release

4.2

INSERT_DOCUMENTS

public static final AggregateOutStageOptions.Mode INSERT_DOCUMENTS

Insert new documents into the collection. If a document exists with the same unique key, execution stops and an error is raised.

See Also:

AggregateOutStageOptions.getUniqueKey()

Since server release

4.2

Method Detail

values

public static AggregateOutStageOptions.Mode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AggregateOutStageOptions.Mode c : AggregateOutStageOptions.Mode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AggregateOutStageOptions.Mode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null