java.lang.Object
org.elasticsearch.common.unit.RelativeByteSizeValue
A byte size value that allows specification using either of:
1. Absolute value (200GB for instance)
2. Relative percentage value (95%)
3. Relative ratio value (0.95)
-
Constructor Summary
ConstructorDescriptionRelativeByteSizeValue
(ByteSizeValue absolute) RelativeByteSizeValue
(RatioValue ratio) -
Method Summary
Modifier and TypeMethodDescriptioncalculateValue
(ByteSizeValue total, ByteSizeValue maxHeadroom) Calculate the size to use, optionally catering for a max headroom.getRatio()
boolean
boolean
static RelativeByteSizeValue
parseRelativeByteSizeValue
(String value, String settingName)
-
Constructor Details
-
RelativeByteSizeValue
-
RelativeByteSizeValue
-
-
Method Details
-
isAbsolute
public boolean isAbsolute() -
getAbsolute
-
getRatio
-
calculateValue
Calculate the size to use, optionally catering for a max headroom.- Parameters:
total
- the total size to usemaxHeadroom
- the max headroom to cater for or null (or -1) to ignore.- Returns:
- the size to use
-
isNonZeroSize
public boolean isNonZeroSize() -
parseRelativeByteSizeValue
-
getStringRep
-