public static class Settings.Builder
extends java.lang.Object
build()
an immutable
settings implementation. Use Settings.builder()
in order to
construct it.Modifier and Type | Field | Description |
---|---|---|
static Settings |
EMPTY_SETTINGS |
Modifier and Type | Method | Description |
---|---|---|
Settings |
build() |
|
Settings.Builder |
copy(java.lang.String key,
java.lang.String sourceKey,
Settings source) |
|
Settings.Builder |
copy(java.lang.String key,
Settings source) |
|
java.lang.String |
get(java.lang.String key) |
Returns a setting value based on the setting key.
|
SecureSettings |
getSecureSettings() |
Return the current secure settings, or
null if none have been set. |
java.util.Set<java.lang.String> |
keys() |
|
Settings.Builder |
loadFromPath(java.nio.file.Path path) |
Loads settings from a url that represents them using
Settings.fromXContent(XContentParser)
Note: Loading from a path doesn't allow null values in the incoming xcontent |
Settings.Builder |
loadFromSource(java.lang.String source,
XContentType xContentType) |
Loads settings from the actual string content that represents them using
Settings.fromXContent(XContentParser) |
Settings.Builder |
loadFromStream(java.lang.String resourceName,
java.io.InputStream is,
boolean acceptNullValues) |
Loads settings from a stream that represents them using
Settings.fromXContent(XContentParser) |
Settings.Builder |
normalizePrefix(java.lang.String prefix) |
Checks that all settings in the builder start with the specified prefix.
|
Settings.Builder |
put(java.lang.String setting,
boolean value) |
Sets the setting with the provided setting key and the boolean value.
|
Settings.Builder |
put(java.lang.String setting,
double value) |
Sets the setting with the provided setting key and the double value.
|
Settings.Builder |
put(java.lang.String setting,
float value) |
Sets the setting with the provided setting key and the float value.
|
Settings.Builder |
put(java.lang.String setting,
int value) |
Sets the setting with the provided setting key and the int value.
|
Settings.Builder |
put(java.lang.String setting,
long value) |
Sets the setting with the provided setting key and the long value.
|
Settings.Builder |
put(java.lang.String setting,
long value,
java.util.concurrent.TimeUnit timeUnit) |
Sets the setting with the provided setting key and the time value.
|
Settings.Builder |
put(java.lang.String setting,
long value,
ByteSizeUnit sizeUnit) |
Sets the setting with the provided setting key and the size value.
|
Settings.Builder |
put(java.lang.String key,
java.lang.Class clazz) |
Sets a setting with the provided setting key and class as value.
|
Settings.Builder |
put(java.lang.String key,
java.lang.Enum<?> enumValue) |
Sets an enum setting with the provided setting key and enum instance.
|
Settings.Builder |
put(java.lang.String key,
java.lang.String value) |
Sets a setting with the provided setting key and value.
|
Settings.Builder |
put(java.lang.String settingPrefix,
java.lang.String groupName,
java.lang.String[] settings,
java.lang.String[] values) |
Sets the setting group.
|
Settings.Builder |
put(java.lang.String key,
java.nio.file.Path path) |
Sets a path setting with the provided setting key and path.
|
Settings.Builder |
put(java.lang.String key,
org.apache.logging.log4j.Level level) |
Sets an level setting with the provided setting key and level instance.
|
Settings.Builder |
put(java.lang.String key,
org.apache.lucene.util.Version luceneVersion) |
Sets an lucene version setting with the provided setting key and lucene version instance.
|
Settings.Builder |
put(java.lang.String key,
ByteSizeValue byteSizeValue) |
Sets a byteSizeValue setting with the provided setting key and byteSizeValue.
|
Settings.Builder |
put(java.lang.String key,
TimeValue timeValue) |
Sets a time value setting with the provided setting key and value.
|
Settings.Builder |
put(java.lang.String setting,
Version version) |
|
Settings.Builder |
put(Settings settings) |
Sets all the provided settings including secure settings
|
Settings.Builder |
put(Settings settings,
boolean copySecureSettings) |
Sets all the provided settings.
|
Settings.Builder |
putList(java.lang.String setting,
java.lang.String... values) |
Sets the setting with the provided setting key and an array of values.
|
Settings.Builder |
putList(java.lang.String setting,
java.util.List<java.lang.String> values) |
Sets the setting with the provided setting key and a list of values.
|
Settings.Builder |
putNull(java.lang.String key) |
Sets a null value for the given setting key
|
Settings.Builder |
putProperties(java.util.Map<java.lang.String,java.lang.String> esSettings,
java.util.function.Function<java.lang.String,java.lang.String> keyFunction) |
|
java.lang.String |
remove(java.lang.String key) |
Removes the provided setting from the internal map holding the current list of settings.
|
Settings.Builder |
replacePropertyPlaceholders() |
Runs across all the settings set on this builder and
replaces ${...} elements in each setting with
another setting already set on this builder.
|
Settings.Builder |
setSecureSettings(SecureSettings secureSettings) |
public static final Settings EMPTY_SETTINGS
public java.util.Set<java.lang.String> keys()
public java.lang.String remove(java.lang.String key)
public java.lang.String get(java.lang.String key)
public SecureSettings getSecureSettings()
null
if none have been set.public Settings.Builder setSecureSettings(SecureSettings secureSettings)
public Settings.Builder put(java.lang.String key, java.nio.file.Path path)
key
- The setting keypath
- The setting pathpublic Settings.Builder put(java.lang.String key, TimeValue timeValue)
key
- The setting keytimeValue
- The setting timeValuepublic Settings.Builder put(java.lang.String key, ByteSizeValue byteSizeValue)
key
- The setting keybyteSizeValue
- The setting valuepublic Settings.Builder put(java.lang.String key, java.lang.Enum<?> enumValue)
key
- The setting keyenumValue
- The setting valuepublic Settings.Builder put(java.lang.String key, org.apache.logging.log4j.Level level)
key
- The setting keylevel
- The setting valuepublic Settings.Builder put(java.lang.String key, org.apache.lucene.util.Version luceneVersion)
key
- The setting keyluceneVersion
- The setting valuepublic Settings.Builder put(java.lang.String key, java.lang.String value)
key
- The setting keyvalue
- The setting valuepublic Settings.Builder copy(java.lang.String key, Settings source)
public Settings.Builder copy(java.lang.String key, java.lang.String sourceKey, Settings source)
public Settings.Builder putNull(java.lang.String key)
public Settings.Builder put(java.lang.String key, java.lang.Class clazz)
key
- The setting keyclazz
- The setting class valuepublic Settings.Builder put(java.lang.String setting, boolean value)
setting
- The setting keyvalue
- The boolean valuepublic Settings.Builder put(java.lang.String setting, int value)
setting
- The setting keyvalue
- The int valuepublic Settings.Builder put(java.lang.String setting, Version version)
public Settings.Builder put(java.lang.String setting, long value)
setting
- The setting keyvalue
- The long valuepublic Settings.Builder put(java.lang.String setting, float value)
setting
- The setting keyvalue
- The float valuepublic Settings.Builder put(java.lang.String setting, double value)
setting
- The setting keyvalue
- The double valuepublic Settings.Builder put(java.lang.String setting, long value, java.util.concurrent.TimeUnit timeUnit)
setting
- The setting keyvalue
- The time valuepublic Settings.Builder put(java.lang.String setting, long value, ByteSizeUnit sizeUnit)
setting
- The setting keyvalue
- The size valuepublic Settings.Builder putList(java.lang.String setting, java.lang.String... values)
setting
- The setting keyvalues
- The valuespublic Settings.Builder putList(java.lang.String setting, java.util.List<java.lang.String> values)
setting
- The setting keyvalues
- The valuespublic Settings.Builder put(java.lang.String settingPrefix, java.lang.String groupName, java.lang.String[] settings, java.lang.String[] values) throws SettingsException
SettingsException
public Settings.Builder put(Settings settings)
public Settings.Builder put(Settings settings, boolean copySecureSettings)
settings
- the settings to setcopySecureSettings
- if true
all settings including secure settings are copied.public Settings.Builder loadFromSource(java.lang.String source, XContentType xContentType)
Settings.fromXContent(XContentParser)
public Settings.Builder loadFromPath(java.nio.file.Path path) throws java.io.IOException
Settings.fromXContent(XContentParser)
Note: Loading from a path doesn't allow null
values in the incoming xcontentjava.io.IOException
public Settings.Builder loadFromStream(java.lang.String resourceName, java.io.InputStream is, boolean acceptNullValues) throws java.io.IOException
Settings.fromXContent(XContentParser)
java.io.IOException
public Settings.Builder putProperties(java.util.Map<java.lang.String,java.lang.String> esSettings, java.util.function.Function<java.lang.String,java.lang.String> keyFunction)
public Settings.Builder replacePropertyPlaceholders()
public Settings.Builder normalizePrefix(java.lang.String prefix)
public Settings build()