Class ConfigEntry


  • @Evolving
    public class ConfigEntry
    extends java.lang.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 Summary

      Constructors 
      Constructor Description
      ConfigEntry​(java.lang.String name, java.lang.String value)
      Create a configuration entry with the provided values.
      ConfigEntry​(java.lang.String name, java.lang.String value, boolean isDefault, boolean isSensitive, boolean isReadOnly)
      Deprecated.
      since 1.1.0.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String documentation()
      Return the config documentation.
      boolean equals​(java.lang.Object o)  
      int hashCode()  
      boolean isDefault()
      Return whether the config value is the default or if it's been explicitly set.
      boolean isReadOnly()
      Return whether the config is read-only and cannot be updated.
      boolean isSensitive()
      Return whether the config value is sensitive.
      java.lang.String name()
      Return the config name.
      ConfigEntry.ConfigSource source()
      Return the source of this configuration entry.
      java.util.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.
      java.lang.String toString()  
      ConfigEntry.ConfigType type()
      Return the config data type.
      java.lang.String value()
      Return the value or null.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ConfigEntry

        public ConfigEntry​(java.lang.String name,
                           java.lang.String value)
        Create a configuration entry with the provided values.
        Parameters:
        name - the non-null config name
        value - the config value or null
      • ConfigEntry

        @Deprecated
        public ConfigEntry​(java.lang.String name,
                           java.lang.String value,
                           boolean isDefault,
                           boolean isSensitive,
                           boolean isReadOnly)
        Deprecated.
        since 1.1.0. This constructor will be removed in a future release.
        Create a configuration with the provided values.
        Parameters:
        name - the non-null config name
        value - the config value or null
        isDefault - whether the config value is the default or if it's been explicitly set
        isSensitive - whether the config value is sensitive, the broker never returns the value if it is sensitive
        isReadOnly - whether the config is read-only and cannot be updated
    • Method Detail

      • name

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

        public java.lang.String value()
        Return the value or null. Null is returned if the config is unset or if isSensitive is true.
      • 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 java.util.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)
      • documentation

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

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object