io.micronaut.data.mongodb.annotation

Annotation Type MongoAggregateOptions

@Retention(value=RUNTIME)
 @Target(value={ANNOTATION_TYPE,METHOD,TYPE})
 @Documented
 @Inherited
public @interface MongoAggregateOptions

Defines a custom MongoDB aggregate query options.

Since:

3.3.0

Author:

Denis Stepanov

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allowDiskUse The allowDiskUse.
boolean	bypassDocumentValidation The bypassDocumentValidation.
java.lang.String	comment The comment.
java.lang.String	hint The hint.
long	maxAwaitTimeMS The maxAwaitTimeMS.
long	maxTimeMS The maxTimeMS.

Element Detail

bypassDocumentValidation

public abstract boolean bypassDocumentValidation

The bypassDocumentValidation.

Returns:

The bypassDocumentValidation value

Default:

false

maxTimeMS

public abstract long maxTimeMS

The maxTimeMS.

Returns:

The maxTimeMS value

Default:

-1L

maxAwaitTimeMS

public abstract long maxAwaitTimeMS

The maxAwaitTimeMS.

Returns:

The maxAwaitTimeMS value

Default:

-1L

comment

public abstract java.lang.String comment

The comment.

Returns:

The comment value

Default:

""

hint

public abstract java.lang.String hint

The hint.

Returns:

The hint value

Default:

""

allowDiskUse

public abstract boolean allowDiskUse

The allowDiskUse.

Returns:

The allowDiskUse value

Default:

false