org.elasticsearch.action.search.SearchScrollRequestBuilder Maven / Gradle / Ivy
/*
* Licensed to ElasticSearch and Shay Banon 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.search;
import org.elasticsearch.action.ActionListener;
import org.elasticsearch.action.ActionRequestBuilder;
import org.elasticsearch.client.Client;
import org.elasticsearch.client.internal.InternalClient;
import org.elasticsearch.common.unit.TimeValue;
import org.elasticsearch.search.Scroll;
/**
* A search scroll action request builder.
*/
public class SearchScrollRequestBuilder extends ActionRequestBuilder {
public SearchScrollRequestBuilder(Client client) {
super((InternalClient) client, new SearchScrollRequest());
}
public SearchScrollRequestBuilder(Client client, String scrollId) {
super((InternalClient) client, new SearchScrollRequest(scrollId));
}
/**
* Controls the the search operation threading model.
*/
public SearchScrollRequestBuilder setOperationThreading(SearchOperationThreading operationThreading) {
request.operationThreading(operationThreading);
return this;
}
/**
* Should the listener be called on a separate thread if needed.
*/
public SearchScrollRequestBuilder listenerThreaded(boolean threadedListener) {
request.listenerThreaded(threadedListener);
return this;
}
/**
* The scroll id to use to continue scrolling.
*/
public SearchScrollRequestBuilder setScrollId(String scrollId) {
request.scrollId(scrollId);
return this;
}
/**
* If set, will enable scrolling of the search request.
*/
public SearchScrollRequestBuilder setScroll(Scroll scroll) {
request.scroll(scroll);
return this;
}
/**
* If set, will enable scrolling of the search request for the specified timeout.
*/
public SearchScrollRequestBuilder setScroll(TimeValue keepAlive) {
request.scroll(keepAlive);
return this;
}
/**
* If set, will enable scrolling of the search request for the specified timeout.
*/
public SearchScrollRequestBuilder setScroll(String keepAlive) {
request.scroll(keepAlive);
return this;
}
@Override
protected void doExecute(ActionListener listener) {
((Client) client).searchScroll(request, listener);
}
}