Module org.elasticsearch.server

Package org.elasticsearch.search.vectors

Class LookupQueryVectorBuilder

java.lang.Object

org.elasticsearch.search.vectors.LookupQueryVectorBuilder

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, QueryVectorBuilder, ToXContent, ToXContentObject

public class LookupQueryVectorBuilder
extends Object
implements QueryVectorBuilder

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	ID_FIELD
static final ParseField	INDEX_FIELD
static final TransportVersion	LOOKUP_QVB_TV
static final ParseField	NAME
static final ParseField	PATH_FIELD
static final ParseField	ROUTING_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
LookupQueryVectorBuilder(String id, String index, String path, String routing)	Create a new LookupQueryVectorBuilder
LookupQueryVectorBuilder(StreamInput in)

Method Summary

Modifier and Type	Method	Description
void	buildVector(Client client, ActionListener<float[]> listener)	Method for building a vector via the client.
boolean	equals(Object o)
static LookupQueryVectorBuilder	fromXContent(XContentParser parser)
String	getId()
String	getIndex()
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to.
String	getPath()
String	getRouting()
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable

supportsVersion

Field Details

LOOKUP_QVB_TV

public static final TransportVersion LOOKUP_QVB_TV

NAME

public static final ParseField NAME

ID_FIELD

public static final ParseField ID_FIELD

INDEX_FIELD

public static final ParseField INDEX_FIELD

PATH_FIELD

public static final ParseField PATH_FIELD

ROUTING_FIELD

public static final ParseField ROUTING_FIELD

Constructor Details

LookupQueryVectorBuilder

public LookupQueryVectorBuilder(String id,
 String index,
 String path,
 String routing)

Create a new LookupQueryVectorBuilder

Parameters:

id - the document id to lookup

index - the index where the document is stored

path - the path to the vector field in the document

routing - the routing value to use when looking up the document (can be null)

LookupQueryVectorBuilder

public LookupQueryVectorBuilder(StreamInput in)
                         throws IOException

Throws:

IOException

Method Details

fromXContent

public static LookupQueryVectorBuilder fromXContent(XContentParser parser)
                                             throws IOException

Throws:

IOException

getId

public String getId()

getIndex

public String getIndex()

getPath

public String getPath()

getRouting

public String getRouting()

buildVector

public void buildVector(Client client,
 ActionListener<float[]> listener)

Description copied from interface: QueryVectorBuilder

Method for building a vector via the client. This method is called during RewriteAndFetch. Typical implementation for this method will: 1. call some asynchronous client action 2. Handle failure/success for that action (usually passing failure to the provided listener) 3. Parse the success case and extract the query vector 4. Pass the extracted query vector to the provided listener

Specified by:

buildVector in interface QueryVectorBuilder

Parameters:

client - for performing asynchronous actions against the cluster

listener - listener to accept the created vector

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to. See VersionedNamedWriteable.supportsVersion(TransportVersion) for the default serialization check.

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object