sealed abstract class AdminClientSettings extends AnyRef
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.
- Alphabetic
- By Inheritance
- AdminClientSettings
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
closeTimeout: FiniteDuration
The time to wait for the Java
KafkaAdminClient
to shutdown.
The default value is 20 seconds. -
abstract
def
properties: Map[String, String]
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 JavaKafkaAdminClient
. -
abstract
def
withBootstrapServers(bootstrapServers: String): AdminClientSettings
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
-
abstract
def
withClientId(clientId: String): AdminClientSettings
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
-
abstract
def
withCloseTimeout(closeTimeout: FiniteDuration): AdminClientSettings
Creates a new AdminClientSettings with the specified closeTimeout.
-
abstract
def
withConnectionsMaxIdle(connectionsMaxIdle: FiniteDuration): AdminClientSettings
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 aString
.AdminClientConfig.CONNECTIONS_MAX_IDLE_MS_CONFIG
-
abstract
def
withCredentials(credentialsStore: KafkaCredentialStore): AdminClientSettings
Includes the credentials properties from the provided KafkaCredentialStore
-
abstract
def
withMetadataMaxAge(metadataMaxAge: FiniteDuration): AdminClientSettings
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 aString
.AdminClientConfig.METADATA_MAX_AGE_CONFIG
-
abstract
def
withProperties(properties: Map[String, String]): AdminClientSettings
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. -
abstract
def
withProperties(properties: (String, String)*): AdminClientSettings
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. -
abstract
def
withProperty(key: String, value: String): AdminClientSettings
Includes a property with the specified
key
andvalue
.Includes a property with the specified
key
andvalue
. The key should be one of the keys inAdminClientConfig
, and the value should be a valid choice for the key. -
abstract
def
withReconnectBackoff(reconnectBackoff: FiniteDuration): AdminClientSettings
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 aString
.AdminClientConfig.RECONNECT_BACKOFF_MS_CONFIG
-
abstract
def
withReconnectBackoffMax(reconnectBackoffMax: FiniteDuration): AdminClientSettings
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 aString
.AdminClientConfig.RECONNECT_BACKOFF_MAX_MS_CONFIG
-
abstract
def
withRequestTimeout(requestTimeout: FiniteDuration): AdminClientSettings
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 aString
.AdminClientConfig.REQUEST_TIMEOUT_MS_CONFIG
-
abstract
def
withRetries(retries: Int): AdminClientSettings
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 aString
.AdminClientConfig.RETRIES_CONFIG
-
abstract
def
withRetryBackoff(retryBackoff: FiniteDuration): AdminClientSettings
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 aString
.AdminClientConfig.RETRY_BACKOFF_MS_CONFIG
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()