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

Class TopQueriesRequest

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

org.opensearch.action.support.nodes.BaseNodesRequest<TopQueriesRequest>

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

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable, TaskAwareRequest

public class TopQueriesRequest
extends BaseNodesRequest<TopQueriesRequest>

A request to get cluster/node level top queries information.

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.transport.TransportRequest

TransportRequest.Empty

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>

Constructor Summary

Constructors

Constructor	Description
TopQueriesRequest(org.opensearch.core.common.io.stream.StreamInput in)	Constructor for TopQueriesRequest
TopQueriesRequest(MetricType metricType, String... nodesIds)	Get top queries from nodes based on the nodes ids specified.

Method Summary

Modifier and Type	Method	Description
MetricType	getMetricType()	Get the type of requested metrics
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

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

concreteNodes, nodesIds, nodesIds, setConcreteNodes, timeout, timeout, timeout, validate

Methods inherited from class org.opensearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

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.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

TopQueriesRequest

public TopQueriesRequest(org.opensearch.core.common.io.stream.StreamInput in)
                  throws IOException

Constructor for TopQueriesRequest

Parameters:

in - A StreamInput object.

Throws:

IOException - if the stream cannot be deserialized.

TopQueriesRequest

public TopQueriesRequest(MetricType metricType,
 String... nodesIds)

Get top queries from nodes based on the nodes ids specified. If none are passed, cluster level top queries will be returned.

Parameters:

metricType - MetricType

nodesIds - the nodeIds specified in the request

Method Details

getMetricType

public MetricType getMetricType()

Get the type of requested metrics

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 BaseNodesRequest<TopQueriesRequest>

Throws:

IOException