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

Class TopQueries

java.lang.Object
org.opensearch.core.transport.TransportMessage
org.opensearch.core.transport.TransportResponse
org.opensearch.action.support.nodes.BaseNodeResponse
org.opensearch.plugin.insights.rules.action.top_queries.TopQueries
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject
public class TopQueries extends BaseNodeResponse implements org.opensearch.core.xcontent.ToXContentObject
Holds all top queries records by resource usage or latency on a node Mainly used in the top N queries node response workflow.
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
    TopQueries(DiscoveryNode node, List<SearchQueryRecord> searchQueryRecords)
    Create the TopQueries Object
    TopQueries(org.opensearch.core.common.io.stream.StreamInput in)
    Create the TopQueries Object from StreamInput

  • Method Summary

    Modifier and Type
    Method
    Description
    List<SearchQueryRecord>
    getTopQueriesRecord()
    Get all top queries records
    org.opensearch.core.xcontent.XContentBuilder
    toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
     
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
     

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

    getNode

    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, toString, wait, wait, wait

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

    isFragment

  • Constructor Details

    • TopQueries

      public TopQueries(org.opensearch.core.common.io.stream.StreamInput in) throws IOException
      Create the TopQueries Object from StreamInput
      Parameters:
      in - A StreamInput object.
      Throws:
      IOException - IOException

    • TopQueries

      public TopQueries(DiscoveryNode node, List<SearchQueryRecord> searchQueryRecords)
      Create the TopQueries Object
      Parameters:
      node - A node that is part of the cluster.
      searchQueryRecords - A list of SearchQueryRecord associated in this TopQueries.

  • Method Details

    • toXContent

      public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.opensearch.core.xcontent.ToXContent
      Throws:
      IOException

    • writeTo

      public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      writeTo in interface org.opensearch.core.common.io.stream.Writeable
      Overrides:
      writeTo in class BaseNodeResponse
      Throws:
      IOException

    • getTopQueriesRecord

      public List<SearchQueryRecord> getTopQueriesRecord()
      Get all top queries records
      Returns:
      the top queries records in this node response