Package com.mongodb.client.model

Interface ScoreFusionOptions

All Superinterfaces:

Bson

@Sealed
public interface ScoreFusionOptions
extends Bson

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

Since:

5.10

MongoDB documentation

$scoreFusion

Since server release

8.2

Field Summary

Fields inherited from interface org.bson.conversions.Bson

DEFAULT_CODEC_REGISTRY

Method Summary

Modifier and Type	Method	Description
ScoreFusionOptions	combination(ScoreFusionCombination combination)	Creates a new ScoreFusionOptions with the combination specified.
ScoreFusionOptions	option(String name, Object value)	Creates a new ScoreFusionOptions with the specified option in situations when there is no builder method that better satisfies your needs.
ScoreFusionOptions	scoreDetails(boolean scoreDetails)	Creates a new ScoreFusionOptions with the scoreDetails flag specified.
static ScoreFusionOptions	scoreFusionOptions()	Returns ScoreFusionOptions that represents server defaults.

Methods inherited from interface org.bson.conversions.Bson

toBsonDocument, toBsonDocument

Method Details

scoreFusionOptions

static ScoreFusionOptions scoreFusionOptions()

Returns ScoreFusionOptions that represents server defaults.

Returns:

ScoreFusionOptions that represents server defaults.

combination

ScoreFusionOptions combination(ScoreFusionCombination combination)

Creates a new ScoreFusionOptions with the combination specified. If not specified, the server combines the normalized scores using its default method.

Parameters:

combination - The way in which the normalized scores are combined.

Returns:

A new ScoreFusionOptions.

scoreDetails

ScoreFusionOptions scoreDetails(boolean scoreDetails)

Creates a new ScoreFusionOptions with the scoreDetails flag specified. When true, the server exposes score details via the {$meta: "scoreDetails"} expression. Server default is false.

Parameters:

scoreDetails - Whether to include score details.

Returns:

A new ScoreFusionOptions.

option

ScoreFusionOptions option(String name,
 Object value)

Creates a new ScoreFusionOptions 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.

Parameters:

name - The option name.

value - The option value.

Returns:

A new ScoreFusionOptions.