Package org.opensearch.action.admin.cluster.node.info

Class NodeInfo

java.lang.Object
org.opensearch.core.transport.TransportMessage
org.opensearch.core.transport.TransportResponse
org.opensearch.action.support.nodes.BaseNodeResponse
org.opensearch.action.admin.cluster.node.info.NodeInfo
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable
public class NodeInfo extends BaseNodeResponse
Node information (static, does not change over time).
Opensearch.internal:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    NodeInfo.Builder
    Builder class to accommodate new Info types being added to NodeInfo.

    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.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
    NodeInfo(org.opensearch.core.common.io.stream.StreamInput in)
     
    NodeInfo(org.opensearch.Version version, org.opensearch.Build build, DiscoveryNode node, Settings settings, OsInfo os, ProcessInfo process, JvmInfo jvm, ThreadPoolInfo threadPool, TransportInfo transport, HttpInfo http, PluginsAndModules plugins, IngestInfo ingest, AggregationInfo aggsInfo, org.opensearch.core.common.unit.ByteSizeValue totalIndexingBuffer, SearchPipelineInfo searchPipelineInfo)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static NodeInfo.Builder
    builder(org.opensearch.Version version, org.opensearch.Build build, DiscoveryNode node)
     
    org.opensearch.Build
    getBuild()
    The build version of the node.
    String
    getHostname()
    System's hostname.
    <T extends org.opensearch.core.service.ReportingService.Info>
    T
    getInfo(Class<T> clazz)
    Get a particular info object, e.g.
    Settings
    getSettings()
    The settings of the node.
    org.opensearch.core.common.unit.ByteSizeValue
    getTotalIndexingBuffer()
     
    org.opensearch.Version
    getVersion()
    The current OpenSearch version
    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

  • Constructor Details

  • Method Details

    • getHostname

      @Nullable public String getHostname()
      System's hostname. null in case of UnknownHostException

    • getVersion

      public org.opensearch.Version getVersion()
      The current OpenSearch version

    • getBuild

      public org.opensearch.Build getBuild()
      The build version of the node.

    • getSettings

      @Nullable public Settings getSettings()
      The settings of the node.

    • getInfo

      public <T extends org.opensearch.core.service.ReportingService.Info> T getInfo(Class<T> clazz)
      Get a particular info object, e.g. JvmInfo or OsInfo. This generic method handles all casting in order to spare client classes the work of explicit casts. This NodeInfo class guarantees type safety for these stored info blocks.
      Type Parameters:
      T - Specific subtype of ReportingService.Info to retrieve.
      Parameters:
      clazz - Class for retrieval.
      Returns:
      An object of type T.

    • getTotalIndexingBuffer

      @Nullable public org.opensearch.core.common.unit.ByteSizeValue getTotalIndexingBuffer()

    • 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

    • builder

      public static NodeInfo.Builder builder(org.opensearch.Version version, org.opensearch.Build build, DiscoveryNode node)