AdminClientSettings contain settings necessary to create a
KafkaAdminClient. Several convenience functions are provided
so that you don't have to work with String values and keys from
AdminClientConfig. It's still possible to set AdminClientConfig
values with functions like withProperty.<br>
<br>
AdminClientSettings instances are immutable and all modification
functions return a new AdminClientSettings instance.<br>
<br>
Use AdminClientSettings#apply for the default settings, and
then apply any desired modifications on top of that instance.
- Companion
- object
Value members
Abstract methods
The Blocker to use for blocking Kafka operations. If not
explicitly provided, a default Blocker will be created
when creating a KafkaAdminClient instance.
The Blocker to use for blocking Kafka operations. If not
explicitly provided, a default Blocker will be created
when creating a KafkaAdminClient instance.
The time to wait for the Java KafkaAdminClient to shutdown.<br>
<br>
The default value is 20 seconds.
The time to wait for the Java KafkaAdminClient to shutdown.<br>
<br>
The default value is 20 seconds.
Creates a new KafkaAdminClient using the properties. Note that
this operation should be bracketed, using e.g. Resource, to ensure
the close function on the admin client is called.
Creates a new KafkaAdminClient using the properties. Note that
this operation should be bracketed, using e.g. Resource, to ensure
the close function on the admin client is called.
Properties which can be provided when creating a Java KafkaAdminClient
instance. Numerous functions in AdminClientSettings add properties
here if the settings are used by the Java KafkaAdminClient.
Properties which can be provided when creating a Java KafkaAdminClient
instance. Numerous functions in AdminClientSettings add properties
here if the settings are used by the Java KafkaAdminClient.
Returns a new AdminClientSettings instance with the specified blocker to use for blocking operations.
Returns a new AdminClientSettings instance with the specified blocker to use for blocking operations.
Returns a new AdminClientSettings instance with the specified bootstrap servers. This is equivalent to setting the following property using the withProperty function.
Returns a new AdminClientSettings instance with the specified bootstrap servers. This is equivalent to setting the following property using the withProperty function.
AdminClientConfig.BOOTSTRAP_SERVERS_CONFIG
Returns a new AdminClientSettings instance with the specified client id. This is equivalent to setting the following property using the withProperty function.
Returns a new AdminClientSettings instance with the specified client id. This is equivalent to setting the following property using the withProperty function.
AdminClientConfig.CLIENT_ID_CONFIG
Creates a new AdminClientSettings with the specified closeTimeout.
Creates a new AdminClientSettings with the specified closeTimeout.
Returns a new AdminClientSettings instance with the specified
max connection idle time. This is equivalent to setting the following
property using the withProperty function, except you can specify
it with a FiniteDuration instead of a String.
Returns a new AdminClientSettings instance with the specified
max connection idle time. This is equivalent to setting the following
property using the withProperty function, except you can specify
it with a FiniteDuration instead of a String.
AdminClientConfig.CONNECTIONS_MAX_IDLE_MS_CONFIG
Creates a new AdminClientSettings with the specified function for
creating AdminClient instances in createAdminClient. The argument
is the properties of the settings instance.
Creates a new AdminClientSettings with the specified function for
creating AdminClient instances in createAdminClient. The argument
is the properties of the settings instance.
Returns a new AdminClientSettings instance with the specified
max metadata age. This is equivalent to setting the following
property using the withProperty function, except you can
specify it with a FiniteDuration instead of a String.
Returns a new AdminClientSettings instance with the specified
max metadata age. This is equivalent to setting the following
property using the withProperty function, except you can
specify it with a FiniteDuration instead of a String.
AdminClientConfig.METADATA_MAX_AGE_CONFIG
Includes the specified keys and values as properties. The
keys should be part of the AdminClientConfig keys, and
the values should be valid choices for the keys.
Includes the specified keys and values as properties. The
keys should be part of the AdminClientConfig keys, and
the values should be valid choices for the keys.
Includes the specified keys and values as properties. The
keys should be part of the AdminClientConfig keys, and
the values should be valid choices for the keys.
Includes the specified keys and values as properties. The
keys should be part of the AdminClientConfig keys, and
the values should be valid choices for the keys.
Includes a property with the specified key and value.
The key should be one of the keys in AdminClientConfig,
and the value should be a valid choice for the key.
Includes a property with the specified key and value.
The key should be one of the keys in AdminClientConfig,
and the value should be a valid choice for the key.
Returns a new AdminClientSettings instance with the specified
reconnect backoff. This is equivalent to setting the following
property using the withProperty function, except you can
specify it with a FiniteDuration instead of a String.
Returns a new AdminClientSettings instance with the specified
reconnect backoff. This is equivalent to setting the following
property using the withProperty function, except you can
specify it with a FiniteDuration instead of a String.
AdminClientConfig.RECONNECT_BACKOFF_MS_CONFIG
Returns a new AdminClientSettings instance with the specified
max reconnect backoff. This is equivalent to setting the following
property using the withProperty function, except you can
specify it with a FiniteDuration instead of a String.
Returns a new AdminClientSettings instance with the specified
max reconnect backoff. This is equivalent to setting the following
property using the withProperty function, except you can
specify it with a FiniteDuration instead of a String.
AdminClientConfig.RECONNECT_BACKOFF_MAX_MS_CONFIG
Returns a new AdminClientSettings instance with the specified
request timeout. This is equivalent to setting the following
property using the withProperty function, except you can
specify it with a FiniteDuration instead of a String.
Returns a new AdminClientSettings instance with the specified
request timeout. This is equivalent to setting the following
property using the withProperty function, except you can
specify it with a FiniteDuration instead of a String.
AdminClientConfig.REQUEST_TIMEOUT_MS_CONFIG
Returns a new AdminClientSettings instance with the specified
retries. This is equivalent to setting the following property
using the withProperty function, except you can specify
it with an Int instead of a String.
Returns a new AdminClientSettings instance with the specified
retries. This is equivalent to setting the following property
using the withProperty function, except you can specify
it with an Int instead of a String.
AdminClientConfig.RETRIES_CONFIG
Returns a new AdminClientSettings instance with the specified
retry backoff. This is equivalent to setting the following property
using the withProperty function, except you can specify it with
a FiniteDuration instead of a String.
Returns a new AdminClientSettings instance with the specified
retry backoff. This is equivalent to setting the following property
using the withProperty function, except you can specify it with
a FiniteDuration instead of a String.
AdminClientConfig.RETRY_BACKOFF_MS_CONFIG