Package org.elasticsearch.client

Class NodesResponse

  • Direct Known Subclasses:
    SecurityNodesResponse
    public abstract class NodesResponse
extends java.lang.Object
    Base class for responses that are node responses. These responses always contain the cluster name and the NodesResponseHeader.

    • Method Summary

      Modifier and Type Method Description
      static <T extends NodesResponse>
      void      		 declareCommonNodesResponseParsing​(ConstructingObjectParser<T,​java.lang.Void> parser)  
      java.lang.String getClusterName()
      Get the cluster name associated with all of the nodes.
      NodesResponseHeader getHeader()
      Gets information about the number of total, successful and failed nodes the request was run on.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • NodesResponse

        protected NodesResponse​(NodesResponseHeader header,
                        java.lang.String clusterName)

    • Method Detail

      • getClusterName

        public java.lang.String getClusterName()
        Get the cluster name associated with all of the nodes.
        Returns:
        Never null.

      • getHeader

        public NodesResponseHeader getHeader()
        Gets information about the number of total, successful and failed nodes the request was run on. Also includes exceptions if relevant.