Class SettingsFilter
org.elasticsearch.common.settings.SettingsFilter
public final class SettingsFilter
extends
A class that allows to filter settings objects by simple regular expression patterns or full settings keys.
It's used for response filtering on the rest layer to for instance filter out sensitive information like access keys.
-
Field Summary
Modifier and TypeFieldDescriptionstatic
Can be used to specify settings filter that will be used to filter out matching settings in toXContent method -
Constructor Summary
ConstructorDescription<> patterns)
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addFilterSettingParams(RestRequest request)
static Settings
filterSettings(org.elasticsearch.common.xcontent.ToXContent.Params params, Settings settings)
<>
Returns a set of patternsstatic boolean
pattern)
Returnstrue
iff the given string is either a valid settings key pattern or a simple regular expressionMethods inherited from class java.lang.
, , , , , , , , , ,
-
Field Details
-
SETTINGS_FILTER_PARAM
public static SETTINGS_FILTER_PARAMCan be used to specify settings filter that will be used to filter out matching settings in toXContent method
-
-
Constructor Details
-
SettingsFilter
public SettingsFilter(<> patterns)
-
-
Method Details
-
getPatterns
public <> getPatterns()Returns a set of patterns -
isValidPattern
public static boolean isValidPattern( pattern)Returnstrue
iff the given string is either a valid settings key pattern or a simple regular expression- See Also:
Regex
,AbstractScopedSettings.isValidKey(String)
-
addFilterSettingParams
-
filterSettings
-
filter
-