Package org.opensearch.client.opensearch.nodes

Class HotThreadsRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.nodes.HotThreadsRequest
public class HotThreadsRequest extends RequestBase
Returns information about hot threads on each node in the cluster.

  • Field Details

  • Method Details

    • of

      public static HotThreadsRequest of(Function<HotThreadsRequest.Builder,ObjectBuilder<HotThreadsRequest>> fn)

    • ignoreIdleThreads

      @Nullable public final Boolean ignoreIdleThreads()
      If true, known idle threads (e.g. waiting in a socket select, or to get a task from an empty queue) are filtered out.

      API name: ignore_idle_threads

    • interval

      @Nullable public final Time interval()
      The interval to do the second sampling of threads.

      API name: interval

    • masterTimeout

      @Deprecated @Nullable public final Time masterTimeout()
      Deprecated.
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • clusterManagerTimeout

      @Nullable public final Time clusterManagerTimeout()
      Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: cluster_manager_timeout

    • nodeId

      public final List<String> nodeId()
      List of node IDs or names used to limit returned information.

      API name: node_id

    • snapshots

      @Nullable public final Long snapshots()
      Number of samples of thread stacktrace.

      API name: snapshots

    • threads

      @Nullable public final Long threads()
      Specifies the number of hot threads to provide information for.

      API name: threads

    • timeout

      @Nullable public final Time timeout()
      Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      API name: timeout

    • type

      @Nullable public final ThreadType type()
      The type to sample.

      API name: type