java.lang.Object
- com.mongodb.client.model.MergeOptions

```
@Deprecated(since="2021-05-27")
public final class MergeOptions
extends java.lang.Object
```
Deprecated.
Usage of this API is not supported in AEM as a Cloud Service.

Options to control the behavior of the $merge aggregation stage

Since:

3.11

See Also:

Aggregates.merge(String, MergeOptions), Aggregates.merge(com.mongodb.MongoNamespace, MergeOptions)

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`MergeOptions.WhenMatched`	Deprecated. The behavior of $merge if a result document and an existing document in the collection have the same value for the specified on field(s).
`static class`	`MergeOptions.WhenNotMatched`	Deprecated. The behavior of $merge if a result document does not match an existing document in the out collection.

Constructor Summary

Constructors
Constructor Description

MergeOptions()
Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object o)`	Deprecated.
`java.util.List<java.lang.String>`	`getUniqueIdentifier()`	Deprecated. Gets the fields that act as a unique identifier for a document.
`java.util.List<Variable<?>>`	`getVariables()`	Deprecated. Gets the variables accessible for use in the whenMatched pipeline
`MergeOptions.WhenMatched`	`getWhenMatched()`	Deprecated. Gets the behavior of $merge if a result document and an existing document in the collection have the same value for the specified on field(s).
`java.util.List<Bson>`	`getWhenMatchedPipeline()`	Deprecated. Gets aggregation pipeline to update the document in the collection.
`MergeOptions.WhenNotMatched`	`getWhenNotMatched()`	Deprecated. Gets the behavior of $merge if a result document does not match an existing document in the out collection.
`int`	`hashCode()`	Deprecated.
`java.lang.String`	`toString()`	Deprecated.
`MergeOptions`	`uniqueIdentifier(java.lang.String uniqueIdentifier)`	Deprecated. Sets the field that act as a unique identifier for a document.
`MergeOptions`	`uniqueIdentifier(java.util.List<java.lang.String> uniqueIdentifier)`	Deprecated. Sets the field that act as a unique identifier for a document.
`MergeOptions`	`variables(java.util.List<Variable<?>> variables)`	Deprecated. Sets the variables accessible for use in the whenMatched pipeline.
`MergeOptions`	`whenMatched(MergeOptions.WhenMatched whenMatched)`	Deprecated. Sets the behavior of $merge if a result document and an existing document in the collection have the same value for the specified on field(s).
`MergeOptions`	`whenMatchedPipeline(java.util.List<Bson> whenMatchedPipeline)`	Deprecated. Sets aggregation pipeline to update the document in the collection.
`MergeOptions`	`whenNotMatched(MergeOptions.WhenNotMatched whenNotMatched)`	Deprecated. Sets the behavior of $merge if a result document does not match an existing document in the out collection.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MergeOptions
```
public MergeOptions()
```
    Deprecated.
- Method Detail
  - getUniqueIdentifier
```
public java.util.List<java.lang.String> getUniqueIdentifier()
```
    Deprecated.
    
    Gets the fields that act as a unique identifier for a document. The identifier determine if a results document matches an already existing document in the output collection.
    
    Returns:
    
    the unique identifier
  - uniqueIdentifier
```
public MergeOptions uniqueIdentifier(java.lang.String uniqueIdentifier)
```
    Deprecated.
    
    Sets the field that act as a unique identifier for a document. The identifier determine if a results document matches an already existing document in the output collection.
    
    Parameters:
    
    uniqueIdentifier - the unique identifier
    
    Returns:
    
    this
  - uniqueIdentifier
```
public MergeOptions uniqueIdentifier(java.util.List<java.lang.String> uniqueIdentifier)
```
    Deprecated.
    
    Sets the field that act as a unique identifier for a document. The identifier determine if a results document matches an already existing document in the output collection.
    
    Parameters:
    
    uniqueIdentifier - the unique identifier
    
    Returns:
    
    this
  - getWhenMatched
```
public MergeOptions.WhenMatched getWhenMatched()
```
    Deprecated.
    
    Gets the behavior of $merge if a result document and an existing document in the collection have the same value for the specified on field(s).
    
    Returns:
    
    when matched
  - whenMatched
```
public MergeOptions whenMatched(MergeOptions.WhenMatched whenMatched)
```
    Deprecated.
    
    Sets the behavior of $merge if a result document and an existing document in the collection have the same value for the specified on field(s).
    
    Parameters:
    
    whenMatched - when matched
    
    Returns:
    
    this
  - getVariables
```
public java.util.List<Variable<?>> getVariables()
```
    Deprecated.
    
    Gets the variables accessible for use in the whenMatched pipeline
    
    Returns:
    
    the variables
  - variables
```
public MergeOptions variables(java.util.List<Variable<?>> variables)
```
    Deprecated.
    
    Sets the variables accessible for use in the whenMatched pipeline.
    
    Parameters:
    
    variables - the variables
    
    Returns:
    
    this
  - getWhenMatchedPipeline
```
public java.util.List<Bson> getWhenMatchedPipeline()
```
    Deprecated.
    
    Gets aggregation pipeline to update the document in the collection.
    
    Returns:
    
    when matched pipeline
    
    See Also:
    
    MergeOptions.WhenMatched.PIPELINE
  - whenMatchedPipeline
```
public MergeOptions whenMatchedPipeline(java.util.List<Bson> whenMatchedPipeline)
```
    Deprecated.
    
    Sets aggregation pipeline to update the document in the collection.
    
    Parameters:
    
    whenMatchedPipeline - when matched pipeline
    
    Returns:
    
    this
    
    See Also:
    
    MergeOptions.WhenMatched.PIPELINE
  - getWhenNotMatched
```
public MergeOptions.WhenNotMatched getWhenNotMatched()
```
    Deprecated.
    
    Gets the behavior of $merge if a result document does not match an existing document in the out collection.
    
    Returns:
    
    when not matched
  - whenNotMatched
```
public MergeOptions whenNotMatched(MergeOptions.WhenNotMatched whenNotMatched)
```
    Deprecated.
    
    Sets the behavior of $merge if a result document does not match an existing document in the out collection.
    
    Parameters:
    
    whenNotMatched - when not matched
    
    Returns:
    
    this
  - equals
```
public boolean equals(java.lang.Object o)
```
    Deprecated.
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Deprecated.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Deprecated.
    
    Overrides:
    
    toString in class java.lang.Object

Class MergeOptions

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MergeOptions

Method Detail

getUniqueIdentifier

uniqueIdentifier

uniqueIdentifier

getWhenMatched

whenMatched

getVariables

variables

getWhenMatchedPipeline

whenMatchedPipeline

getWhenNotMatched

whenNotMatched

equals

hashCode

toString