ConfigEntry (clients 7.9.5-ce API)

java.lang.Object
- org.apache.kafka.clients.admin.ConfigEntry

```
@InterfaceStability.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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConfigEntry.ConfigSource` Source of configuration entries.
`static class`	`ConfigEntry.ConfigSynonym` Class representing a configuration synonym of a `ConfigEntry`.
`static class`	`ConfigEntry.ConfigType` Data type of configuration entry.

Constructor Summary

Constructors
Constructor and Description
`ConfigEntry(String name, String value)` Create a configuration entry with the provided values.
`ConfigEntry(String name, String value, ConfigEntry.ConfigSource source, boolean isSensitive, boolean isReadOnly, List<ConfigEntry.ConfigSynonym> synonyms, ConfigEntry.ConfigType type, String documentation)` Create a configuration with the provided values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`documentation()` Return the config documentation.
`boolean`	`equals(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.
`String`	`name()` Return the config name.
`ConfigEntry.ConfigSource`	`source()` Return the source of this configuration entry.
`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.
`String`	`toString()` Override toString to redact sensitive value.
`ConfigEntry.ConfigType`	`type()` Return the config data type.
`String`	`value()` Return the value or null.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ConfigEntry
```
public ConfigEntry(String name,
                   String value)
```
    Create a configuration entry with the provided values.
    Parameters:
    name - the non-null config name
    value - the config value or null
  - ConfigEntry
```
public ConfigEntry(String name,
                   String value,
                   ConfigEntry.ConfigSource source,
                   boolean isSensitive,
                   boolean isReadOnly,
                   List<ConfigEntry.ConfigSynonym> synonyms,
                   ConfigEntry.ConfigType type,
                   String documentation)
```
    Create a configuration with the provided values.
    Parameters:
    name - the non-null config name
    value - the config value or null
    source - the source of this config entry
    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
    synonyms - Synonym configs in order of precedence
- Method Detail
  - 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)
```
    Overrides:
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    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.
    Overrides:
    toString in class Object

Class ConfigEntry

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConfigEntry

ConfigEntry

Method Detail

name

value

source

isDefault

isSensitive

isReadOnly

synonyms

type

documentation

equals

hashCode

toString