/*
* 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.search.internal;
import java.io.IOException;
import java.util.Collection;
import org.apache.cassandra.dht.Range;
import org.apache.cassandra.dht.Token;
import org.elasticsearch.action.search.SearchType;
import org.elasticsearch.common.HasContextAndHeaders;
import org.elasticsearch.common.bytes.BytesReference;
import org.elasticsearch.script.Template;
import org.elasticsearch.search.Scroll;
/**
* Shard level request that represents a search.
* It provides all the methods that the {@link org.elasticsearch.search.internal.SearchContext} needs.
* Provides a cache key based on its content that can be used to cache shard level response.
*/
public interface ShardSearchRequest extends HasContextAndHeaders {
String index();
int shardId();
String[] types();
BytesReference source();
void source(BytesReference source);
BytesReference extraSource();
int numberOfShards();
SearchType searchType();
String[] filteringAliases();
long nowInMillis();
Template template();
BytesReference templateSource();
Boolean requestCache();
Scroll scroll();
/**
* Sets if this shard search needs to be profiled or not
* @param profile True if the shard should be profiled
*/
void setProfile(boolean profile);
/**
* Returns true if this shard search is being profiled or not
*/
boolean isProfile();
/**
* Returns the cache key for this shard search request, based on its content
*/
BytesReference cacheKey() throws IOException;
Boolean tokenRangesBitsetCache();
/**
* Returns the token range for this request
*/
Collection<Range<Token>> tokenRanges();
}