org.elasticsearch.client.ElasticsearchClient Maven / Gradle / Ivy
/*
* 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.client;
import org.elasticsearch.action.*;
import org.elasticsearch.threadpool.ThreadPool;
public interface ElasticsearchClient {
/**
* Executes a generic action, denoted by an {@link org.elasticsearch.action.Action}.
*
* @param action The action type to execute.
* @param request The action request.
* @param The request type.
* @param the response type.
* @param The request builder type.
* @return A future allowing to get back the response.
*/
> ActionFuture execute(final Action action, final Request request);
/**
* Executes a generic action, denoted by an {@link Action}.
*
* @param action The action type to execute.
* @param request The action request.
* @param listener The listener to receive the response back.
* @param The request type.
* @param The response type.
* @param The request builder type.
*/
> void execute(final Action action, final Request request, ActionListener listener);
/**
* Prepares a request builder to execute, specified by {@link Action}.
*
* @param action The action type to execute.
* @param The request type.
* @param The response type.
* @param The request builder.
* @return The request builder, that can, at a later stage, execute the request.
*/
> RequestBuilder prepareExecute(final Action action);
/**
* Returns the threadpool used to execute requests on this client
*/
ThreadPool threadPool();
}