co.elastic.clients.elasticsearch.core.KnnSearchRequest Maven / Gradle / Ivy
Show all versions of elasticsearch-java Show documentation
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
//----------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------
package co.elastic.clients.elasticsearch.core;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.elasticsearch._types.query_dsl.FieldAndFormat;
import co.elastic.clients.elasticsearch._types.query_dsl.Query;
import co.elastic.clients.elasticsearch.core.knn_search.KnnSearchQuery;
import co.elastic.clients.elasticsearch.core.search.SourceConfig;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.transport.Endpoint;
import co.elastic.clients.transport.endpoints.SimpleEndpoint;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.String;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import java.util.stream.Collectors;
import javax.annotation.Nullable;
// typedef: _global.knn_search.Request
/**
* Performs a kNN search.
*
* @see API
* specification
*/
@JsonpDeserializable
public class KnnSearchRequest extends RequestBase implements JsonpSerializable {
@Nullable
private final SourceConfig source;
private final List docvalueFields;
private final List fields;
private final List filter;
private final List index;
private final KnnSearchQuery knn;
@Nullable
private final String routing;
private final List storedFields;
// ---------------------------------------------------------------------------------------------
private KnnSearchRequest(Builder builder) {
this.source = builder.source;
this.docvalueFields = ApiTypeHelper.unmodifiable(builder.docvalueFields);
this.fields = ApiTypeHelper.unmodifiable(builder.fields);
this.filter = ApiTypeHelper.unmodifiable(builder.filter);
this.index = ApiTypeHelper.unmodifiableRequired(builder.index, this, "index");
this.knn = ApiTypeHelper.requireNonNull(builder.knn, this, "knn");
this.routing = builder.routing;
this.storedFields = ApiTypeHelper.unmodifiable(builder.storedFields);
}
public static KnnSearchRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Indicates which source fields are returned for matching documents. These
* fields are returned in the hits._source property of the search response.
*
* API name: {@code _source}
*/
@Nullable
public final SourceConfig source() {
return this.source;
}
/**
* The request returns doc values for field names matching these patterns in the
* hits.fields property of the response. Accepts wildcard (*) patterns.
*
* API name: {@code docvalue_fields}
*/
public final List docvalueFields() {
return this.docvalueFields;
}
/**
* The request returns values for field names matching these patterns in the
* hits.fields property of the response. Accepts wildcard (*) patterns.
*
* API name: {@code fields}
*/
public final List fields() {
return this.fields;
}
/**
* Query to filter the documents that can match. The kNN search will return the
* top k documents that also match this filter. The value can be a
* single query or a list of queries. If filter isn't provided, all
* documents are allowed to match.
*
* API name: {@code filter}
*/
public final List filter() {
return this.filter;
}
/**
* Required - A comma-separated list of index names to search; use
* _all or to perform the operation on all indices
*
* API name: {@code index}
*/
public final List index() {
return this.index;
}
/**
* Required - kNN query to execute
*
* API name: {@code knn}
*/
public final KnnSearchQuery knn() {
return this.knn;
}
/**
* A comma-separated list of specific routing values
*
* API name: {@code routing}
*/
@Nullable
public final String routing() {
return this.routing;
}
/**
* List of stored fields to return as part of a hit. If no fields are specified,
* no stored fields are included in the response. If this field is specified,
* the _source parameter defaults to false. You can pass _source: true to return
* both source fields and stored fields in the search response.
*
* API name: {@code stored_fields}
*/
public final List storedFields() {
return this.storedFields;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
if (this.source != null) {
generator.writeKey("_source");
this.source.serialize(generator, mapper);
}
if (ApiTypeHelper.isDefined(this.docvalueFields)) {
generator.writeKey("docvalue_fields");
generator.writeStartArray();
for (FieldAndFormat item0 : this.docvalueFields) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.fields)) {
generator.writeKey("fields");
generator.writeStartArray();
for (String item0 : this.fields) {
generator.write(item0);
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.filter)) {
generator.writeKey("filter");
generator.writeStartArray();
for (Query item0 : this.filter) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
generator.writeKey("knn");
this.knn.serialize(generator, mapper);
if (ApiTypeHelper.isDefined(this.storedFields)) {
generator.writeKey("stored_fields");
generator.writeStartArray();
for (String item0 : this.storedFields) {
generator.write(item0);
}
generator.writeEnd();
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link KnnSearchRequest}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
@Nullable
private SourceConfig source;
@Nullable
private List docvalueFields;
@Nullable
private List fields;
@Nullable
private List filter;
private List index;
private KnnSearchQuery knn;
@Nullable
private String routing;
@Nullable
private List storedFields;
/**
* Indicates which source fields are returned for matching documents. These
* fields are returned in the hits._source property of the search response.
*
* API name: {@code _source}
*/
public final Builder source(@Nullable SourceConfig value) {
this.source = value;
return this;
}
/**
* Indicates which source fields are returned for matching documents. These
* fields are returned in the hits._source property of the search response.
*
* API name: {@code _source}
*/
public final Builder source(Function> fn) {
return this.source(fn.apply(new SourceConfig.Builder()).build());
}
/**
* The request returns doc values for field names matching these patterns in the
* hits.fields property of the response. Accepts wildcard (*) patterns.
*
* API name: {@code docvalue_fields}
*
* Adds all elements of list to docvalueFields.
*/
public final Builder docvalueFields(List list) {
this.docvalueFields = _listAddAll(this.docvalueFields, list);
return this;
}
/**
* The request returns doc values for field names matching these patterns in the
* hits.fields property of the response. Accepts wildcard (*) patterns.
*
* API name: {@code docvalue_fields}
*
* Adds one or more values to docvalueFields.
*/
public final Builder docvalueFields(FieldAndFormat value, FieldAndFormat... values) {
this.docvalueFields = _listAdd(this.docvalueFields, value, values);
return this;
}
/**
* The request returns doc values for field names matching these patterns in the
* hits.fields property of the response. Accepts wildcard (*) patterns.
*
* API name: {@code docvalue_fields}
*
* Adds a value to docvalueFields using a builder lambda.
*/
public final Builder docvalueFields(Function> fn) {
return docvalueFields(fn.apply(new FieldAndFormat.Builder()).build());
}
/**
* The request returns values for field names matching these patterns in the
* hits.fields property of the response. Accepts wildcard (*) patterns.
*
* API name: {@code fields}
*
* Adds all elements of list to fields.
*/
public final Builder fields(List list) {
this.fields = _listAddAll(this.fields, list);
return this;
}
/**
* The request returns values for field names matching these patterns in the
* hits.fields property of the response. Accepts wildcard (*) patterns.
*
* API name: {@code fields}
*
* Adds one or more values to fields.
*/
public final Builder fields(String value, String... values) {
this.fields = _listAdd(this.fields, value, values);
return this;
}
/**
* Query to filter the documents that can match. The kNN search will return the
* top k documents that also match this filter. The value can be a
* single query or a list of queries. If filter isn't provided, all
* documents are allowed to match.
*
* API name: {@code filter}
*
* Adds all elements of list to filter.
*/
public final Builder filter(List list) {
this.filter = _listAddAll(this.filter, list);
return this;
}
/**
* Query to filter the documents that can match. The kNN search will return the
* top k documents that also match this filter. The value can be a
* single query or a list of queries. If filter isn't provided, all
* documents are allowed to match.
*
* API name: {@code filter}
*
* Adds one or more values to filter.
*/
public final Builder filter(Query value, Query... values) {
this.filter = _listAdd(this.filter, value, values);
return this;
}
/**
* Query to filter the documents that can match. The kNN search will return the
* top k documents that also match this filter. The value can be a
* single query or a list of queries. If filter isn't provided, all
* documents are allowed to match.
*
* API name: {@code filter}
*
* Adds a value to filter using a builder lambda.
*/
public final Builder filter(Function> fn) {
return filter(fn.apply(new Query.Builder()).build());
}
/**
* Required - A comma-separated list of index names to search; use
* _all or to perform the operation on all indices
*
* API name: {@code index}
*
* Adds all elements of list to index.
*/
public final Builder index(List list) {
this.index = _listAddAll(this.index, list);
return this;
}
/**
* Required - A comma-separated list of index names to search; use
* _all or to perform the operation on all indices
*
* API name: {@code index}
*
* Adds one or more values to index.
*/
public final Builder index(String value, String... values) {
this.index = _listAdd(this.index, value, values);
return this;
}
/**
* Required - kNN query to execute
*
* API name: {@code knn}
*/
public final Builder knn(KnnSearchQuery value) {
this.knn = value;
return this;
}
/**
* Required - kNN query to execute
*
* API name: {@code knn}
*/
public final Builder knn(Function> fn) {
return this.knn(fn.apply(new KnnSearchQuery.Builder()).build());
}
/**
* A comma-separated list of specific routing values
*
* API name: {@code routing}
*/
public final Builder routing(@Nullable String value) {
this.routing = value;
return this;
}
/**
* List of stored fields to return as part of a hit. If no fields are specified,
* no stored fields are included in the response. If this field is specified,
* the _source parameter defaults to false. You can pass _source: true to return
* both source fields and stored fields in the search response.
*
* API name: {@code stored_fields}
*
* Adds all elements of list to storedFields.
*/
public final Builder storedFields(List list) {
this.storedFields = _listAddAll(this.storedFields, list);
return this;
}
/**
* List of stored fields to return as part of a hit. If no fields are specified,
* no stored fields are included in the response. If this field is specified,
* the _source parameter defaults to false. You can pass _source: true to return
* both source fields and stored fields in the search response.
*
* API name: {@code stored_fields}
*
* Adds one or more values to storedFields.
*/
public final Builder storedFields(String value, String... values) {
this.storedFields = _listAdd(this.storedFields, value, values);
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link KnnSearchRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public KnnSearchRequest build() {
_checkSingleUse();
return new KnnSearchRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link KnnSearchRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
KnnSearchRequest::setupKnnSearchRequestDeserializer);
protected static void setupKnnSearchRequestDeserializer(ObjectDeserializer op) {
op.add(Builder::source, SourceConfig._DESERIALIZER, "_source");
op.add(Builder::docvalueFields, JsonpDeserializer.arrayDeserializer(FieldAndFormat._DESERIALIZER),
"docvalue_fields");
op.add(Builder::fields, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()), "fields");
op.add(Builder::filter, JsonpDeserializer.arrayDeserializer(Query._DESERIALIZER), "filter");
op.add(Builder::knn, KnnSearchQuery._DESERIALIZER, "knn");
op.add(Builder::storedFields, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()),
"stored_fields");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code knn_search}".
*/
public static final SimpleEndpoint _ENDPOINT = new SimpleEndpoint<>("es/knn_search",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
final int _index = 1 << 0;
int propsSet = 0;
propsSet |= _index;
if (propsSet == (_index)) {
StringBuilder buf = new StringBuilder();
buf.append("/");
SimpleEndpoint.pathEncode(request.index.stream().map(v -> v).collect(Collectors.joining(",")), buf);
buf.append("/_knn_search");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.routing != null) {
params.put("routing", request.routing);
}
return params;
}, SimpleEndpoint.emptyMap(), true, KnnSearchResponse._DESERIALIZER);
/**
* Create an "{@code knn_search}" endpoint.
*/
public static Endpoint, ErrorResponse> createKnnSearchEndpoint(
JsonpDeserializer tDocumentDeserializer) {
return _ENDPOINT
.withResponseDeserializer(KnnSearchResponse.createKnnSearchResponseDeserializer(tDocumentDeserializer));
}
}