Class SearchResponse.Cluster

java.lang.Object
org.elasticsearch.action.search.SearchResponse.Cluster
All Implemented Interfaces:
Writeable, ToXContent, ToXContentFragment
Enclosing class:
SearchResponse

public static class SearchResponse.Cluster extends Object implements ToXContentFragment, Writeable
Represents the search metadata about a particular cluster involved in a cross-cluster search. The Cluster object can represent either the local cluster or a remote cluster. For the local cluster, clusterAlias should be specified as RemoteClusterAware.LOCAL_CLUSTER_GROUP_KEY. Its XContent is put into the "details" section the "_clusters" entry in the SearchResponse. This is an immutable class, so updates made during the search progress (especially important for async CCS searches) must be done by replacing the Cluster object with a new one. See the Clusters clusterInfo Map for details.