Module org.elasticsearch.server

Package org.elasticsearch.action.search

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchResponse.Cluster.Builder	Since the Cluster object is immutable, use this Builder class to create a new Cluster object using the "copyFrom" Cluster passed in and set only changed values.
static enum	SearchResponse.Cluster.Status	Marks the status of a Cluster search involved in a Cross-Cluster search.

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	INDICES_FIELD
static final TransportVersion	SEARCH_RESPONSE_ORIGIN_CLUSTER_LABEL_TV
static final boolean	SKIP_UNAVAILABLE_DEFAULT
static final ParseField	STATUS_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Cluster(String clusterAlias, String indexExpression, boolean skipUnavailable, String originClusterLabel)	Create a Cluster object representing the initial RUNNING state of a Cluster.
Cluster(String clusterAlias, String indexExpression, boolean skipUnavailable, SearchResponse.Cluster.Status status, Integer totalShards, Integer successfulShards, Integer skippedShards, Integer failedShards, List<ShardSearchFailure> failures, TimeValue took, boolean timedOut, String originClusterLabel)
Cluster(StreamInput in)

Method Summary

Modifier and Type	Method	Description
String	getClusterAlias()
Integer	getFailedShards()
List<ShardSearchFailure>	getFailures()
String	getIndexExpression()
String	getOriginClusterLabel()
Integer	getSkippedShards()
SearchResponse.Cluster.Status	getStatus()
Integer	getSuccessfulShards()
TimeValue	getTook()
Integer	getTotalShards()
boolean	isSkipUnavailable()
boolean	isTimedOut()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

SEARCH_RESPONSE_ORIGIN_CLUSTER_LABEL_TV

public static final TransportVersion SEARCH_RESPONSE_ORIGIN_CLUSTER_LABEL_TV

INDICES_FIELD

public static final ParseField INDICES_FIELD

STATUS_FIELD

public static final ParseField STATUS_FIELD

SKIP_UNAVAILABLE_DEFAULT

public static final boolean SKIP_UNAVAILABLE_DEFAULT

See Also:

• Constant Field Values

Constructor Details

Cluster

public Cluster(String clusterAlias,
 String indexExpression,
 boolean skipUnavailable,
 String originClusterLabel)

Create a Cluster object representing the initial RUNNING state of a Cluster.

Parameters:

clusterAlias - clusterAlias as defined in the remote cluster settings or RemoteClusterAware.LOCAL_CLUSTER_GROUP_KEY for the local cluster

indexExpression - the original (not resolved/concrete) indices expression provided for this cluster.

skipUnavailable - whether this Cluster is marked as skip_unavailable in remote cluster settings

originClusterLabel - if clusterAlias is "" (representing the local/origin cluster), the originClusterLabel must be specified in order to know how to represent this cluster in XContent rendering. Should be "(local)" for stateful and "_origin" for serverless.

Cluster

public Cluster(String clusterAlias,
 String indexExpression,
 boolean skipUnavailable,
 SearchResponse.Cluster.Status status,
 Integer totalShards,
 Integer successfulShards,
 Integer skippedShards,
 Integer failedShards,
 List<ShardSearchFailure> failures,
 TimeValue took,
 boolean timedOut,
 String originClusterLabel)

Cluster

public Cluster(StreamInput in)
        throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getClusterAlias

public String getClusterAlias()

getIndexExpression

public String getIndexExpression()

isSkipUnavailable

public boolean isSkipUnavailable()

getStatus

public SearchResponse.Cluster.Status getStatus()

isTimedOut

public boolean isTimedOut()

getFailures

public List<ShardSearchFailure> getFailures()

getTook

public TimeValue getTook()

getTotalShards

public Integer getTotalShards()

getSuccessfulShards

public Integer getSuccessfulShards()

getSkippedShards

public Integer getSkippedShards()

getFailedShards

public Integer getFailedShards()

getOriginClusterLabel

@Nullable
public String getOriginClusterLabel()

toString

public String toString()

Overrides:

toString in class Object