Class/Object

fs2.kafka

AdminClientSettings

Related Docs: object AdminClientSettings | package kafka

Permalink

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#Default for the default settings, and then apply any desired modifications on top of that instance.

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

Abstract Value Members

  1. abstract def adminClientFactory: AdminClientFactory

    Permalink

    The AdminClientFactory for creating the Java AdminClient.

    The default is AdminClientFactory#Default.

    Note that under normal usage you don't need to have a custom AdminClientFactory instance.

    The AdminClientFactory for creating the Java AdminClient.

    The default is AdminClientFactory#Default.

    Note that under normal usage you don't need to have a custom AdminClientFactory instance. For testing, you should prefer to use a custom trait or class similar to KafkaAdminClient.

  2. abstract def closeTimeout: FiniteDuration

    Permalink

    The time to wait for the Java KafkaAdminClient to shutdown.

    The default value is 20 seconds.

  3. abstract def properties: Map[String, String]

    Permalink

    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.

  4. abstract def withAdminClientFactory(adminClientFactory: AdminClientFactory): AdminClientSettings

    Permalink

    Creates a new AdminClientSettings with the specified AdminClientFactory as the adminClientFactory.

    Note that under normal usage you don't need to have a custom AdminClientFactory instance.

    Creates a new AdminClientSettings with the specified AdminClientFactory as the adminClientFactory.

    Note that under normal usage you don't need to have a custom AdminClientFactory instance. For testing, you should prefer to use a custom trait or class similar to KafkaAdminClient.

  5. abstract def withBootstrapServers(bootstrapServers: String): AdminClientSettings

    Permalink

    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

  6. abstract def withClientId(clientId: String): AdminClientSettings

    Permalink

    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

  7. abstract def withCloseTimeout(closeTimeout: FiniteDuration): AdminClientSettings

    Permalink

    Creates a new AdminClientSettings with the specified closeTimeout.

  8. abstract def withConnectionsMaxIdle(connectionsMaxIdle: FiniteDuration): AdminClientSettings

    Permalink

    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

  9. abstract def withMetadataMaxAge(metadataMaxAge: FiniteDuration): AdminClientSettings

    Permalink

    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

  10. abstract def withProperties(properties: Map[String, String]): AdminClientSettings

    Permalink

    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 withProperties(properties: (String, String)*): AdminClientSettings

    Permalink

    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.

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

    Permalink

    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.

  13. abstract def withReconnectBackoff(reconnectBackoff: FiniteDuration): AdminClientSettings

    Permalink

    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

  14. abstract def withReconnectBackoffMax(reconnectBackoffMax: FiniteDuration): AdminClientSettings

    Permalink

    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

  15. abstract def withRequestTimeout(requestTimeout: FiniteDuration): AdminClientSettings

    Permalink

    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

  16. abstract def withRetries(retries: Int): AdminClientSettings

    Permalink

    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

  17. abstract def withRetryBackoff(retryBackoff: FiniteDuration): AdminClientSettings

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped