Package org.opensearch.plugin.insights.rules.action.top_queries

Class TopQueriesResponse

java.lang.Object
org.opensearch.core.transport.TransportMessage
org.opensearch.core.transport.TransportResponse
org.opensearch.core.action.ActionResponse
org.opensearch.action.support.nodes.BaseNodesResponse<TopQueries>
org.opensearch.plugin.insights.rules.action.top_queries.TopQueriesResponse
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment
public class TopQueriesResponse extends BaseNodesResponse<TopQueries> implements org.opensearch.core.xcontent.ToXContentFragment
Transport response for cluster/node level top queries information.
Opensearch.internal:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.opensearch.core.transport.TransportResponse

    org.opensearch.core.transport.TransportResponse.Empty

    Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

    org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

    org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

  • Field Summary

    Fields inherited from interface org.opensearch.core.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    TopQueriesResponse(ClusterName clusterName, List<TopQueries> nodes, List<FailedNodeException> failures, int top_n_size, MetricType metricType)
    Constructor for TopQueriesResponse
    TopQueriesResponse(org.opensearch.core.common.io.stream.StreamInput in)
    Constructor for TopQueriesResponse.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected List<TopQueries>
    readNodesFrom(org.opensearch.core.common.io.stream.StreamInput in)
     
    String
    toString()
     
    org.opensearch.core.xcontent.XContentBuilder
    toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
     
    protected void
    writeNodesTo(org.opensearch.core.common.io.stream.StreamOutput out, List<TopQueries> nodes)
     

    Methods inherited from class org.opensearch.action.support.nodes.BaseNodesResponse

    failures, getClusterName, getNodes, getNodesMap, hasFailures, writeTo

    Methods inherited from class org.opensearch.core.transport.TransportMessage

    remoteAddress, remoteAddress

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

    isFragment

  • Constructor Details

    • TopQueriesResponse

      public TopQueriesResponse(org.opensearch.core.common.io.stream.StreamInput in) throws IOException
      Constructor for TopQueriesResponse.
      Parameters:
      in - A StreamInput object.
      Throws:
      IOException - if the stream cannot be deserialized.

    • TopQueriesResponse

      public TopQueriesResponse(ClusterName clusterName, List<TopQueries> nodes, List<FailedNodeException> failures, int top_n_size, MetricType metricType)
      Constructor for TopQueriesResponse
      Parameters:
      clusterName - The current cluster name
      nodes - A list that contains top queries results from all nodes
      failures - A list that contains FailedNodeException
      top_n_size - The top N size to return to the user
      metricType - the MetricType to be returned in this response

  • Method Details