Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.inference.trainedmodel.ltr

Record Class QueryExtractorBuilder

java.lang.Object

java.lang.Record

org.elasticsearch.xpack.core.ml.inference.trainedmodel.ltr.QueryExtractorBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, Rewriteable<LearningToRankFeatureExtractorBuilder>, ToXContent, ToXContentObject, LearningToRankFeatureExtractorBuilder, NamedXContentObject

public record QueryExtractorBuilder(String featureName, QueryProvider query, float defaultScore)
extends Record
implements LearningToRankFeatureExtractorBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	DEFAULT_SCORE
static final float	DEFAULT_SCORE_DEFAULT
static final ParseField	FEATURE_NAME
static final ParseField	NAME
static final ParseField	QUERY

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
QueryExtractorBuilder(String featureName, QueryProvider query)
QueryExtractorBuilder(String featureName, QueryProvider query, float defaultScore)	Creates an instance of a QueryExtractorBuilder record class.
QueryExtractorBuilder(StreamInput input)

Method Summary

Modifier and Type	Method	Description
float	defaultScore()	Returns the value of the defaultScore record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	featureName()	Returns the value of the featureName record component.
static QueryExtractorBuilder	fromXContent(XContentParser parser, Object context)
String	getName()
String	getWriteableName()
final int	hashCode()	Returns a hash code value for this object.
QueryProvider	query()	Returns the value of the query record component.
QueryExtractorBuilder	rewrite(QueryRewriteContext ctx)
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	validate()
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final ParseField NAME

FEATURE_NAME

public static final ParseField FEATURE_NAME

QUERY

public static final ParseField QUERY

DEFAULT_SCORE

public static final ParseField DEFAULT_SCORE

DEFAULT_SCORE_DEFAULT

public static final float DEFAULT_SCORE_DEFAULT

See Also:

• Constant Field Values

Constructor Details

QueryExtractorBuilder

public QueryExtractorBuilder(String featureName,
 QueryProvider query)

QueryExtractorBuilder

public QueryExtractorBuilder(String featureName,
 QueryProvider query,
 float defaultScore)

Creates an instance of a QueryExtractorBuilder record class.

Parameters:

featureName - the value for the featureName record component

query - the value for the query record component

defaultScore - the value for the defaultScore record component

QueryExtractorBuilder

public QueryExtractorBuilder(StreamInput input)
                      throws IOException

Throws:

IOException

Method Details

fromXContent

public static QueryExtractorBuilder fromXContent(XContentParser parser,
 Object context)

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

featureName

public String featureName()

Returns the value of the featureName record component.

Specified by:

featureName in interface LearningToRankFeatureExtractorBuilder

Returns:

the value of the featureName record component

validate

public void validate()
              throws Exception

Specified by:

validate in interface LearningToRankFeatureExtractorBuilder

Throws:

Exception - If the extractor is invalid.

getName

public String getName()

Specified by:

getName in interface NamedXContentObject

Returns:

The name of the XContentObject that is to be serialized

rewrite

public QueryExtractorBuilder rewrite(QueryRewriteContext ctx)
                              throws IOException

Specified by:

rewrite in interface Rewriteable<LearningToRankFeatureExtractorBuilder>

Throws:

IOException

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

query

public QueryProvider query()

Returns the value of the query record component.

Returns:

the value of the query record component

defaultScore

public float defaultScore()

Returns the value of the defaultScore record component.

Returns:

the value of the defaultScore record component