Package com.mongodb.client.model
Class MergeOptions
- java.lang.Object
-
- com.mongodb.client.model.MergeOptions
-
public final class MergeOptions extends java.lang.Object
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
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
The behavior of $merge if a result document does not match an existing document in the out collection.
-
Constructor Summary
Constructors Constructor Description MergeOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object o)
java.util.List<java.lang.String>
getUniqueIdentifier()
Gets the fields that act as a unique identifier for a document.java.util.List<Variable<?>>
getVariables()
Gets the variables accessible for use in the whenMatched pipelineMergeOptions.WhenMatched
getWhenMatched()
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()
Gets aggregation pipeline to update the document in the collection.MergeOptions.WhenNotMatched
getWhenNotMatched()
Gets the behavior of $merge if a result document does not match an existing document in the out collection.int
hashCode()
java.lang.String
toString()
MergeOptions
uniqueIdentifier(java.lang.String uniqueIdentifier)
Sets the field that act as a unique identifier for a document.MergeOptions
uniqueIdentifier(java.util.List<java.lang.String> uniqueIdentifier)
Sets the field that act as a unique identifier for a document.MergeOptions
variables(java.util.List<Variable<?>> variables)
Sets the variables accessible for use in the whenMatched pipeline.MergeOptions
whenMatched(MergeOptions.WhenMatched whenMatched)
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)
Sets aggregation pipeline to update the document in the collection.MergeOptions
whenNotMatched(MergeOptions.WhenNotMatched whenNotMatched)
Sets the behavior of $merge if a result document does not match an existing document in the out collection.
-
-
-
Method Detail
-
getUniqueIdentifier
public java.util.List<java.lang.String> getUniqueIdentifier()
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)
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)
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()
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)
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()
Gets the variables accessible for use in the whenMatched pipeline- Returns:
- the variables
-
variables
public MergeOptions variables(java.util.List<Variable<?>> variables)
Sets the variables accessible for use in the whenMatched pipeline.- Parameters:
variables
- the variables- Returns:
- this
-
getWhenMatchedPipeline
public java.util.List<Bson> getWhenMatchedPipeline()
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)
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()
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)
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)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-