Package com.mongodb.client.model
Class UnwindOptions
- java.lang.Object
-
- com.mongodb.client.model.UnwindOptions
-
@Deprecated(since="2021-05-27") public final class UnwindOptions extends Object
Deprecated.Usage of this API is not supported in AEM as a Cloud Service.The options for an unwind aggregation pipeline stage- Since:
- 3.2
-
-
Constructor Summary
Constructors Constructor Description UnwindOptions()
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description String
getIncludeArrayIndex()
Deprecated.Gets the includeArrayIndex field if set or nullUnwindOptions
includeArrayIndex(String arrayIndexFieldName)
Deprecated.Sets the field to be used to store the array index of the unwound itemBoolean
isPreserveNullAndEmptyArrays()
Deprecated.If true the unwind stage will include documents that have null values or empty arraysUnwindOptions
preserveNullAndEmptyArrays(Boolean preserveNullAndEmptyArrays)
Deprecated.Sets true if the unwind stage should include documents that have null values or empty arraysString
toString()
Deprecated.
-
-
-
Method Detail
-
isPreserveNullAndEmptyArrays
@Nullable public Boolean isPreserveNullAndEmptyArrays()
Deprecated.If true the unwind stage will include documents that have null values or empty arrays- Returns:
- the preserve null values and empty arrays value or null
-
preserveNullAndEmptyArrays
public UnwindOptions preserveNullAndEmptyArrays(@Nullable Boolean preserveNullAndEmptyArrays)
Deprecated.Sets true if the unwind stage should include documents that have null values or empty arrays- Parameters:
preserveNullAndEmptyArrays
- flag depicting if the unwind stage should include documents that have null values or empty arrays- Returns:
- this
-
getIncludeArrayIndex
@Nullable public String getIncludeArrayIndex()
Deprecated.Gets the includeArrayIndex field if set or null- Returns:
- the includeArrayIndex field if set or null
-
includeArrayIndex
public UnwindOptions includeArrayIndex(@Nullable String arrayIndexFieldName)
Deprecated.Sets the field to be used to store the array index of the unwound item- Parameters:
arrayIndexFieldName
- the field to be used to store the array index of the unwound item- Returns:
- this
-
-