Class EsqlExecutionInfo.Cluster

java.lang.Object
org.elasticsearch.xpack.esql.action.EsqlExecutionInfo.Cluster
All Implemented Interfaces:
Writeable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment
Enclosing class:
EsqlExecutionInfo

public static class EsqlExecutionInfo.Cluster extends Object implements org.elasticsearch.xcontent.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.
  • Field Details

    • INDICES_FIELD

      public static final org.elasticsearch.xcontent.ParseField INDICES_FIELD
    • STATUS_FIELD

      public static final org.elasticsearch.xcontent.ParseField STATUS_FIELD
    • TOOK

      public static final org.elasticsearch.xcontent.ParseField TOOK
  • Constructor Details

    • Cluster

      public Cluster(String clusterAlias, String indexExpression)
    • Cluster

      public Cluster(String clusterAlias, 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 indexExpression, boolean skipUnavailable, EsqlExecutionInfo.Cluster.Status status)
      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(String clusterAlias, String indexExpression, boolean skipUnavailable, EsqlExecutionInfo.Cluster.Status status, Integer totalShards, Integer successfulShards, Integer skippedShards, Integer failedShards, List<ShardSearchFailure> failures, org.elasticsearch.core.TimeValue took)
    • 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 org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException
    • isFragment

      public boolean isFragment()
      Specified by:
      isFragment in interface org.elasticsearch.xcontent.ToXContent
      Specified by:
      isFragment in interface org.elasticsearch.xcontent.ToXContentFragment
    • getClusterAlias

      public String getClusterAlias()
    • getIndexExpression

      public String getIndexExpression()
    • isSkipUnavailable

      public boolean isSkipUnavailable()
    • getStatus

    • getTook

      public org.elasticsearch.core.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