Package org.opensearch.cluster

Class DiskUsage

java.lang.Object
org.opensearch.cluster.DiskUsage
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment
@PublicApi(since="1.0.0") public class DiskUsage extends Object implements org.opensearch.core.xcontent.ToXContentFragment, org.opensearch.core.common.io.stream.Writeable
Encapsulation class used to represent the amount of disk used on a node.
Opensearch.api:

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

    org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

    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>

  • Field Summary

    Fields inherited from interface org.opensearch.core.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    DiskUsage(String nodeId, String nodeName, String path, long totalBytes, long freeBytes)
    Create a new DiskUsage, if totalBytes is 0, getFreeDiskAsPercentage() will always return 100.0% free
    DiskUsage(org.opensearch.core.common.io.stream.StreamInput in)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    long
    getFreeBytes()
     
    double
    getFreeDiskAsPercentage()
     
    String
    getNodeId()
     
    String
    getNodeName()
     
    String
    getPath()
     
    long
    getTotalBytes()
     
    long
    getUsedBytes()
     
    double
    getUsedDiskAsPercentage()
     
    int
    hashCode()
     
    String
    toString()
     
    org.opensearch.core.xcontent.XContentBuilder
    toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
     
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

    isFragment

  • Constructor Details

    • DiskUsage

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

    • DiskUsage

      public DiskUsage(org.opensearch.core.common.io.stream.StreamInput in) throws IOException
      Throws:
      IOException

  • Method Details

    • 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
      Throws:
      IOException

    • toXContent

      public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.opensearch.core.xcontent.ToXContent
      Throws:
      IOException

    • getNodeId

      public String getNodeId()

    • getNodeName

      public String getNodeName()

    • getPath

      public 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(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object