Package com.mongodb.client.model.fill

Interface FillOptions

All Superinterfaces:

org.bson.conversions.Bson

@Evolving
public interface FillOptions
extends org.bson.conversions.Bson

Represents optional fields of the $fill pipeline stage of an aggregation pipeline.

Since:

4.7

See Also:

• Aggregates.fill(FillOptions, Iterable)
• Aggregates.fill(FillOptions, FillOutputField, FillOutputField...)

Since server release

5.3

Field Summary

Fields inherited from interface org.bson.conversions.Bson

DEFAULT_CODEC_REGISTRY

Method Summary

Modifier and Type	Method	Description
static FillOptions	fillOptions()	Returns FillOptions that represents server defaults.
FillOptions	option(String name, Object value)	Creates a new FillOptions with the specified option in situations when there is no builder method that better satisfies your needs.
<TExpression> FillOptions	partitionBy(TExpression expression)	Creates a new FillOptions with the specified partitioning.
FillOptions	partitionByFields(Iterable<String> fields)	Creates a new FillOptions with the specified partitioning.
default FillOptions	partitionByFields(String... fields)	Creates a new FillOptions with the specified partitioning.
FillOptions	sortBy(org.bson.conversions.Bson sortBy)	Creates a new FillOptions with the specified sorting.

Methods inherited from interface org.bson.conversions.Bson

toBsonDocument, toBsonDocument

Method Details

partitionBy

<TExpression> FillOptions partitionBy(TExpression expression)

Creates a new FillOptions with the specified partitioning. Overrides partitionByFields(Iterable).

Type Parameters:

TExpression - The type of the expression expression.

Parameters:

expression - The expression specifying how to partition the data. The syntax is the same as the syntax for id in Aggregates.group(Object, List).

Returns:

A new FillOptions.

partitionByFields

default FillOptions partitionByFields(@Nullable
 String... fields)

Creates a new FillOptions with the specified partitioning. Overrides partitionBy(Object).

Parameters:

fields - The fields to partition by.

Returns:

A new FillOptions.

MongoDB documentation

core/document/#dot-notation

partitionByFields

FillOptions partitionByFields(Iterable<String> fields)

Creates a new FillOptions with the specified partitioning. Overrides partitionBy(Object).

Parameters:

fields - The fields to partition by.

Returns:

A new FillOptions.

MongoDB documentation

core/document/#dot-notation

sortBy

FillOptions sortBy(org.bson.conversions.Bson sortBy)

Creates a new FillOptions with the specified sorting.

Parameters:

sortBy - The sort specification, which may be constructed via Sorts.

Returns:

A new FillOptions.

option

FillOptions option(String name,
 Object value)

Creates a new FillOptions with the specified option in situations when there is no builder method that better satisfies your needs. This method cannot be used to validate the syntax.

Example
The following code creates two functionally equivalent FillOptions objects, though they may not be equal.

  FillOptions options1 = FillOptions.fillOptions().partitionByFields("fieldName");
  FillOptions options2 = FillOptions.fillOptions().option("partitionByFields", Collections.singleton("fieldName"));
 

Parameters:

name - The option name.

value - The option value.

Returns:

A new FillOptions.

fillOptions

static FillOptions fillOptions()

Returns FillOptions that represents server defaults.

Returns:

FillOptions that represents server defaults.