Package org.opensearch.monitor.fs

Class FsInfo.Path

java.lang.Object
org.opensearch.monitor.fs.FsInfo.Path
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject
Enclosing class:
FsInfo
@PublicApi(since="1.0.0") public static class FsInfo.Path extends Object implements org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContentObject
Path for the file system
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
    Path()
     
    Path(String path, String mount, long total, long free, long available)
     
    Path(org.opensearch.core.common.io.stream.StreamInput in)
    Read from a stream.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(FsInfo.Path path)
     
    org.opensearch.core.common.unit.ByteSizeValue
    getAvailable()
     
    org.opensearch.core.common.unit.ByteSizeValue
    getFileCacheReserved()
     
    org.opensearch.core.common.unit.ByteSizeValue
    getFileCacheUtilized()
     
    org.opensearch.core.common.unit.ByteSizeValue
    getFree()
     
    String
    getMount()
     
    String
    getPath()
     
    org.opensearch.core.common.unit.ByteSizeValue
    getTotal()
     
    String
    getType()
     
    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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

    isFragment

  • Constructor Details

    • Path

      public Path()

    • Path

      public Path(String path, @Nullable String mount, long total, long free, long available)

    • Path

      public Path(org.opensearch.core.common.io.stream.StreamInput in) throws IOException
      Read from a stream.
      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

    • getPath

      public String getPath()

    • getMount

      public String getMount()

    • getType

      public String getType()

    • getTotal

      public org.opensearch.core.common.unit.ByteSizeValue getTotal()

    • getFree

      public org.opensearch.core.common.unit.ByteSizeValue getFree()

    • getAvailable

      public org.opensearch.core.common.unit.ByteSizeValue getAvailable()

    • getFileCacheReserved

      public org.opensearch.core.common.unit.ByteSizeValue getFileCacheReserved()

    • getFileCacheUtilized

      public org.opensearch.core.common.unit.ByteSizeValue getFileCacheUtilized()

    • add

      public void add(FsInfo.Path path)

    • 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