Table of Contents

Interface IConfluentAdminClientFactory

Namespace
Silverback.Messaging.Broker.Kafka
Assembly
Silverback.Integration.Kafka.dll

The factory used to create Confluent.Kafka.IAdminClient instances. Each method returns a new instance, which must be disposed by the caller.

public interface IConfluentAdminClientFactory

Methods

GetClient(AdminClientConfig)

Returns an Confluent.Kafka.IAdminClient instance for the specified configuration.

IAdminClient GetClient(AdminClientConfig config)

Parameters

config AdminClientConfig

The client configuration.

Returns

IAdminClient

The Confluent.Kafka.IAdminClient.

GetClient(IConsumer)

Returns an Confluent.Kafka.IAdminClient instance using the configuration of the specified consumer.

IAdminClient GetClient(IConsumer consumer)

Parameters

consumer IConsumer

The Kafka consumer.

Returns

IAdminClient

The Confluent.Kafka.IAdminClient.

GetClient(IProducer)

Returns an Confluent.Kafka.IAdminClient instance using the configuration of the specified producer.

IAdminClient GetClient(IProducer producer)

Parameters

producer IProducer

The Kafka producer.

Returns

IAdminClient

The Confluent.Kafka.IAdminClient.

GetClient(KafkaClientConfiguration)

Returns an Confluent.Kafka.IAdminClient instance using the specified configuration.

IAdminClient GetClient(KafkaClientConfiguration configuration)

Parameters

configuration KafkaClientConfiguration

The configuration.

Returns

IAdminClient

The Confluent.Kafka.IAdminClient.

GetClient(KafkaConsumerConfiguration)

Returns an Confluent.Kafka.IAdminClient instance using the specified configuration.

IAdminClient GetClient(KafkaConsumerConfiguration configuration)

Parameters

configuration KafkaConsumerConfiguration

The configuration.

Returns

IAdminClient

The Confluent.Kafka.IAdminClient.

GetClient(KafkaProducerConfiguration)

Returns an Confluent.Kafka.IAdminClient instance using the specified configuration.

IAdminClient GetClient(KafkaProducerConfiguration configuration)

Parameters

configuration KafkaProducerConfiguration

The configuration.

Returns

IAdminClient

The Confluent.Kafka.IAdminClient.

GetClient(Action<KafkaClientConfigurationBuilder>)

Returns an Confluent.Kafka.IAdminClient instance using the specified configuration.

IAdminClient GetClient(Action<KafkaClientConfigurationBuilder> builderAction)

Parameters

builderAction Action<KafkaClientConfigurationBuilder>

An Action<T> that takes a KafkaClientConfigurationBuilder and configures it.

Returns

IAdminClient

The Confluent.Kafka.IAdminClient.

GetClientForConsumer(string)

Returns an Confluent.Kafka.IAdminClient instance using the configuration of the Kafka consumer with the specified name.

IAdminClient GetClientForConsumer(string consumerName)

Parameters

consumerName string

The name specified when adding the consumer.

Returns

IAdminClient

The Confluent.Kafka.IAdminClient.

GetClientForConsumerEndpoint(string)

Returns an Confluent.Kafka.IAdminClient instance using the configuration of the Kafka consumer for the specified endpoint.

IAdminClient GetClientForConsumerEndpoint(string endpointName)

Parameters

endpointName string

The endpoint friendly name or the name of one of the consumed topics, including the topics matching a subscribed pattern.

Returns

IAdminClient

The Confluent.Kafka.IAdminClient.

GetClientForProducer(string)

Returns an Confluent.Kafka.IAdminClient instance using the configuration of the Kafka producer with the specified name.

IAdminClient GetClientForProducer(string producerName)

Parameters

producerName string

The name specified when adding the producer.

Returns

IAdminClient

The Confluent.Kafka.IAdminClient.

GetClientForProducerEndpoint(string)

Returns an Confluent.Kafka.IAdminClient instance using the configuration of the Kafka producer for the specified endpoint.

IAdminClient GetClientForProducerEndpoint(string endpointName)

Parameters

endpointName string

The endpoint friendly name or the topic name. The endpoints with a dynamic target topic can be found by friendly name only.

Returns

IAdminClient

The Confluent.Kafka.IAdminClient.