Class DiskUsage

java.lang.Object
org.elasticsearch.cluster.DiskUsage
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment

public class DiskUsage
extends java.lang.Object
implements org.elasticsearch.common.xcontent.ToXContentFragment, Writeable
Encapsulation class used to represent the amount of disk used on a node.
  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    Writeable.Reader<V>, Writeable.Writer<V>
  • Field Summary

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS
  • Constructor Summary

    Constructors
    Constructor Description
    DiskUsage​(java.lang.String nodeId, java.lang.String nodeName, java.lang.String path, long totalBytes, long freeBytes)
    Create a new DiskUsage, if totalBytes is 0, getFreeDiskAsPercentage() will always return 100.0% free
    DiskUsage​(StreamInput in)  
  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object o)  
    long getFreeBytes()  
    double getFreeDiskAsPercentage()  
    java.lang.String getNodeId()  
    java.lang.String getNodeName()  
    java.lang.String getPath()  
    long getTotalBytes()  
    long getUsedBytes()  
    double getUsedDiskAsPercentage()  
    int hashCode()  
    java.lang.String toString()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    void writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

    isFragment
  • Constructor Details

    • DiskUsage

      public DiskUsage​(java.lang.String nodeId, java.lang.String nodeName, java.lang.String path, long totalBytes, long freeBytes)
      Create a new DiskUsage, if totalBytes is 0, getFreeDiskAsPercentage() will always return 100.0% free
    • DiskUsage

      public DiskUsage​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException
  • Method Details

    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException
    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException
    • getNodeId

      public java.lang.String getNodeId()
    • getNodeName

      public java.lang.String getNodeName()
    • getPath

      public java.lang.String getPath()
    • getFreeDiskAsPercentage

      public double getFreeDiskAsPercentage()
    • getUsedDiskAsPercentage

      public double getUsedDiskAsPercentage()
    • getFreeBytes

      public long getFreeBytes()
    • getTotalBytes

      public long getTotalBytes()
    • getUsedBytes

      public long getUsedBytes()
    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object
    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object