Class FunctionScoreQuery
java.lang.Object
org.opensearch.client.opensearch._types.query_dsl.QueryBase
org.opensearch.client.opensearch._types.query_dsl.FunctionScoreQuery
- All Implemented Interfaces:
JsonpSerializable,PlainJsonSerializable,QueryVariant,ToCopyableBuilder<FunctionScoreQuery.Builder,FunctionScoreQuery>
@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class FunctionScoreQuery
extends QueryBase
implements QueryVariant, ToCopyableBuilder<FunctionScoreQuery.Builder,FunctionScoreQuery>
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase
QueryBase.AbstractBuilder<BuilderT extends QueryBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<FunctionScoreQuery> Json deserializer forFunctionScoreQuery -
Method Summary
Modifier and TypeMethodDescriptionQueryvariant kind.final FunctionBoostModeAPI name:boost_modestatic FunctionScoreQuery.Builderbuilder()booleanfinal List<FunctionScore> One or more functions that compute a new score for each document returned by the query.inthashCode()final FloatmaxBoost()Restricts the new score to not exceed the provided limit.final FloatminScore()Excludes documents that do not meet the provided score threshold.static FunctionScoreQueryfinal Queryquery()API name:queryfinal FunctionScoreModeAPI name:score_modeprotected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static voidCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.Methods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase
boost, queryName, serialize, setupQueryBaseDeserializerMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.opensearch._types.query_dsl.QueryVariant
toQueryMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_DESERIALIZER
Json deserializer forFunctionScoreQuery
-
-
Method Details
-
of
public static FunctionScoreQuery of(Function<FunctionScoreQuery.Builder, ObjectBuilder<FunctionScoreQuery>> fn) -
_queryKind
Queryvariant kind.- Specified by:
_queryKindin interfaceQueryVariant
-
boostMode
API name:boost_mode -
functions
One or more functions that compute a new score for each document returned by the query.API name:
functions -
maxBoost
Restricts the new score to not exceed the provided limit.API name:
max_boost -
minScore
Excludes documents that do not meet the provided score threshold.API name:
min_score -
query
API name:query -
scoreMode
API name:score_mode -
serializeInternal
- Overrides:
serializeInternalin classQueryBase
-
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<FunctionScoreQuery.Builder,FunctionScoreQuery> - Returns:
- a new builder instance.
-
builder
-
setupFunctionScoreQueryDeserializer
protected static void setupFunctionScoreQueryDeserializer(ObjectDeserializer<FunctionScoreQuery.Builder> op) -
hashCode
public int hashCode() -
equals
-