Apache Kafka Clients

https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1
Admin
Apache Kafka Clients provides the official Java clients for Apache Kafka, including the producer,...
Tokens:150,176
Snippets:1,835
Trust Score:9.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Example JAAS Configuration for Kafka Clients

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/security/oauthbearer/JwtBearerJwtRetriever.html

Complete JAAS configuration example including assertion claims, private key paths, and the token endpoint URL.

```properties
sasl.jaas.config=org.apache.kafka.common.security.oauthbearer.OAuthBearerLoginModule required ;

sasl.oauthbearer.assertion.algorithm=RS256
sasl.oauthbearer.assertion.claim.aud=my-application-audience
sasl.oauthbearer.assertion.claim.exp.seconds=600
sasl.oauthbearer.assertion.claim.iss=my-oauth-issuer
sasl.oauthbearer.assertion.claim.jti.include=true
sasl.oauthbearer.assertion.claim.nbf.seconds=120
sasl.oauthbearer.assertion.claim.sub=kafka-app-1234
sasl.oauthbearer.assertion.private.key.file=/path/to/private.key
sasl.oauthbearer.assertion.private.key.passphrase=$3cr3+
sasl.oauthbearer.assertion.template.file=/path/to/assertion-template.json
sasl.oauthbearer.jwt.retriever.class=org.apache.kafka.common.security.oauthbearer.JwtBearerJwtRetriever
sasl.oauthbearer.scope=my-application-scope
sasl.oauthbearer.token.endpoint.url=https://example.com/oauth2/v1/token
```

--------------------------------

### KafkaProducer Usage

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/producer/KafkaProducer.html

Example of initializing a KafkaProducer and sending records to a topic.

```APIDOC
## KafkaProducer

### Description
A Kafka client that publishes records to the Kafka cluster. The producer is thread-safe and manages a pool of buffer space and a background I/O thread for transmitting records.

### Usage Example
```java
Properties props = new Properties();
props.put("bootstrap.servers", "localhost:9092");
props.put("linger.ms", 1);
props.put("key.serializer", "org.apache.kafka.common.serialization.StringSerializer");
props.put("value.serializer", "org.apache.kafka.common.serialization.StringSerializer");

Producer<String, String> producer = new KafkaProducer<>(props);
for (int i = 0; i < 100; i++)
    producer.send(new ProducerRecord<String, String>("my-topic", Integer.toString(i), Integer.toString(i)));

producer.close();
```

### Key Methods
- **send(ProducerRecord<K,V> record)**: Asynchronously adds a record to a buffer of pending record sends and returns immediately.
- **close()**: Closes the producer and releases associated resources.
```

--------------------------------

### beginTransaction()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/producer/Producer.html

Starts a new transaction for the producer.

```APIDOC
## beginTransaction()

### Description
Starts a new transaction. This method must be called before any records are sent as part of a transaction.

### Throws
- **ProducerFencedException** - If another producer with the same transactional.id is active.
```

--------------------------------

### get(String path)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/config/provider/EnvVarConfigProvider.html

Retrieves all available environment variables as configuration data.

```APIDOC
## ConfigData get(String path)

### Description
Retrieves the data at the given path. Note that the path parameter is unused for environment variables.

### Parameters
- **path** (String) - The path (unused).

### Returns
- **ConfigData** - Returns environment variables as configuration.
```

--------------------------------

### Create a new topic using Admin client

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/Admin.html

Demonstrates initializing an Admin client with bootstrap servers and creating a compacted topic. The example uses a try-with-resources block to ensure the client is closed and calls future.get() to block until the operation completes.

```java
Properties props = new Properties();
props.put(AdminClientConfig.BOOTSTRAP_SERVERS_CONFIG, "localhost:9092");

try (Admin admin = Admin.create(props)) {
  String topicName = "my-topic";
  int partitions = 12;
  short replicationFactor = 3;
  // Create a compacted topic
  CreateTopicsResult result = admin.createTopics(Collections.singleton(
    new NewTopic(topicName, partitions, replicationFactor)
      .configs(Collections.singletonMap(TopicConfig.CLEANUP_POLICY_CONFIG, TopicConfig.CLEANUP_POLICY_COMPACT))));

  // Call values() to get the result for a specific topic
  KafkaFuture<Void> future = result.values().get(topicName);

  // Call get() to block until the topic creation is complete or has failed
  // if creation failed the ExecutionException wraps the underlying cause.
  future.get();
}
```

--------------------------------

### get(String path)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/config/provider/FileConfigProvider.html

Retrieves all configuration data from the specified properties file.

```APIDOC
## ConfigData get(String path)

### Description
Retrieves the data at the given Properties file.

### Parameters
- **path** (String) - Required - The file path where the data resides.

### Returns
- **ConfigData** - The configuration data retrieved from the file.
```

--------------------------------

### earlyStartListeners()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/server/authorizer/AuthorizerServerInfo.html

Returns the collection of configured early start listeners.

```APIDOC
### Method
Collection<String> earlyStartListeners()

### Description
Returns the configured early start listeners.
```

--------------------------------

### get(String path)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/config/provider/DirectoryConfigProvider.html

Retrieves configuration data from all regular files within the specified directory path.

```APIDOC
## ConfigData get(String path)

### Description
Retrieves the data contained in regular files in the directory given by path. Non-regular files such as subdirectories are ignored.

### Parameters
- **path** (String) - The directory path where data files reside.

### Returns
- **ConfigData** - The configuration data retrieved from the directory files.
```

--------------------------------

### get(String name)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/Config.html

Retrieves a specific configuration entry by its name.

```APIDOC
## Method: get(String name)

### Description
Retrieves the configuration entry with the specified name. Returns null if no entry with that name exists.

### Parameters
- **name** (String) - Required - The name of the configuration entry to retrieve.

### Returns
- **ConfigEntry** - The requested configuration entry, or null if not found.
```

--------------------------------

### Sending records with KafkaProducer

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/producer/KafkaProducer.html

A basic example demonstrating how to configure a producer, send records in a loop, and close the producer to release resources.

```java
Properties props = new Properties();
props.put("bootstrap.servers", "localhost:9092");
props.put("linger.ms", 1);
props.put("key.serializer", "org.apache.kafka.common.serialization.StringSerializer");
props.put("value.serializer", "org.apache.kafka.common.serialization.StringSerializer");

Producer<String, String> producer = new KafkaProducer<>(props);
for (int i = 0; i < 100; i++)
    producer.send(new ProducerRecord<String, String>("my-topic", Integer.toString(i), Integer.toString(i)));

producer.close();
```

--------------------------------

### Subscribe with Optimized Listener

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/consumer/StickyAssignor.html

Example of subscribing to topics using the optimized rebalance listener.

```java
consumer.subscribe(topics, new TheNewRebalanceListener());
```

--------------------------------

### getAssignorInstances

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/consumer/ConsumerPartitionAssignor.html

Static method to get a list of configured instances of ConsumerPartitionAssignor.

```APIDOC
## static List<ConsumerPartitionAssignor> getAssignorInstances(List<String> assignorClasses, Map<String,Object> configs)

### Description
Get a list of configured instances of ConsumerPartitionAssignor based on the class names/types specified by ConsumerConfig.PARTITION_ASSIGNMENT_STRATEGY_CONFIG.

### Parameters
- **assignorClasses** (List<String>) - List of class names.
- **configs** (Map<String, Object>) - Configuration map.
```

--------------------------------

### get(String path, Set<String> keys)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/config/provider/FileConfigProvider.html

Retrieves specific configuration keys from the specified properties file.

```APIDOC
## ConfigData get(String path, Set<String> keys)

### Description
Retrieves the data with the given keys at the given Properties file.

### Parameters
- **path** (String) - Required - The file path where the data resides.
- **keys** (Set<String>) - Required - The keys whose values will be retrieved.

### Returns
- **ConfigData** - The configuration data for the requested keys.
```

--------------------------------

### beginningOffsets(Collection<TopicPartition> partitions, Duration timeout)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/consumer/KafkaConsumer.html

Get the first offset for the given partitions without changing the current consumer position.

```APIDOC
## beginningOffsets(Collection<TopicPartition> partitions, Duration timeout)

### Description
Get the first offset for the given partitions. This method does not change the current consumer position of the partitions.

### Parameters
- **partitions** (Collection<TopicPartition>) - Required - The partitions to get the earliest offsets.
- **timeout** (Duration) - Required - The maximum amount of time to await retrieval of the beginning offsets.

### Returns
- (Map<TopicPartition, Long>) - The earliest available offsets for the given partitions.

### Throws
- AuthenticationException - if authentication fails.
- AuthorizationException - if not authorized to the topic(s).
- TimeoutException - if the offset metadata could not be fetched before expiration of the passed timeout.
```

--------------------------------

### Example JAAS Configuration for Kafka Clients

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/security/oauthbearer/ClientCredentialsJwtRetriever.html

Configure the OAuthBearerLoginModule along with the necessary credentials and retriever settings.

```properties
sasl.jaas.config=org.apache.kafka.common.security.oauthbearer.OAuthBearerLoginModule required ;

sasl.oauthbearer.client.credentials.client.id=jdoe
sasl.oauthbearer.client.credentials.client.secret=$3cr3+
sasl.oauthbearer.jwt.retriever.class=org.apache.kafka.common.security.oauthbearer.ClientCredentialsJwtRetriever
sasl.oauthbearer.scope=my-application-scope
sasl.oauthbearer.token.endpoint.url=https://example.com/oauth2/v1/token
```

--------------------------------

### Basic JAAS Configuration for Unsecured SASL/OAUTHBEARER

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/security/oauthbearer/OAuthBearerLoginModule.html

Example configuration for a broker using unsecured SASL/OAUTHBEARER validation.

```text
KafkaServer {
     org.apache.kafka.common.security.oauthbearer.OAuthBearerLoginModule Required
     unsecuredLoginStringClaim_sub="thePrincipalName";
};
```

--------------------------------

### get(String path, Set<String> keys)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/config/provider/EnvVarConfigProvider.html

Retrieves specific environment variables based on the provided keys.

```APIDOC
## ConfigData get(String path, Set<String> keys)

### Description
Retrieves the data with the given keys at the given path.

### Parameters
- **path** (String) - The path (unused).
- **keys** (Set<String>) - The keys whose values will be retrieved.

### Returns
- **ConfigData** - The configuration data.
```

--------------------------------

### get(String path, Set<String> keys)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/config/provider/DirectoryConfigProvider.html

Retrieves configuration data for specific keys from files within the specified directory path.

```APIDOC
## ConfigData get(String path, Set<String> keys)

### Description
Retrieves the data contained in the regular files named by keys in the directory given by path.

### Parameters
- **path** (String) - The directory path where data files reside.
- **keys** (Set<String>) - The set of keys (file names) whose values will be retrieved.

### Returns
- **ConfigData** - The configuration data for the requested keys.
```

--------------------------------

### Basic JAAS Configuration for Unsecured OAUTHBEARER

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/security/oauthbearer/OAuthBearerLoginModule.html

Example configuration for a client using the default unsecured SASL/OAUTHBEARER authentication mechanism.

```text
KafkaClient {
     org.apache.kafka.common.security.oauthbearer.OAuthBearerLoginModule Required
     unsecuredLoginStringClaim_sub="thePrincipalName";
};
```

--------------------------------

### Initialize and Record Metrics

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/metrics/Metrics.html

Demonstrates setting up a global Metrics repository, creating a sensor, adding metrics to it, and recording values.

```java
// set up metrics:
Metrics metrics = new Metrics(); // this is the global repository of metrics and sensors
Sensor sensor = metrics.sensor("message-sizes");
MetricName metricName = metrics.metricName("message-size-avg", "producer-metrics");
sensor.add(metricName, new Avg());
metricName = metrics.metricName("message-size-max", "producer-metrics");
sensor.add(metricName, new Max());

// as messages are sent we record the sizes
sensor.record(messageSize);
```

--------------------------------

### Configure and Record Metrics

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/MetricName.html

Demonstrates setting up a Metrics repository, defining MetricName instances with tags, and recording sensor data.

```java
// set up metrics:

Map<String, String> metricTags = new LinkedHashMap<String, String>();
metricTags.put("client-id", "producer-1");
metricTags.put("topic", "topic");

MetricConfig metricConfig = new MetricConfig().tags(metricTags);
Metrics metrics = new Metrics(metricConfig); // this is the global repository of metrics and sensors

Sensor sensor = metrics.sensor("message-sizes");

MetricName metricName = metrics.metricName("message-size-avg", "producer-metrics", "average message size");
sensor.add(metricName, new Avg());

metricName = metrics.metricName("message-size-max", "producer-metrics");
sensor.add(metricName, new Max());

metricName = metrics.metricName("message-size-min", "producer-metrics", "message minimum size", "client-id", "my-client", "topic", "my-topic");
sensor.add(metricName, new Min());

// as messages are sent we record the sizes
sensor.record(messageSize);
```

--------------------------------

### position

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/consumer/MockConsumer.html

Gets the current position for a partition.

```APIDOC
## long position(TopicPartition partition)

### Description
Returns the current position for the specified partition.

## long position(TopicPartition partition, Duration timeout)

### Description
Returns the current position for the specified partition within the given timeout.
```

--------------------------------

### get

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/KafkaFuture.html

Waits for the future to complete and returns the result.

```APIDOC
## public abstract T get()

### Description
Waits if necessary for this future to complete, and then returns its result.

### Throws
- **InterruptedException**
- **ExecutionException**
```

--------------------------------

### Define and Parse Configurations with ConfigDef

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/config/ConfigDef.html

Demonstrates how to define various configuration types, parse a properties map, and validate the resulting configuration set.

```java
ConfigDef defs = new ConfigDef();

// check define(String, Type, Object, Importance, String) for more details.
defs.define("config_with_default", Type.STRING, "default string value", Importance.High, "Configuration with default value.");
// check define(String, Type, Object, Validator, Importance, String) for more details.
defs.define("config_with_validator", Type.INT, 42, Range.atLeast(0), Importance.High, "Configuration with user provided validator.");
// check define(String, Type, Importance, String, String, int, Width, String, List<String>) for more details.
defs.define("config_with_dependents", Type.INT, Importance.LOW, "Configuration with dependents.", "group", 1, Width.SHORT, "Config With Dependents", Arrays.asList("config_with_default","config_with_validator"));

Map<String, String> props = new HashMap<>();
props.put("config_with_default", "some value");
props.put("config_with_dependents", "some other value");

Map<String, Object> configs = defs.parse(props);
// will return "some value"
String someConfig = (String) configs.get("config_with_default");
// will return default value of 42
int anotherConfig = (Integer) configs.get("config_with_validator");

// To validate the full configuration, use:
List<ConfigValue> configValues = defs.validate(props);
// The ConfigValue contains updated configuration information given the current configuration values.
```

--------------------------------

### seekToBeginning

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/consumer/MockConsumer.html

Seeks to the beginning of the specified partitions.

```APIDOC
## void seekToBeginning(Collection<TopicPartition> partitions)

### Description
Seeks to the beginning of the provided partitions.
```

--------------------------------

### DescribeMetadataQuorumOptions()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/DescribeMetadataQuorumOptions.html

Constructor for creating a new instance of DescribeMetadataQuorumOptions.

```APIDOC
## Constructor: DescribeMetadataQuorumOptions()

### Description
Creates a new instance of the DescribeMetadataQuorumOptions class to be used with the Admin.describeMetadataQuorum method.

### Signature
public DescribeMetadataQuorumOptions()
```

--------------------------------

### get()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/utils/Bytes.html

Retrieves the underlying byte array from the Bytes instance.

```APIDOC
## Method: get()

### Description
Retrieves the data stored within the Bytes instance.

### Returns
- **byte[]** - The underlying byte array.
```

--------------------------------

### createServerSslEngine

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/security/auth/SslEngineFactory.html

Creates a new SSLEngine object to be used by the server.

```APIDOC
## createServerSslEngine(String peerHost, int peerPort)

### Description
Creates a new SSLEngine object to be used by the server.

### Parameters
- **peerHost** (String) - The peer host to use. This is a hint and not used for validation.
- **peerPort** (int) - The peer port to use. This is a hint and not used for validation.

### Returns
- **SSLEngine** - The new SSLEngine.
```

--------------------------------

### partitionsFor(String topic)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/producer/MockProducer.html

Gets partition information for a given topic.

```APIDOC
## List<PartitionInfo> partitionsFor(String topic)

### Description
Gets partition information for a given topic.
```

--------------------------------

### initialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/security/plain/PlainLoginModule.html

Initializes the login module with the provided subject, callback handler, shared state, and configuration options.

```APIDOC
## initialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options)

### Description
Initializes this LoginModule with the relevant authentication information.
```

--------------------------------

### init(List<KafkaMetric> metrics)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/metrics/MetricsReporter.html

Initializes the reporter by registering all existing metrics when the reporter is first registered.

```APIDOC
## void init(List<KafkaMetric> metrics)

### Description
This method is called when the reporter is first registered to initially register all existing metrics.

### Parameters
- **metrics** (List<KafkaMetric>) - All currently existing metrics
```

--------------------------------

### configure(Map<String,?> configs)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/producer/RoundRobinPartitioner.html

Configures the partitioner instance with provided key-value pairs.

```APIDOC
## configure(Map<String,?> configs)

### Description
Configures this class with the given key-value pairs.

### Parameters
- **configs** (Map<String,?>) - Required - The configuration map to apply.
```

--------------------------------

### bootstrap(List<InetSocketAddress>)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/Cluster.html

Creates a bootstrap cluster instance.

```APIDOC
## static Cluster bootstrap(List<InetSocketAddress> addresses)

### Description
Create a "bootstrap" cluster using the given list of host/ports.

### Parameters
- **addresses** (List<InetSocketAddress>) - The addresses to use for bootstrapping.
```

--------------------------------

### validateOnly()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/UpdateFeaturesOptions.html

Methods to get or set the validate-only configuration for the feature update operation.

```APIDOC
### Methods

#### `boolean validateOnly()`
Returns the current validate-only setting.

#### `UpdateFeaturesOptions validateOnly(boolean validateOnly)`
Sets whether the operation should only validate the request without applying changes. Returns this instance for chaining.
```

--------------------------------

### Admin.create

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/Admin.html

Creates an instance of the Admin client using the provided configuration properties.

```APIDOC
## Admin.create(Properties props)

### Description
Creates a new Admin client instance using the provided configuration properties.

### Parameters
- **props** (Properties) - Required - Configuration properties for the Admin client, including bootstrap.servers.
```

--------------------------------

### validateOnly()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/AlterClientQuotasOptions.html

Methods to get or set the validation-only flag for the quota alteration request.

```APIDOC
### Method: validateOnly()
`public boolean validateOnly()`
Returns whether the request should be validated without altering the configs.

### Method: validateOnly(boolean)
`public AlterClientQuotasOptions validateOnly(boolean validateOnly)`
Sets whether the request should be validated without altering the configs. Returns the updated options instance.
```

--------------------------------

### all()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/DescribeProducersResult.html

Returns a KafkaFuture containing the producer state for all partitions.

```APIDOC
## KafkaFuture<Map<TopicPartition, DescribeProducersResult.PartitionProducerState>> all()

### Description
Returns a KafkaFuture that will contain a map of all partitions to their respective producer states once the request completes.
```

--------------------------------

### Transactional KafkaProducer Implementation

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/producer/KafkaProducer.html

Demonstrates initializing a transactional producer, beginning a transaction, sending messages, and handling potential exceptions.

```java
Properties props = new Properties();
props.put("bootstrap.servers", "localhost:9092");
props.put("transactional.id", "my-transactional-id");
Producer<String, String> producer = new KafkaProducer<>(props, new StringSerializer(), new StringSerializer());

producer.initTransactions();

try {
    producer.beginTransaction();
    for (int i = 0; i < 100; i++)
        producer.send(new ProducerRecord<>("my-topic", Integer.toString(i), Integer.toString(i)));
    producer.commitTransaction();
} catch (ProducerFencedException | OutOfOrderSequenceException | AuthorizationException e) {
    // We can't recover from these exceptions, so our only option is to close the producer and exit.
    producer.close();
} catch (KafkaException e) {
    // For all other exceptions, just abort the transaction and try again.
    producer.abortTransaction();
}
producer.close();
```

--------------------------------

### position(TopicPartition, Duration)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/consumer/KafkaConsumer.html

Get the offset of the next record that will be fetched for the given partition.

```APIDOC
## long position(TopicPartition partition, Duration timeout)

### Description
Get the offset of the next record that will be fetched. This method may issue a remote call to the server and will block until the position is determined or the timeout expires.

### Parameters
- **partition** (TopicPartition) - The partition to get the position for.
- **timeout** (Duration) - The maximum time to wait for the position.

### Returns
- **long** - The current position of the consumer.

### Throws
- **IllegalStateException** - if the partition is not assigned.
- **TimeoutException** - if the timeout expires.
```

--------------------------------

### Admin.create

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/Admin.html

Creates a new Admin client instance using the provided configuration properties or map.

```APIDOC
## static Admin create(Properties props)
## static Admin create(Map<String,Object> conf)

### Description
Creates a new Admin client instance to interact with a Kafka cluster.

### Parameters
- **props/conf** (Properties/Map) - Required - The configuration settings for the Admin client.
```

--------------------------------

### ConfigData get(String path)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/config/provider/ConfigProvider.html

Retrieves the configuration data located at the specified path.

```APIDOC
## ConfigData get(String path)

### Description
Retrieves the data at the given path.

### Parameters
- **path** (String) - Required - The path where the data resides.

### Returns
- **ConfigData** - The configuration data.
```

--------------------------------

### ListConfigResourcesOptions()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/ListConfigResourcesOptions.html

Constructor for creating a new instance of ListConfigResourcesOptions.

```APIDOC
## ListConfigResourcesOptions()

### Description
Constructs a new ListConfigResourcesOptions object to be used with the Admin.listConfigResources() method.

### Signature
public ListConfigResourcesOptions()
```

--------------------------------

### onUpdate(ClusterResource clusterResource)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/ClusterResourceListener.html

A callback method that a user can implement to get updates for ClusterResource.

```APIDOC
## void onUpdate(ClusterResource clusterResource)

### Description
A callback method that a user can implement to get updates for `ClusterResource`. This method is invoked when cluster metadata changes or is updated.

### Parameters
- **clusterResource** (ClusterResource) - The cluster metadata object containing the updated information.
```

--------------------------------

### retryOnQuotaViolation(boolean)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/CreatePartitionsOptions.html

Methods to get or set whether quota violations should be automatically retried.

```APIDOC
## boolean shouldRetryOnQuotaViolation()

### Description
Returns true if quota violation should be automatically retried.

## CreatePartitionsOptions retryOnQuotaViolation(boolean retryOnQuotaViolation)

### Description
Set to true if quota violation should be automatically retried.
```

--------------------------------

### sensor(String, Sensor.RecordingLevel)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/metrics/Metrics.html

Gets or creates a sensor with a unique name and a specific recording level.

```APIDOC
## sensor(String, Sensor.RecordingLevel)

### Description
Retrieves an existing sensor or creates a new one with the given name and recording level.

### Parameters
- **name** (String) - The unique name of the sensor.
- **recordingLevel** (Sensor.RecordingLevel) - The recording level for the sensor.
```

--------------------------------

### all()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/CreatePartitionsResult.html

Returns a single KafkaFuture that completes when all partition creation requests have succeeded.

```APIDOC
### Method
`KafkaFuture<Void> all()`

### Description
Return a future which succeeds if all the partition creations succeed.

### Returns
- `KafkaFuture<Void>` - A future that completes successfully if all partition creations are successful.
```

--------------------------------

### Blocking send with KafkaProducer

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/producer/KafkaProducer.html

Simulates a blocking call by invoking get() immediately on the returned Future.

```java
byte[] key = "key".getBytes();
byte[] value = "value".getBytes();
ProducerRecord<byte[],byte[]> record = new ProducerRecord<byte[],byte[]>("my-topic", key, value)
producer.send(record).get();
```

--------------------------------

### all()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/DescribeReplicaLogDirsResult.html

Returns a KafkaFuture that succeeds if log directory information for all requested replicas is available.

```APIDOC
### Method
KafkaFuture<Map<TopicPartitionReplica, DescribeReplicaLogDirsResult.ReplicaLogDirInfo>> all()

### Description
Return a future which succeeds if log directory information of all replicas are available.
```

--------------------------------

### allDescriptions()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/DescribeLogDirsResult.html

Returns a single KafkaFuture that resolves when all requested brokers have responded successfully.

```APIDOC
## allDescriptions()

### Description
Return a future which succeeds only if all the brokers have responded without error. The result of the future is a map from brokerId to a map from broker log directory path to a description of that log directory.

### Returns
- **KafkaFuture<Map<Integer, Map<String, LogDirDescription>>>** - A future that completes with the aggregated log directory descriptions for all requested brokers.
```

--------------------------------

### configure(Map<String,?> configs, boolean isKey)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/serialization/Serde.html

Configures the Serde instance, which in turn configures the underlying serializer and deserializer.

```APIDOC
## void configure(Map<String,?> configs, boolean isKey)

### Description
Configures this class, which will configure the underlying serializer and deserializer.

### Parameters
- **configs** (Map<String,?>) - Required - Configuration settings in key/value pairs.
- **isKey** (boolean) - Required - Indicates whether the configuration is for a key or a value.
```

--------------------------------

### T get()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/security/oauthbearer/BrokerJwtValidator.ClaimSupplier.html

Retrieves a claim value. This method is intended to be implemented to extract specific claim data from a JWT.

```APIDOC
## T get()

### Description
Retrieves the claim value. Implementations of this method are responsible for extracting the desired claim from the JWT context.

### Throws
- **org.jose4j.jwt.MalformedClaimException** - Thrown if the claim cannot be parsed or is malformed.
```

--------------------------------

### createClientSslEngine

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/security/auth/SslEngineFactory.html

Creates a new SSLEngine object to be used by the client.

```APIDOC
## createClientSslEngine(String peerHost, int peerPort, String endpointIdentification)

### Description
Creates a new SSLEngine object to be used by the client.

### Parameters
- **peerHost** (String) - The peer host to use. Used in client mode if endpoint validation is enabled.
- **peerPort** (int) - The peer port to use. This is a hint and not used for validation.
- **endpointIdentification** (String) - Endpoint identification algorithm for client mode.

### Returns
- **SSLEngine** - The new SSLEngine.
```

--------------------------------

### DescribeConfigsOptions()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/DescribeConfigsOptions.html

Constructs a new DescribeConfigsOptions instance.

```APIDOC
## Constructor: DescribeConfigsOptions()

### Description
Creates a new instance of DescribeConfigsOptions to be used with Admin.describeConfigs().
```

--------------------------------

### resume

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/consumer/Consumer.html

Resumes consumption for specific partitions.

```APIDOC
### void resume(Collection<TopicPartition> partitions)

Resumes fetching from the requested partitions that were previously paused.
```

--------------------------------

### Define configuration with basic parameters

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/config/ConfigDef.html

Registers a new configuration parameter without custom dependents or recommenders.

```java
public ConfigDef define(String name, ConfigDef.Type type, Object defaultValue, ConfigDef.Validator validator, ConfigDef.Importance importance, String documentation, String group, int orderInGroup, ConfigDef.Width width, String displayName)
```

--------------------------------

### validateOnly(boolean)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/CreatePartitionsOptions.html

Methods to get or set whether the partition creation request should be validated without actually creating partitions.

```APIDOC
## boolean validateOnly()

### Description
Returns true if the request should be validated without creating new partitions.

## CreatePartitionsOptions validateOnly(boolean validateOnly)

### Description
Set to true if the request should be validated without creating new partitions.
```

--------------------------------

### ListPartitionReassignmentsOptions()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/ListPartitionReassignmentsOptions.html

Constructor for creating a new instance of ListPartitionReassignmentsOptions.

```APIDOC
## ListPartitionReassignmentsOptions()

### Description
Constructs a new ListPartitionReassignmentsOptions object to be used with the Admin.listPartitionReassignments method.

### Signature
public ListPartitionReassignmentsOptions()
```

--------------------------------

### subscribe(Pattern pattern)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/consumer/KafkaConsumer.html

Subscribes to all topics matching a specified pattern to get dynamically assigned partitions using a no-op listener.

```APIDOC
## void subscribe(Pattern pattern)

### Description
Subscribe to all topics matching the specified pattern to get dynamically assigned partitions. This is a short-hand for subscribe(Pattern, ConsumerRebalanceListener) using a no-op listener.

### Parameters
- **pattern** (Pattern) - Required - Pattern to subscribe to.

### Throws
- **IllegalArgumentException** - If pattern is null.
- **IllegalStateException** - If subscribe() is called previously with topics, or assign is called previously, or if not configured with at-least one partition assignment strategy.
```

--------------------------------

### PartitionProducerState(List<ProducerState> activeProducers)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/DescribeProducersResult.PartitionProducerState.html

Constructor for creating a new instance of PartitionProducerState.

```APIDOC
### Constructor
public PartitionProducerState(List<ProducerState> activeProducers)

### Parameters
- **activeProducers** (List<ProducerState>) - The list of active producers to initialize the state with.
```

--------------------------------

### all()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/ListConfigResourcesResult.html

Returns a future that yields either an exception, or the full set of config resources.

```APIDOC
## KafkaFuture<Collection<ConfigResource>> all()

### Description
Returns a future that yields either an exception, or the full set of config resources. In the event of a failure, the future yields nothing but the first exception which occurred.

### Returns
- **KafkaFuture<Collection<ConfigResource>>** - A future containing the collection of config resources or an exception.
```

--------------------------------

### KafkaProducer(Map<String,Object> configs)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/producer/KafkaProducer.html

Instantiates a new KafkaProducer using a map of configuration properties.

```APIDOC
## KafkaProducer(Map<String,Object> configs)

### Description
Instantiates a producer by providing a set of key-value pairs as configuration.

### Parameters
- **configs** (Map<String,Object>) - Required - A set of key-value pairs for producer configuration.
```

--------------------------------

### toHtml()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/config/ConfigDef.html

Converts configuration definitions into HTML format.

```APIDOC
## public String toHtml(int headerDepth, Function<String,String> idGenerator, Map<String,String> dynamicUpdateModes)

### Description
Converts the configuration definitions into an HTML list. Supports specifying header depth, an ID generator function, and dynamic update modes.

### Parameters
- **headerDepth** (int) - The top level header depth in the generated HTML.
- **idGenerator** (Function<String,String>) - A function for computing the HTML id attribute from a config name.
- **dynamicUpdateModes** (Map<String,String>) - A mapping of config names to their update modes.

### Returns
- **String** - The configuration definitions in HTML format.
```

--------------------------------

### subscribe(Pattern pattern, ConsumerRebalanceListener listener)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/consumer/KafkaConsumer.html

Subscribes to all topics matching a specified pattern to get dynamically assigned partitions, using a listener for rebalance notifications.

```APIDOC
## void subscribe(Pattern pattern, ConsumerRebalanceListener listener)

### Description
Subscribe to all topics matching the specified pattern to get dynamically assigned partitions. The pattern matching is performed periodically.

### Parameters
- **pattern** (Pattern) - Required - Pattern to subscribe to.
- **listener** (ConsumerRebalanceListener) - Required - Non-null listener instance to get notifications on partition assignment/revocation.

### Throws
- **IllegalArgumentException** - If pattern or listener is null.
- **IllegalStateException** - If subscribe() is called previously with topics, or assign is called previously, or if not configured with at-least one partition assignment strategy.
```

--------------------------------

### onPartitionsAssigned(Collection<TopicPartition> partitions)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/consumer/ConsumerRebalanceListener.html

A callback method invoked after a successful partition re-assignment completes, before the consumer starts fetching data. This method is triggered as a result of a poll call.

```APIDOC
## void onPartitionsAssigned(Collection<TopicPartition> partitions)

### Description
A callback method the user can implement to provide handling of customized offsets on completion of a successful partition re-assignment. This method is called after the re-assignment completes and before the consumer starts fetching data.

### Parameters
- **partitions** (Collection<TopicPartition>) - Partitions that have been added to the assignment as a result of the rebalance.

### Throws
- **WakeupException** - If raised from a nested call to KafkaConsumer.
- **InterruptException** - If raised from a nested call to KafkaConsumer.
```

--------------------------------

### DescribeTopicsOptions()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/DescribeTopicsOptions.html

Constructor for creating a new instance of DescribeTopicsOptions.

```APIDOC
## DescribeTopicsOptions()

### Description
Constructs a new instance of DescribeTopicsOptions to be used with Admin.describeTopics(Collection).
```

--------------------------------

### sensor(String name, Sensor... parents)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/metrics/Metrics.html

Get or create a sensor with the given unique name and zero or more parent sensors. All parent sensors will receive every value recorded with this sensor. This uses a default recording level of INFO.

```APIDOC
## sensor(String name, Sensor... parents)

### Description
Get or create a sensor with the given unique name and zero or more parent sensors. All parent sensors will receive every value recorded with this sensor. This uses a default recording level of INFO.

### Parameters
- **name** (String) - The name of the sensor
- **parents** (Sensor...) - The parent sensors

### Returns
- **Sensor** - The sensor that is created
```

--------------------------------

### AdminClient.create(Map<String,Object> conf)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/AdminClient.html

Creates a new AdminClient instance using the provided Map configuration.

```APIDOC
## static AdminClient create(Map<String,Object> conf)

### Description
Creates a new Admin client instance with the specified configuration map.

### Parameters
- **conf** (Map<String,Object>) - Required - The configuration map for the client.

### Returns
- **AdminClient** - The new KafkaAdminClient instance.
```

--------------------------------

### seekToBeginning(Collection<TopicPartition>)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/consumer/KafkaConsumer.html

Seek to the first offset for each of the given partitions. This operation is lazy and executes upon the next poll or position call.

```APIDOC
## void seekToBeginning(Collection<TopicPartition> partitions)

### Description
Seek to the first offset for each of the given partitions. If no partitions are provided, seek to the first offset for all of the currently assigned partitions.

### Parameters
- **partitions** (Collection<TopicPartition>) - The partitions to seek to the beginning.

### Throws
- **IllegalArgumentException** - if partitions is null.
- **IllegalStateException** - if any of the provided partitions are not currently assigned to this consumer.
```

--------------------------------

### TopicInfo(int partitions, int replicationFactor, Map<String,String> topicConfigs)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/StreamsGroupSubtopologyDescription.TopicInfo.html

Constructs a new TopicInfo instance with the specified partition count, replication factor, and topic configurations.

```APIDOC
## Constructor: TopicInfo

### Description
Creates a new instance of TopicInfo representing the requirements of a topic within a subtopology.

### Parameters
- **partitions** (int) - The number of partitions required for the topic.
- **replicationFactor** (int) - The replication factor required for the topic.
- **topicConfigs** (Map<String,String>) - A map of topic-level configuration key-value pairs.
```

--------------------------------

### all()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/DescribeConfigsResult.html

Returns a future which succeeds only if all the config descriptions succeed.

```APIDOC
## KafkaFuture<Map<ConfigResource, Config>> all()

### Description
Returns a future which succeeds only if all the config descriptions succeed.

### Returns
- **KafkaFuture<Map<ConfigResource, Config>>** - A future that completes with a map of all requested configurations if all individual requests succeed.
```

--------------------------------

### AdminClient.create(Properties props)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/AdminClient.html

Creates a new AdminClient instance using the provided Properties configuration.

```APIDOC
## static AdminClient create(Properties props)

### Description
Creates a new Admin client instance with the specified configuration properties.

### Parameters
- **props** (Properties) - Required - The configuration properties for the client.

### Returns
- **AdminClient** - The new KafkaAdminClient instance.
```

--------------------------------

### DescribeAclsOptions()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/DescribeAclsOptions.html

Constructor to create a new instance of DescribeAclsOptions.

```APIDOC
## DescribeAclsOptions()

### Description
Constructs a new DescribeAclsOptions object to be used with Admin.describeAcls(AclBindingFilter).
```

--------------------------------

### DescribeProducersOptions()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/DescribeProducersOptions.html

Constructs a new instance of DescribeProducersOptions.

```APIDOC
## DescribeProducersOptions()

### Description
Constructs a new instance of DescribeProducersOptions.
```

--------------------------------

### DescribeClientQuotasOptions()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/DescribeClientQuotasOptions.html

Constructor for creating a new instance of DescribeClientQuotasOptions.

```APIDOC
## Constructor: DescribeClientQuotasOptions()

### Description
Constructs a new instance of the DescribeClientQuotasOptions class, which is used to specify options for the Admin.describeClientQuotas operation.

### Signature
`public DescribeClientQuotasOptions()`
```

--------------------------------

### Config(List<ConfigValue> configValues)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/config/Config.html

Constructor for the Config class. Initializes a new instance with a list of configuration values.

```APIDOC
### Constructor
`public Config(List<ConfigValue> configValues)`

#### Description
Creates a new Config instance containing the provided list of configuration values.

#### Parameters
- **configValues** (List<ConfigValue>) - Required - A list of ConfigValue objects representing the configuration settings.
```

--------------------------------

### configure(Map<String,?> configs, boolean isKey)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/serialization/ListSerializer.html

Configures the serializer instance.

```APIDOC
## configure(Map<String,?> configs, boolean isKey)

### Description
Configures this class with the provided key/value pairs.

### Method
`public void configure(Map<String,?> configs, boolean isKey)`

### Parameters
- **configs** (Map<String,?>) - Configuration settings.
- **isKey** (boolean) - Whether the serializer is used for the key or the value.
```

--------------------------------

### void subscribe(String path, Set<String> keys, ConfigChangeCallback callback)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/config/provider/ConfigProvider.html

Subscribes to changes for specific keys at a given path. This is an optional operation.

```APIDOC
## void subscribe(String path, Set<String> keys, ConfigChangeCallback callback)

### Description
Subscribes to changes for the given keys at the given path (optional operation).

### Parameters
- **path** (String) - Required - The path where the data resides.
- **keys** (Set<String>) - Required - The keys whose values will be retrieved.
- **callback** (ConfigChangeCallback) - Required - The callback to invoke upon change.

### Throws
- **UnsupportedOperationException** - If the subscribe operation is not supported.
```

--------------------------------

### Increase Topic Partitions with Explicit Assignments

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/NewPartitions.html

Demonstrates how to increase a topic's partition count while providing specific broker assignments for the new partitions.

```java
NewPartitions.increaseTo(6, asList(asList(1, 2),
                                   asList(2, 3),
                                   asList(3, 1)))
```

--------------------------------

### void configure(Map<String,?> configs)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/MessageFormatter.html

Configures the MessageFormatter instance with the provided configuration map.

```APIDOC
## void configure(Map<String,?> configs)

### Description
Configures the MessageFormatter.

### Parameters
- **configs** (Map<String,?>) - Map to configure the formatter.
```

--------------------------------

### Config(Collection<ConfigEntry> entries)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/Config.html

Constructor to create a configuration instance with the provided collection of ConfigEntry objects.

```APIDOC
## Constructor: Config(Collection<ConfigEntry> entries)

### Description
Creates a new configuration instance initialized with the specified collection of configuration entries.

### Parameters
- **entries** (Collection<ConfigEntry>) - Required - The collection of configuration entries to include in this object.
```

--------------------------------

### all()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/AlterStreamsGroupOffsetsResult.html

Returns a KafkaFuture that completes when all partition offset alterations have succeeded.

```APIDOC
## KafkaFuture<Void> all()

### Description
Returns a future which succeeds if all the alter offsets succeed.

### Returns
- **KafkaFuture<Void>** - A future representing the completion of all offset alterations.
```

--------------------------------

### DescribeTransactionsOptions()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/DescribeTransactionsOptions.html

Constructor for creating a new instance of DescribeTransactionsOptions.

```APIDOC
## Constructor: DescribeTransactionsOptions()

### Description
Creates a new instance of the DescribeTransactionsOptions class to be used with the Admin.describeTransactions(Collection) method.

### Signature
`public DescribeTransactionsOptions()`
```

--------------------------------

### configure()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/security/oauthbearer/DefaultJwtRetriever.html

Configures the retriever with the necessary settings for token acquisition.

```APIDOC
## void configure(Map<String,?> configs, String saslMechanism, List<AppConfigurationEntry> jaasConfigEntries)

### Description
Configures the DefaultJwtRetriever instance using the provided configuration map, SASL mechanism, and JAAS configuration entries.

### Parameters
- **configs** (Map<String,?>) - Configuration settings.
- **saslMechanism** (String) - The SASL mechanism being used.
- **jaasConfigEntries** (List<AppConfigurationEntry>) - JAAS configuration entries.
```

--------------------------------

### ListSerde()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/serialization/Serdes.ListSerde.html

Constructs a new ListSerde instance.

```APIDOC
## Constructor: ListSerde()

### Description
Constructs a new ListSerde instance with default settings.

### Signature
`public ListSerde()`
```

--------------------------------

### configure(Map<String,?> configs)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/Configurable.html

Configures the implementing class with the provided key-value pairs.

```APIDOC
## void configure(Map<String,?> configs)

### Description
Configure this class with the given key-value pairs.

### Parameters
- **configs** (Map<String,?>) - Required - A map containing configuration key-value pairs.
```

--------------------------------

### CreateAclsOptions()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/CreateAclsOptions.html

Constructor to initialize a new instance of CreateAclsOptions.

```APIDOC
## Constructor: CreateAclsOptions()

### Description
Initializes a new instance of the CreateAclsOptions class.

### Signature
`public CreateAclsOptions()`
```

--------------------------------

### configure(Map<String,?> configs)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/config/provider/FileConfigProvider.html

Configures the FileConfigProvider instance with the provided key-value pairs.

```APIDOC
## void configure(Map<String,?> configs)

### Description
Configures this class with the given key-value pairs.

### Parameters
- **configs** (Map<String,?>) - Required - The configuration map containing key-value pairs.
```

--------------------------------

### configure

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/security/auth/Login.html

Configures the login instance with Kafka configuration options and JAAS settings.

```APIDOC
## void configure(Map<String,?> configs, String contextName, Configuration jaasConfiguration, AuthenticateCallbackHandler loginCallbackHandler)

### Description
Configures this login instance using the provided Kafka configurations and JAAS settings.

### Parameters
- **configs** (Map<String,?>) - Key-value pairs containing the parsed configuration options of the client or broker.
- **contextName** (String) - JAAS context name for this login.
- **jaasConfiguration** (Configuration) - JAAS configuration containing the login context.
- **loginCallbackHandler** (AuthenticateCallbackHandler) - Login callback handler instance to use for this Login.
```

--------------------------------

### Define configuration with recommender

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/config/ConfigDef.html

Registers a new configuration parameter including a custom recommender for valid values.

```java
public ConfigDef define(String name, ConfigDef.Type type, Object defaultValue, ConfigDef.Validator validator, ConfigDef.Importance importance, String documentation, String group, int orderInGroup, ConfigDef.Width width, String displayName, ConfigDef.Recommender recommender)
```

--------------------------------

### Metrics(MetricConfig, List<MetricsReporter>, Time, boolean, MetricsContext)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/metrics/Metrics.html

Creates a new metrics repository instance with the specified configuration, reporters, time instance, expiration settings, and metrics context.

```APIDOC
## Metrics(MetricConfig, List<MetricsReporter>, Time, boolean, MetricsContext)

### Description
Initializes a metrics repository with a default configuration, a list of reporters, a time instance, sensor expiration settings, and a metrics context.

### Parameters
- **defaultConfig** (MetricConfig) - The default configuration for metrics.
- **reporters** (List<MetricsReporter>) - The list of metrics reporters.
- **time** (Time) - The time instance to use with the metrics.
- **enableExpiration** (boolean) - Whether the metrics instance can garbage collect inactive sensors.
- **metricsContext** (MetricsContext) - The context to initialize metrics reporters with.
```

--------------------------------

### DescribeLogDirsOptions()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/DescribeLogDirsOptions.html

Constructor for creating a new instance of DescribeLogDirsOptions.

```APIDOC
## DescribeLogDirsOptions()

### Description
Constructs a new DescribeLogDirsOptions object to be used with the Admin.describeLogDirs(Collection) method.

### Signature
public DescribeLogDirsOptions()
```

--------------------------------

### CreateTopicsOptions Class

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/CreateTopicsOptions.html

Configuration options for Kafka topic creation operations.

```APIDOC
## CreateTopicsOptions

### Description
Options for `Admin.createTopics(Collection)`.

### Methods
- **timeoutMs(Integer timeoutMs)**: Set the timeout in milliseconds for this operation or null if the default api timeout for the AdminClient should be used.
- **validateOnly(boolean validateOnly)**: Set to true if the request should be validated without creating the topic.
- **shouldValidateOnly()**: Return true if the request should be validated without creating the topic.
- **retryOnQuotaViolation(boolean retryOnQuotaViolation)**: Set to true if quota violation should be automatically retried.
- **shouldRetryOnQuotaViolation()**: Returns true if quota violation should be automatically retried.
```

--------------------------------

### TopicMetadataAndConfig Methods

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/CreateTopicsResult.TopicMetadataAndConfig.html

Methods to retrieve metadata and configuration details from a TopicMetadataAndConfig instance.

```APIDOC
## Method: topicId()

### Description
Returns the unique identifier (Uuid) of the topic.

### Returns
- **Uuid** - The topic ID.

## Method: numPartitions()

### Description
Returns the number of partitions for the topic.

### Returns
- **int** - The number of partitions.

## Method: replicationFactor()

### Description
Returns the replication factor for the topic.

### Returns
- **int** - The replication factor.

## Method: config()

### Description
Returns the configuration settings for the topic.

### Returns
- **Config** - The topic configuration object.
```

--------------------------------

### all()

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/admin/ListGroupsResult.html

Returns a KafkaFuture that yields either an exception or the full set of group listings.

```APIDOC
## KafkaFuture<Collection<GroupListing>> all()

### Description
Returns a future that yields either an exception, or the full set of group listings. In the event of a failure, the future yields nothing but the first exception which occurred.
```

--------------------------------

### Ordered Callback Execution

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/clients/producer/KafkaProducer.html

Demonstrates that callbacks for records sent to the same partition are guaranteed to execute in order.

```java
producer.send(new ProducerRecord<byte[],byte[]>(topic, partition, key1, value1), callback1);
producer.send(new ProducerRecord<byte[],byte[]>(topic, partition, key2, value2), callback2);
```

--------------------------------

### void onChange(String path, ConfigData data)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/config/ConfigChangeCallback.html

This method is invoked to perform an action when configuration data at a specific path changes.

```APIDOC
## void onChange(String path, ConfigData data)

### Description
Performs an action when configuration data changes. This method is intended to be implemented by users to handle updates to configuration data at a given path.

### Parameters
- **path** (String) - The path at which the data resides.
- **data** (ConfigData) - The configuration data that has changed.
```

--------------------------------

### keystore

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/security/auth/SslEngineFactory.html

Returns the keystore configured for this factory.

```APIDOC
## keystore()

### Description
Returns keystore configured for this factory.

### Returns
- **KeyStore** - The keystore for this factory or null if not configured.
```

--------------------------------

### configure(Map<String,?> configs)

Source: https://javadoc.io/doc/org.apache.kafka/kafka-clients/4.3.1/org/apache/kafka/common/config/provider/DirectoryConfigProvider.html

Configures the DirectoryConfigProvider instance with the provided key-value pairs.

```APIDOC
## void configure(Map<String,?> configs)

### Description
Configures this class with the given key-value pairs.

### Parameters
- **configs** (Map<String,?>) - The configuration map containing settings for the provider.
```
Tokens:
Raw