/* * Licensed to Elasticsearch under one or more contributor * license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright * ownership. Elasticsearch 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 org.elasticsearch.action.exists; import org.elasticsearch.ElasticsearchGenerationException; import org.elasticsearch.action.ActionRequestValidationException; import org.elasticsearch.action.support.QuerySourceBuilder; import org.elasticsearch.action.support.broadcast.BroadcastRequest; import org.elasticsearch.client.Requests; import org.elasticsearch.common.Nullable; import org.elasticsearch.common.Strings; import org.elasticsearch.common.bytes.BytesArray; import org.elasticsearch.common.bytes.BytesReference; import org.elasticsearch.common.io.stream.StreamInput; import org.elasticsearch.common.io.stream.StreamOutput; import org.elasticsearch.common.xcontent.XContentBuilder; import org.elasticsearch.common.xcontent.XContentFactory; import org.elasticsearch.common.xcontent.XContentHelper; import java.io.IOException; import java.util.Arrays; import java.util.Map; /** * @deprecated use {@link org.elasticsearch.action.search.SearchRequest} instead and set `size` to `0` and `terminate_after` to `1` */ @Deprecated public class ExistsRequest extends BroadcastRequest<ExistsRequest> { public static final float DEFAULT_MIN_SCORE = -1f; private float minScore = DEFAULT_MIN_SCORE; @Nullable protected String routing; @Nullable private String preference; private BytesReference source; private String[] types = Strings.EMPTY_ARRAY; long nowInMillis; public ExistsRequest() { } /** * Constructs a new exists request against the provided indices. No indices provided means it will * run against all indices. */ public ExistsRequest(String... indices) { super(indices); } @Override public ActionRequestValidationException validate() { ActionRequestValidationException validationException = super.validate(); return validationException; } /** * The minimum score of the documents to include in the count. */ public float minScore() { return minScore; } /** * The minimum score of the documents to include in the count. Defaults to <tt>-1</tt> which means all * documents will be considered. */ public ExistsRequest minScore(float minScore) { this.minScore = minScore; return this; } /** * A comma separated list of routing values to control the shards the search will be executed on. */ public String routing() { return this.routing; } /** * A comma separated list of routing values to control the shards the search will be executed on. */ public ExistsRequest routing(String routing) { this.routing = routing; return this; } /** * The routing values to control the shards that the search will be executed on. */ public ExistsRequest routing(String... routings) { this.routing = Strings.arrayToCommaDelimitedString(routings); return this; } /** * Routing preference for executing the search on shards */ public ExistsRequest preference(String preference) { this.preference = preference; return this; } public String preference() { return this.preference; } /** * The source to execute. */ public BytesReference source() { return source; } /** * The source to execute. */ public ExistsRequest source(QuerySourceBuilder sourceBuilder) { this.source = sourceBuilder.buildAsBytes(Requests.CONTENT_TYPE); return this; } /** * The source to execute in the form of a map. */ public ExistsRequest source(Map querySource) { try { XContentBuilder builder = XContentFactory.contentBuilder(Requests.CONTENT_TYPE); builder.map(querySource); return source(builder); } catch (IOException e) { throw new ElasticsearchGenerationException("Failed to generate [" + querySource + "]", e); } } public ExistsRequest source(XContentBuilder builder) { this.source = builder.bytes(); return this; } /** * The source to execute. It is preferable to use either {@link #source(byte[])} * or {@link #source(QuerySourceBuilder)}. */ public ExistsRequest source(String querySource) { this.source = new BytesArray(querySource); return this; } /** * The source to execute. */ public ExistsRequest source(byte[] querySource) { return source(querySource, 0, querySource.length); } /** * The source to execute. */ public ExistsRequest source(byte[] querySource, int offset, int length) { return source(new BytesArray(querySource, offset, length)); } public ExistsRequest source(BytesReference querySource) { this.source = querySource; return this; } /** * The types of documents the query will run against. Defaults to all types. */ public String[] types() { return this.types; } /** * The types of documents the query will run against. Defaults to all types. */ public ExistsRequest types(String... types) { this.types = types; return this; } @Override public void readFrom(StreamInput in) throws IOException { super.readFrom(in); minScore = in.readFloat(); routing = in.readOptionalString(); preference = in.readOptionalString(); source = in.readBytesReference(); types = in.readStringArray(); } @Override public void writeTo(StreamOutput out) throws IOException { super.writeTo(out); out.writeFloat(minScore); out.writeOptionalString(routing); out.writeOptionalString(preference); out.writeBytesReference(source); out.writeStringArray(types); } @Override public String toString() { String sSource = "_na_"; try { sSource = XContentHelper.convertToJson(source, false); } catch (Exception e) { // ignore } return "[" + Arrays.toString(indices) + "]" + Arrays.toString(types) + ", source[" + sSource + "]"; } }