Package org.opensearch.client.opensearch.nodes

Class InfoRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.nodes.InfoRequest
public final class InfoRequest
extends RequestBase

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  InfoRequest.Builder
    Builder for InfoRequest.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static Endpoint<InfoRequest,​InfoResponse,​OpenSearchError> ENDPOINT
    Endpoint "nodes.info".

  • Constructor Summary

    Constructors 
    Modifier Constructor Description
    protected InfoRequest​(InfoRequest.Builder builder)  

  • Method Summary

    Modifier and Type Method Description
    java.lang.Boolean flatSettings()
    If true, returns settings in flat format.
    jakarta.json.JsonValue masterTimeout()
    Period to wait for a connection to the master node.
    java.util.List<java.lang.String> metric()
    Limits the information returned to the specific metrics.
    java.lang.String nodeId()
    Comma-separated list of node IDs or names used to limit returned information.
    jakarta.json.JsonValue timeout()
    Period to wait for a response.

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

  • Method Details

    • nodeId

      @Nullable public java.lang.String nodeId()
      Comma-separated list of node IDs or names used to limit returned information. API name: node_id

    • metric

      @Nullable public java.util.List<java.lang.String> metric()
      Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest. API name: metric

    • flatSettings

      @Nullable public java.lang.Boolean flatSettings()
      If true, returns settings in flat format. API name: flat_settings

    • masterTimeout

      @Nullable public jakarta.json.JsonValue masterTimeout()
      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

    • timeout

      @Nullable public jakarta.json.JsonValue 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