co.elastic.clients.elasticsearch.core.ExplainRequest 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.
*/
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.Operator;
import co.elastic.clients.elasticsearch._types.query_dsl.Query;
import co.elastic.clients.elasticsearch.core.search.SourceConfigParam;
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 jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
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;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
// typedef: _global.explain.Request
/**
* Explain a document match result. Returns information about why a specific
* document matches, or doesn’t match, a query.
*
* @see API
* specification
*/
@JsonpDeserializable
public class ExplainRequest extends RequestBase implements JsonpSerializable {
@Nullable
private final SourceConfigParam source;
private final List sourceExcludes;
private final List sourceIncludes;
@Nullable
private final Boolean analyzeWildcard;
@Nullable
private final String analyzer;
@Nullable
private final Operator defaultOperator;
@Nullable
private final String df;
private final String id;
private final String index;
@Nullable
private final Boolean lenient;
@Nullable
private final String preference;
@Nullable
private final String q;
@Nullable
private final Query query;
@Nullable
private final String routing;
private final List storedFields;
// ---------------------------------------------------------------------------------------------
private ExplainRequest(Builder builder) {
this.source = builder.source;
this.sourceExcludes = ApiTypeHelper.unmodifiable(builder.sourceExcludes);
this.sourceIncludes = ApiTypeHelper.unmodifiable(builder.sourceIncludes);
this.analyzeWildcard = builder.analyzeWildcard;
this.analyzer = builder.analyzer;
this.defaultOperator = builder.defaultOperator;
this.df = builder.df;
this.id = ApiTypeHelper.requireNonNull(builder.id, this, "id");
this.index = ApiTypeHelper.requireNonNull(builder.index, this, "index");
this.lenient = builder.lenient;
this.preference = builder.preference;
this.q = builder.q;
this.query = builder.query;
this.routing = builder.routing;
this.storedFields = ApiTypeHelper.unmodifiable(builder.storedFields);
}
public static ExplainRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* True or false to return the _source field or not, or a list of
* fields to return.
*
* API name: {@code _source}
*/
@Nullable
public final SourceConfigParam source() {
return this.source;
}
/**
* A comma-separated list of source fields to exclude from the response.
*
* API name: {@code _source_excludes}
*/
public final List sourceExcludes() {
return this.sourceExcludes;
}
/**
* A comma-separated list of source fields to include in the response.
*
* API name: {@code _source_includes}
*/
public final List sourceIncludes() {
return this.sourceIncludes;
}
/**
* If true, wildcard and prefix queries are analyzed.
*
* API name: {@code analyze_wildcard}
*/
@Nullable
public final Boolean analyzeWildcard() {
return this.analyzeWildcard;
}
/**
* Analyzer to use for the query string. This parameter can only be used when
* the q query string parameter is specified.
*
* API name: {@code analyzer}
*/
@Nullable
public final String analyzer() {
return this.analyzer;
}
/**
* The default operator for query string query: AND or
* OR.
*
* API name: {@code default_operator}
*/
@Nullable
public final Operator defaultOperator() {
return this.defaultOperator;
}
/**
* Field to use as default where no field prefix is given in the query string.
*
* API name: {@code df}
*/
@Nullable
public final String df() {
return this.df;
}
/**
* Required - Defines the document ID.
*
* API name: {@code id}
*/
public final String id() {
return this.id;
}
/**
* Required - Index names used to limit the request. Only a single index name
* can be provided to this parameter.
*
* API name: {@code index}
*/
public final String index() {
return this.index;
}
/**
* If true, format-based query failures (such as providing text to
* a numeric field) in the query string will be ignored.
*
* API name: {@code lenient}
*/
@Nullable
public final Boolean lenient() {
return this.lenient;
}
/**
* Specifies the node or shard the operation should be performed on. Random by
* default.
*
* API name: {@code preference}
*/
@Nullable
public final String preference() {
return this.preference;
}
/**
* Query in the Lucene query string syntax.
*
* API name: {@code q}
*/
@Nullable
public final String q() {
return this.q;
}
/**
* Defines the search definition using the Query DSL.
*
* API name: {@code query}
*/
@Nullable
public final Query query() {
return this.query;
}
/**
* Custom value used to route operations to a specific shard.
*
* API name: {@code routing}
*/
@Nullable
public final String routing() {
return this.routing;
}
/**
* A comma-separated list of stored fields to return in the 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.query != null) {
generator.writeKey("query");
this.query.serialize(generator, mapper);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link ExplainRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder implements ObjectBuilder {
@Nullable
private SourceConfigParam source;
@Nullable
private List sourceExcludes;
@Nullable
private List sourceIncludes;
@Nullable
private Boolean analyzeWildcard;
@Nullable
private String analyzer;
@Nullable
private Operator defaultOperator;
@Nullable
private String df;
private String id;
private String index;
@Nullable
private Boolean lenient;
@Nullable
private String preference;
@Nullable
private String q;
@Nullable
private Query query;
@Nullable
private String routing;
@Nullable
private List storedFields;
/**
* True or false to return the _source field or not, or a list of
* fields to return.
*
* API name: {@code _source}
*/
public final Builder source(@Nullable SourceConfigParam value) {
this.source = value;
return this;
}
/**
* True or false to return the _source field or not, or a list of
* fields to return.
*
* API name: {@code _source}
*/
public final Builder source(Function> fn) {
return this.source(fn.apply(new SourceConfigParam.Builder()).build());
}
/**
* A comma-separated list of source fields to exclude from the response.
*
* API name: {@code _source_excludes}
*
* Adds all elements of list to sourceExcludes.
*/
public final Builder sourceExcludes(List list) {
this.sourceExcludes = _listAddAll(this.sourceExcludes, list);
return this;
}
/**
* A comma-separated list of source fields to exclude from the response.
*
* API name: {@code _source_excludes}
*
* Adds one or more values to sourceExcludes.
*/
public final Builder sourceExcludes(String value, String... values) {
this.sourceExcludes = _listAdd(this.sourceExcludes, value, values);
return this;
}
/**
* A comma-separated list of source fields to include in the response.
*
* API name: {@code _source_includes}
*
* Adds all elements of list to sourceIncludes.
*/
public final Builder sourceIncludes(List list) {
this.sourceIncludes = _listAddAll(this.sourceIncludes, list);
return this;
}
/**
* A comma-separated list of source fields to include in the response.
*
* API name: {@code _source_includes}
*
* Adds one or more values to sourceIncludes.
*/
public final Builder sourceIncludes(String value, String... values) {
this.sourceIncludes = _listAdd(this.sourceIncludes, value, values);
return this;
}
/**
* If true, wildcard and prefix queries are analyzed.
*
* API name: {@code analyze_wildcard}
*/
public final Builder analyzeWildcard(@Nullable Boolean value) {
this.analyzeWildcard = value;
return this;
}
/**
* Analyzer to use for the query string. This parameter can only be used when
* the q query string parameter is specified.
*
* API name: {@code analyzer}
*/
public final Builder analyzer(@Nullable String value) {
this.analyzer = value;
return this;
}
/**
* The default operator for query string query: AND or
* OR.
*
* API name: {@code default_operator}
*/
public final Builder defaultOperator(@Nullable Operator value) {
this.defaultOperator = value;
return this;
}
/**
* Field to use as default where no field prefix is given in the query string.
*
* API name: {@code df}
*/
public final Builder df(@Nullable String value) {
this.df = value;
return this;
}
/**
* Required - Defines the document ID.
*
* API name: {@code id}
*/
public final Builder id(String value) {
this.id = value;
return this;
}
/**
* Required - Index names used to limit the request. Only a single index name
* can be provided to this parameter.
*
* API name: {@code index}
*/
public final Builder index(String value) {
this.index = value;
return this;
}
/**
* If true, format-based query failures (such as providing text to
* a numeric field) in the query string will be ignored.
*
* API name: {@code lenient}
*/
public final Builder lenient(@Nullable Boolean value) {
this.lenient = value;
return this;
}
/**
* Specifies the node or shard the operation should be performed on. Random by
* default.
*
* API name: {@code preference}
*/
public final Builder preference(@Nullable String value) {
this.preference = value;
return this;
}
/**
* Query in the Lucene query string syntax.
*
* API name: {@code q}
*/
public final Builder q(@Nullable String value) {
this.q = value;
return this;
}
/**
* Defines the search definition using the Query DSL.
*
* API name: {@code query}
*/
public final Builder query(@Nullable Query value) {
this.query = value;
return this;
}
/**
* Defines the search definition using the Query DSL.
*
* API name: {@code query}
*/
public final Builder query(Function> fn) {
return this.query(fn.apply(new Query.Builder()).build());
}
/**
* Custom value used to route operations to a specific shard.
*
* API name: {@code routing}
*/
public final Builder routing(@Nullable String value) {
this.routing = value;
return this;
}
/**
* A comma-separated list of stored fields to return in the 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;
}
/**
* A comma-separated list of stored fields to return in the 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 ExplainRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public ExplainRequest build() {
_checkSingleUse();
return new ExplainRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link ExplainRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
ExplainRequest::setupExplainRequestDeserializer);
protected static void setupExplainRequestDeserializer(ObjectDeserializer op) {
op.add(Builder::query, Query._DESERIALIZER, "query");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code explain}".
*/
public static final SimpleEndpoint _ENDPOINT = new SimpleEndpoint<>("es/explain",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
final int _index = 1 << 0;
final int _id = 1 << 1;
int propsSet = 0;
propsSet |= _index;
propsSet |= _id;
if (propsSet == (_index | _id)) {
StringBuilder buf = new StringBuilder();
buf.append("/");
SimpleEndpoint.pathEncode(request.index, buf);
buf.append("/_explain");
buf.append("/");
SimpleEndpoint.pathEncode(request.id, buf);
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Path parameters
request -> {
Map params = new HashMap<>();
final int _index = 1 << 0;
final int _id = 1 << 1;
int propsSet = 0;
propsSet |= _index;
propsSet |= _id;
if (propsSet == (_index | _id)) {
params.put("index", request.index);
params.put("id", request.id);
}
return params;
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.routing != null) {
params.put("routing", request.routing);
}
if (request.q != null) {
params.put("q", request.q);
}
if (request.df != null) {
params.put("df", request.df);
}
if (request.defaultOperator != null) {
params.put("default_operator", request.defaultOperator.jsonValue());
}
if (request.analyzer != null) {
params.put("analyzer", request.analyzer);
}
if (ApiTypeHelper.isDefined(request.storedFields)) {
params.put("stored_fields",
request.storedFields.stream().map(v -> v).collect(Collectors.joining(",")));
}
if (request.preference != null) {
params.put("preference", request.preference);
}
if (request.analyzeWildcard != null) {
params.put("analyze_wildcard", String.valueOf(request.analyzeWildcard));
}
if (request.source != null) {
params.put("_source", request.source._toJsonString());
}
if (ApiTypeHelper.isDefined(request.sourceExcludes)) {
params.put("_source_excludes",
request.sourceExcludes.stream().map(v -> v).collect(Collectors.joining(",")));
}
if (ApiTypeHelper.isDefined(request.sourceIncludes)) {
params.put("_source_includes",
request.sourceIncludes.stream().map(v -> v).collect(Collectors.joining(",")));
}
if (request.lenient != null) {
params.put("lenient", String.valueOf(request.lenient));
}
return params;
}, SimpleEndpoint.emptyMap(), true, ExplainResponse._DESERIALIZER);
/**
* Create an "{@code explain}" endpoint.
*/
public static Endpoint, ErrorResponse> createExplainEndpoint(
JsonpDeserializer tDocumentDeserializer) {
return _ENDPOINT
.withResponseDeserializer(ExplainResponse.createExplainResponseDeserializer(tDocumentDeserializer));
}
}