Package org.elasticsearch.common.unit

Enum Class MemorySizeValue

<MemorySizeValue>
org.elasticsearch.common.unit.MemorySizeValue
All Implemented Interfaces:
, <
public enum MemorySizeValue extends <MemorySizeValue>
Utility methods to get memory sizes.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.

    < extends <>>

  • Method Summary

    Modifier and Type
    Method
    Description
    static ByteSizeValue
     sValue,  settingName)
    Parse the provided string as a memory size.
    static MemorySizeValue
     name)
    Returns the enum constant of this class with the specified name.
    static MemorySizeValue[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.

    , , , , , , , , , ,

    Methods inherited from class java.lang.

    , , , , ,

  • Method Details

    • values

      public static MemorySizeValue[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static  name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      - if this enum class has no constant with the specified name
      - if the argument is null

    • parseBytesSizeValueOrHeapRatio

      public static  sValue,  settingName)
      Parse the provided string as a memory size. This method either accepts absolute values such as 42 (default assumed unit is byte) or 2mb, or percentages of the heap size: if the heap is 1G, 10% will be parsed as 100mb.