AdminClientSettings

fs2.kafka.AdminClientSettings

See theAdminClientSettings companion object

sealed abstract class AdminClientSettings

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.

AdminClientSettings instances are immutable and all modification functions return a new AdminClientSettings instance.

Use AdminClientSettings#apply for the default settings, and then apply any desired modifications on top of that instance.

Attributes

Companion: object
Source: AdminClientSettings.scala
Graph
Supertypes: class Object

trait Matchable

class Any

Members list

Value members

Abstract methods

The time to wait for the Java KafkaAdminClient to shutdown.

The default value is 20 seconds.

Attributes

Source: AdminClientSettings.scala

Properties which can be provided when creating a Java KafkaAdminClient instance.

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.

Attributes

Source: AdminClientSettings.scala

Returns a new AdminClientSettings instance with the specified bootstrap servers.

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

Attributes

Source: AdminClientSettings.scala

Returns a new AdminClientSettings instance with the specified client id.

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

Attributes

Source: AdminClientSettings.scala

Creates a new AdminClientSettings with the specified closeTimeout.

Attributes

Source: AdminClientSettings.scala

Returns a new AdminClientSettings instance with the specified max connection idle time.

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

Attributes

Source: AdminClientSettings.scala

Includes the credentials properties from the provided KafkaCredentialStore

Attributes

Source: AdminClientSettings.scala

Returns a new AdminClientSettings instance with the specified max metadata age.

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

Attributes

Source: AdminClientSettings.scala

Includes the specified keys and values as properties.

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.

Attributes

Source: AdminClientSettings.scala

Includes the specified keys and values as properties.

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.

Attributes

Source: AdminClientSettings.scala

Includes a property with the specified key and value.

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.

Attributes

Source: AdminClientSettings.scala

Returns a new AdminClientSettings instance with the specified reconnect backoff.

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

Attributes

Source: AdminClientSettings.scala

Returns a new AdminClientSettings instance with the specified max reconnect backoff.

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

Attributes

Source: AdminClientSettings.scala

Returns a new AdminClientSettings instance with the specified request timeout.

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

Attributes

Source: AdminClientSettings.scala

Returns a new AdminClientSettings instance with the specified retries.

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

Attributes

Source: AdminClientSettings.scala

Returns a new AdminClientSettings instance with the specified retry backoff.

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

Attributes

Source: AdminClientSettings.scala

In this article

Generated with