Package org.elasticsearch.xpack.esql.action

Class EsqlExecutionInfo.Cluster

java.lang.Object

org.elasticsearch.xpack.esql.action.EsqlExecutionInfo.Cluster

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

Enclosing class:

EsqlExecutionInfo

public static class EsqlExecutionInfo.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 REST query response. 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EsqlExecutionInfo.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	EsqlExecutionInfo.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 ParseField	STATUS_FIELD
static final ParseField	TOOK

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Cluster(String clusterAlias, String displayClusterAlias, String indexExpression, boolean skipUnavailable)	Create a Cluster object representing the initial RUNNING state of a Cluster.
Cluster(String clusterAlias, String displayClusterAlias, String indexExpression, boolean skipUnavailable, EsqlExecutionInfo.Cluster.Status status, Integer totalShards, Integer successfulShards, Integer skippedShards, Integer failedShards, List<ShardSearchFailure> failures, TimeValue took)	Create a Cluster with a new Status other than the default of RUNNING.
Cluster(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getClusterAlias()
String	getDisplayClusterAlias()
Integer	getFailedShards()
List<ShardSearchFailure>	getFailures()
String	getIndexExpression()
String	getQualifiedIndexExpression()
Integer	getSkippedShards()
EsqlExecutionInfo.Cluster.Status	getStatus()
Integer	getSuccessfulShards()
TimeValue	getTook()
Integer	getTotalShards()
int	hashCode()
boolean	isFragment()
boolean	isSkipUnavailable()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

INDICES_FIELD

public static final ParseField INDICES_FIELD

STATUS_FIELD

public static final ParseField STATUS_FIELD

TOOK

public static final ParseField TOOK

Constructor Details

Cluster

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

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

Cluster

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

Create a Cluster with a new Status other than the default of RUNNING.

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 cluster is marked as skip_unavailable in remote cluster settings

status - current status of the search on this Cluster

Cluster

public Cluster(StreamInput in)
        throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

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

isFragment

public boolean isFragment()

Specified by:

isFragment in interface ToXContent

Specified by:

isFragment in interface ToXContentFragment

getClusterAlias

public String getClusterAlias()

getDisplayClusterAlias

public String getDisplayClusterAlias()

getIndexExpression

public String getIndexExpression()

getQualifiedIndexExpression

public String getQualifiedIndexExpression()

isSkipUnavailable

public boolean isSkipUnavailable()

getStatus

public EsqlExecutionInfo.Cluster.Status getStatus()

getTook

public TimeValue getTook()

getTotalShards

public Integer getTotalShards()

getSuccessfulShards

public Integer getSuccessfulShards()

getSkippedShards

public Integer getSkippedShards()

getFailedShards

public Integer getFailedShards()

getFailures

public List<ShardSearchFailure> getFailures()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object