Class ConfigEntry


@Evolving public class ConfigEntry extends Object
A class representing a configuration entry containing name, value and additional metadata. The API of this class is evolving, see Admin for details.
  • Constructor Details

    • ConfigEntry

      public ConfigEntry(String name, String value)
      Create a configuration entry with the provided values.
      name - the non-null config name
      value - the config value or null
  • Method Details

    • name

      public String name()
      Return the config name.
    • value

      public String value()
      Return the value or null. Null is returned if the config is unset or if isSensitive is true.
    • source

      public ConfigEntry.ConfigSource source()
      Return the source of this configuration entry.
    • isDefault

      public boolean isDefault()
      Return whether the config value is the default or if it's been explicitly set.
    • isSensitive

      public boolean isSensitive()
      Return whether the config value is sensitive. The value is always set to null by the broker if the config value is sensitive.
    • isReadOnly

      public boolean isReadOnly()
      Return whether the config is read-only and cannot be updated.
    • synonyms

      public List<ConfigEntry.ConfigSynonym> synonyms()
      Returns all config values that may be used as the value of this config along with their source, in the order of precedence. The list starts with the value returned in this ConfigEntry. The list is empty if synonyms were not requested using DescribeConfigsOptions.includeSynonyms(boolean)
    • type

      public ConfigEntry.ConfigType type()
      Return the config data type.
    • documentation

      public String documentation()
      Return the config documentation.
    • equals

      public boolean equals(Object o)
      equals in class Object
    • hashCode

      public int hashCode()
      hashCode in class Object
    • toString

      public String toString()
      Override toString to redact sensitive value. WARNING, user should be responsible to set the correct "isSensitive" field for each config entry.
      toString in class Object