Struct AdminClientConfig 

pub struct AdminClientConfig { /* private fields */ }

The AdminClient configuration class, which also contains constants for configuration entry names.

Implementations

impl AdminClientConfig

pub const BOOTSTRAP_SERVERS_CONFIG: &'static str = "bootstrap.servers"

bootstrap.servers

pub const BOOTSTRAP_CONTROLLERS_CONFIG: &'static str = "bootstrap.controllers"

bootstrap.controllers (KIP-919): a list of host/port pairs to use for establishing the initial connection to the KRaft controller quorum. This list should be in the form host1:port1,host2:port2,....

Set it in place of bootstrap.servers: the client then talks to the controllers directly, and fails at once every call the controllers cannot serve. Setting both, or neither, fails client creation, as Java’s KafkaAdminClient.determineBootstrapType does.

pub const CLIENT_DNS_LOOKUP_CONFIG: &'static str = CommonClientConfigs::CLIENT_DNS_LOOKUP_CONFIG

client.dns.lookup

pub const CLIENT_ID_CONFIG: &'static str = "client.id"

client.id

pub const REQUEST_TIMEOUT_MS_CONFIG: &'static str = "request.timeout.ms"

request.timeout.ms

pub const DEFAULT_API_TIMEOUT_MS_CONFIG: &'static str = "default.api.timeout.ms"

default.api.timeout.ms

pub const RETRIES_CONFIG: &'static str = "retries"

retries

pub const RETRY_BACKOFF_MS_CONFIG: &'static str = "retry.backoff.ms"

retry.backoff.ms

pub const RETRY_BACKOFF_MAX_MS_CONFIG: &'static str = "retry.backoff.max.ms"

retry.backoff.max.ms

pub const BOOTSTRAP_RESOLVE_TIMEOUT_MS_CONFIG: &'static str = CommonClientConfigs::BOOTSTRAP_RESOLVE_TIMEOUT_MS_CONFIG

bootstrap.resolve.timeout.ms (KIP-909): 0 (the default) resolves bootstrap.servers synchronously when the client is created; a positive value resolves asynchronously, retrying for at most this long.

pub const RECONNECT_BACKOFF_MS_CONFIG: &'static str = "reconnect.backoff.ms"

reconnect.backoff.ms

pub const RECONNECT_BACKOFF_MAX_MS_CONFIG: &'static str = "reconnect.backoff.max.ms"

reconnect.backoff.max.ms

pub const CONNECTIONS_MAX_IDLE_MS_CONFIG: &'static str = "connections.max.idle.ms"

connections.max.idle.ms

pub const METADATA_MAX_AGE_CONFIG: &'static str = "metadata.max.age.ms"

metadata.max.age.ms

pub const SOCKET_CONNECTION_SETUP_TIMEOUT_MS_CONFIG: &'static str = "socket.connection.setup.timeout.ms"

socket.connection.setup.timeout.ms

pub const METADATA_CLUSTER_CHECK_ENABLE_CONFIG: &'static str = CommonClientConfigs::METADATA_CLUSTER_CHECK_ENABLE_CONFIG

metadata.cluster.check.enable (KIP-1242).

Whether the client should send cluster and node information when connecting to a broker to enable it to check for a misrouted connection. This configuration is ignored if rebootstrapping is disabled by setting the configuration metadata.recovery.strategy=none. If the client is connecting to a broker older than Apache Kafka 4.4, no checking is performed and this configuration has no effect.

pub const SECURITY_PROTOCOL_CONFIG: &'static str = CommonClientConfigs::SECURITY_PROTOCOL_CONFIG

security.protocol

pub fn new(props: &HashMap<String, String>) -> Result<Self, Error>

Creates a config from a property map.

Arguments

• props - The admin client configuration properties

Errors

• Error::is_config_error if a value fails to parse or validate, with ConfigDef’s message, or if a SASL security.protocol has an empty sasl.mechanism or one other than PLAIN. Any combination of bootstrap.servers and bootstrap.controllers is accepted here, as in Java: exactly one of them must be set, but the client checks it when it is created (AdminClient::create).

WARNING: sasl.mechanism must be PLAIN.

pub fn get_short(&self, key: &str) -> Result<Option<i16>, Error>

The SHORT configuration key. Reading a key marks it used (Self::unused).

Arguments

• key - the configuration name

Returns

The value, None for Java’s null.

Errors

• Error::is_config_error with Java’s Unknown configuration '<key>' if key is not a configuration this class defines.
• Error::is_local_illegal_argument_error if key is a configuration of another type, where Java’s cast fails with a ClassCastException.

pub fn get_int(&self, key: &str) -> Result<Option<i32>, Error>

The INT configuration key. Reading a key marks it used (Self::unused).

Arguments

• key - the configuration name

Returns

The value, None for Java’s null.

Errors

• Error::is_config_error with Java’s Unknown configuration '<key>' if key is not a configuration this class defines.
• Error::is_local_illegal_argument_error if key is a configuration of another type, where Java’s cast fails with a ClassCastException.

pub fn get_long(&self, key: &str) -> Result<Option<i64>, Error>

The LONG configuration key. Reading a key marks it used (Self::unused).

Arguments

• key - the configuration name

Returns

The value, None for Java’s null.

Errors

• Error::is_config_error with Java’s Unknown configuration '<key>' if key is not a configuration this class defines.
• Error::is_local_illegal_argument_error if key is a configuration of another type, where Java’s cast fails with a ClassCastException.

pub fn get_double(&self, key: &str) -> Result<Option<f64>, Error>

The DOUBLE configuration key. Reading a key marks it used (Self::unused).

Arguments

• key - the configuration name

Returns

The value, None for Java’s null.

Errors

• Error::is_config_error with Java’s Unknown configuration '<key>' if key is not a configuration this class defines.
• Error::is_local_illegal_argument_error if key is a configuration of another type, where Java’s cast fails with a ClassCastException.

pub fn get_list(&self, key: &str) -> Result<Option<&[String]>, Error>

The LIST configuration key, borrowed from the parsed values. Reading a key marks it used (Self::unused).

Arguments

• key - the configuration name

Returns

The value, None for Java’s null.

Errors

• Error::is_config_error with Java’s Unknown configuration '<key>' if key is not a configuration this class defines.
• Error::is_local_illegal_argument_error if key is a configuration of another type, where Java’s cast fails with a ClassCastException.

pub fn get_boolean(&self, key: &str) -> Result<Option<bool>, Error>

The BOOLEAN configuration key. Reading a key marks it used (Self::unused).

Arguments

• key - the configuration name

Returns

The value, None for Java’s null.

Errors

• Error::is_config_error with Java’s Unknown configuration '<key>' if key is not a configuration this class defines.
• Error::is_local_illegal_argument_error if key is a configuration of another type, where Java’s cast fails with a ClassCastException.

pub fn get_string(&self, key: &str) -> Result<Option<&str>, Error>

The STRING configuration key, trimmed. Reading a key marks it used (Self::unused).

Arguments

• key - the configuration name

Returns

The value, None for Java’s null (also what an unset PASSWORD key such as ssl.keystore.key answers, as Java’s cast of null succeeds).

Errors

• Error::is_config_error with Java’s Unknown configuration '<key>' if key is not a configuration this class defines.
• Error::is_local_illegal_argument_error if key is a configuration of another type (a set PASSWORD key is not a STRING), where Java’s cast fails with a ClassCastException.

pub fn unused(&self) -> HashSet<String>

Returns the keys of the properties this configuration was built from that were never read: through a getter, or by the client built from it.

pub fn ignore(&self, key: &str)

Marks the configuration key used without reading it.

Arguments

• key - the configuration name

pub fn log_unused(&self)

Info level log for any unused configurations

pub fn config_names() -> HashSet<String>

The names of the configurations this class defines.

Returns

The set of configuration keys

Trait Implementations

impl Debug for AdminClientConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for AdminClientConfig

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for AdminClientConfig

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for AdminClientConfig