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.

Source
AdminClientSettings.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AdminClientSettings
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def closeTimeout: FiniteDuration

    The time to wait for the Java KafkaAdminClient to shutdown.

    The default value is 20 seconds.

  2. 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 Java KafkaAdminClient.

  3. 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
  4. 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
  5. abstract def withCloseTimeout(closeTimeout: FiniteDuration): AdminClientSettings

    Creates a new AdminClientSettings with the specified closeTimeout.

  6. 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 a String.

    AdminClientConfig.CONNECTIONS_MAX_IDLE_MS_CONFIG
  7. abstract def withCredentials(credentialsStore: KafkaCredentialStore): AdminClientSettings

    Includes the credentials properties from the provided KafkaCredentialStore

  8. 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 a String.

    AdminClientConfig.METADATA_MAX_AGE_CONFIG
  9. 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.

  10. 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.

  11. abstract def withProperty(key: String, value: String): AdminClientSettings

    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.

  12. 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 a String.

    AdminClientConfig.RECONNECT_BACKOFF_MS_CONFIG
  13. 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 a String.

    AdminClientConfig.RECONNECT_BACKOFF_MAX_MS_CONFIG
  14. 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 a String.

    AdminClientConfig.REQUEST_TIMEOUT_MS_CONFIG
  15. 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 a String.

    AdminClientConfig.RETRIES_CONFIG
  16. 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 a String.

    AdminClientConfig.RETRY_BACKOFF_MS_CONFIG

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped