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

Class RedactOperation

java.lang.Object

org.springframework.data.mongodb.core.aggregation.RedactOperation

All Implemented Interfaces:

AggregationOperation

public class RedactOperation
extends Object
implements AggregationOperation

RedactOperation allows to restrict the content of a Document based on information stored within itself.

 RedactOperation.builder() //
                .when(Criteria.where("level").is(5)) //
                .thenPrune() //
                .otherwiseDescend() //
                .build();
 

Since:

3.0

Author:

Christoph Strobl

See Also:

• https://docs.mongodb.com/manual/reference/operator/aggregation/redact/

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RedactOperation.RedactOperationBuilder	Builder to create new instance of RedactOperation.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DESCEND	Return fields at the current document level.
static final String	KEEP	Return/Keep all fields at the current document/embedded level.
static final String	PRUNE	Exclude all fields at this current document/embedded level.

Constructor Summary

Constructors

Constructor	Description
RedactOperation(AggregationExpression condition)	Create new RedactOperation.

Method Summary

Modifier and Type	Method	Description
static RedactOperation.RedactOperationBuilder	builder()	Obtain a new instance of RedactOperation.RedactOperationBuilder to specify condition and outcome of the $redact operation.
String	getOperator()	Return the MongoDB operator that is used for this AggregationOperation.
org.bson.Document	toDocument(AggregationOperationContext context)	Turns the AggregationOperation into a Document by using the given AggregationOperationContext.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.data.mongodb.core.aggregation.AggregationOperation

toPipelineStages

Field Details

DESCEND

public static final String DESCEND

Return fields at the current document level. Exclude embedded ones.

See Also:

• Constant Field Values

KEEP

public static final String KEEP

Return/Keep all fields at the current document/embedded level.

See Also:

• Constant Field Values

PRUNE

public static final String PRUNE

Exclude all fields at this current document/embedded level.

See Also:

• Constant Field Values

Constructor Details

RedactOperation

public RedactOperation(AggregationExpression condition)

Create new RedactOperation.

Parameters:

condition - Any AggregationExpression that resolves to $$DESCEND, $$PRUNE, or $$KEEP. Must not be null.

Method Details

toDocument

public org.bson.Document toDocument(AggregationOperationContext context)

Description copied from interface: AggregationOperation

Turns the AggregationOperation into a Document by using the given AggregationOperationContext.

Specified by:

toDocument in interface AggregationOperation

Parameters:

context - the AggregationOperationContext to operate within. Must not be null.

Returns:

the Document

getOperator

public String getOperator()

Description copied from interface: AggregationOperation

Return the MongoDB operator that is used for this AggregationOperation. Aggregation operations should implement this method to avoid document rendering.

Specified by:

getOperator in interface AggregationOperation

Returns:

the operator used for this AggregationOperation.

builder

public static RedactOperation.RedactOperationBuilder builder()

Obtain a new instance of RedactOperation.RedactOperationBuilder to specify condition and outcome of the $redact operation.

Returns:

new instance of RedactOperation.RedactOperationBuilder.