org.hibernate.search.elasticsearch.indexes.ElasticsearchIndexFamily Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hibernate-search-elasticsearch Show documentation

Hibernate Search backend which has indexing operations forwarded to Elasticsearch

There is a newer version: 5.11.12.Final

Show newest version

/*
 * Hibernate Search, full-text search for your domain model
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later
 * See the lgpl.txt file in the root directory or .
 */
package org.hibernate.search.elasticsearch.indexes;

import org.hibernate.search.indexes.IndexFamily;

public interface ElasticsearchIndexFamily extends IndexFamily {

	/**
	 * Retrieve the underlying, low-level client used to communicate with the Elasticsearch cluster.
	 * 
	 * WARNING - Unsupported API: the underlying client class may change without notice.
	 *
	 * @param clientClass The {@link Class} representing the expected client type
	 * @return The client.
	 * @throws org.hibernate.search.exception.SearchException if the underlying client does not implement the given class.
	 */
	 T getClient(Class clientClass);

}