SenderOptions (Reactor Kafka 1.4.0-SNAPSHOT)

```
public interface SenderOptions<K,V>
```

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface SenderOptions.ProducerListener
Called whenever a producer is added or removed.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`SenderOptions.ProducerListener` Called whenever a producer is added or removed.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default String`	`bootstrapServers()` Return the bootstrap servers from the provided `ProducerConfig`.
`default String`	`clientId()` Return the client id provided by the `ProducerConfig`.
`Duration`	`closeTimeout()` Returns the timeout for graceful shutdown of this sender.
`SenderOptions<K,V>`	`closeTimeout(Duration timeout)` Configures the timeout for graceful shutdown of this sender.
`static <K,V> SenderOptions<K,V>`	`create()` Creates a sender options instance with default properties.
`static <K,V> SenderOptions<K,V>`	`create(Map<String,Object> configProperties)` Creates a sender options instance with the specified config overrides for the underlying Kafka `Producer`.
`static <K,V> SenderOptions<K,V>`	`create(Properties configProperties)` Creates a sender options instance with the specified config overrides for the underlying Kafka `Producer`.
`default boolean`	`fatalException(Throwable t)`
`default boolean`	`isTransactional()` Senders created from this options will be transactional if a transactional id is configured using `ProducerConfig.TRANSACTIONAL_ID_CONFIG`.
`org.apache.kafka.common.serialization.Serializer<K>`	`keySerializer()` Returns optionally a serializer witch is used by `KafkaProducer` for key serialization.
`int`	`maxInFlight()` Returns the maximum number of in-flight records that are fetched from the outbound record publisher while acknowledgements are pending.
`SenderOptions<K,V>`	`maxInFlight(int maxInFlight)` Configures the maximum number of in-flight records that are fetched from the outbound record publisher while acknowledgements are pending.
`KafkaSenderObservationConvention`	`observationConvention()` Return a `KafkaSenderObservationConvention` to support a publishing operation observation.
`io.micrometer.observation.ObservationRegistry`	`observationRegistry()` Return an `ObservationRegistry` to observe Kafka record publishing operation.
`default SenderOptions.ProducerListener`	`producerListener()` Returns the listener that will be applied after a producer is added and removed.
`default SenderOptions<K,V>`	`producerListener(SenderOptions.ProducerListener listener)` Set a listener that will be applied after a producer is added and removed.
`Map<String,Object>`	`producerProperties()` Returns the configuration properties for the underlying Kafka `Producer`.
`Object`	`producerProperty(String name)` Returns the Kafka `Producer` configuration property value for the specified option name.
`SenderOptions<K,V>`	`producerProperty(String name, Object value)` Sets Kafka `Producer` configuration property to the specified value.
`Scheduler`	`scheduler()` Returns the scheduler used for publishing send results.
`SenderOptions<K,V>`	`scheduler(Scheduler scheduler)` Sets the scheduler used for publishing send results.
`boolean`	`stopOnError()` Returns stopOnError configuration which indicates if a send operation should be terminated when an error is encountered.
`SenderOptions<K,V>`	`stopOnError(boolean stopOnError)` Configures error handling behaviour for `KafkaSender.send(org.reactivestreams.Publisher)`.
`default String`	`transactionalId()` Returns the configured transactional id
`org.apache.kafka.common.serialization.Serializer<V>`	`valueSerializer()` Returns optionally a serializer witch is used by `KafkaProducer` for value serialization.
`SenderOptions<K,V>`	`withKeySerializer(org.apache.kafka.common.serialization.Serializer<K> keySerializer)` Set a concrete serializer instant to be used by the `KafkaProducer` for keys.
`default SenderOptions<K,V>`	`withObservation(io.micrometer.observation.ObservationRegistry observationRegistry)` Configure an `ObservationRegistry` to observe Kafka record publishing operation.
`SenderOptions<K,V>`	`withObservation(io.micrometer.observation.ObservationRegistry observationRegistry, KafkaSenderObservationConvention observationConvention)` Configure an `ObservationRegistry` to observe Kafka record publishing operation.
`SenderOptions<K,V>`	`withValueSerializer(org.apache.kafka.common.serialization.Serializer<V> valueSerializer)` Set a concrete serializer instant to be used by the `KafkaProducer` for values.

- Method Detail
  - create
```
@NonNull
static <K,V> SenderOptions<K,V> create()
```
    Creates a sender options instance with default properties.
    
    Returns:
    
    new instance of sender options
  - create
```
@NonNull
static <K,V> SenderOptions<K,V> create(@NonNull
                                                Map<String,Object> configProperties)
```
    Creates a sender options instance with the specified config overrides for the underlying Kafka Producer.
    
    Returns:
    
    new instance of sender options
  - create
```
@NonNull
static <K,V> SenderOptions<K,V> create(@NonNull
                                                Properties configProperties)
```
    Creates a sender options instance with the specified config overrides for the underlying Kafka Producer.
    
    Returns:
    
    new instance of sender options
  - producerProperties
```
@NonNull
Map<String,Object> producerProperties()
```
    Returns the configuration properties for the underlying Kafka Producer.
    
    Returns:
    
    configuration options for Kafka producer
  - producerProperty
```
@Nullable
Object producerProperty(@NonNull
                                  String name)
```
    Returns the Kafka Producer configuration property value for the specified option name.
    
    Returns:
    
    Kafka producer configuration option value
  - producerProperty
```
@NonNull
SenderOptions<K,V> producerProperty(@NonNull
                                             String name,
                                             @NonNull
                                             Object value)
```
    Sets Kafka Producer configuration property to the specified value.
    
    Returns:
    
    sender options with updated Kafka producer option
  - keySerializer
```
@Nullable
org.apache.kafka.common.serialization.Serializer<K> keySerializer()
```
    Returns optionally a serializer witch is used by KafkaProducer for key serialization.
    
    Returns:
    
    configured key serializer instant
  - withKeySerializer
```
@NonNull
SenderOptions<K,V> withKeySerializer(@NonNull
                                              org.apache.kafka.common.serialization.Serializer<K> keySerializer)
```
    Set a concrete serializer instant to be used by the KafkaProducer for keys. Overrides any setting of the ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG property.
    
    Parameters:
    
    keySerializer - key serializer to use in the consumer
    
    Returns:
    
    options instance with new key serializer
  - valueSerializer
```
@Nullable
org.apache.kafka.common.serialization.Serializer<V> valueSerializer()
```
    Returns optionally a serializer witch is used by KafkaProducer for value serialization.
    
    Returns:
    
    configured value serializer instant
  - withValueSerializer
```
@NonNull
SenderOptions<K,V> withValueSerializer(@NonNull
                                                org.apache.kafka.common.serialization.Serializer<V> valueSerializer)
```
    Set a concrete serializer instant to be used by the KafkaProducer for values. Overrides any setting of the ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG property.
    
    Parameters:
    
    valueSerializer - value serializer to use in the consumer
    
    Returns:
    
    options instance with new value serializer
  - scheduler
```
@NonNull
Scheduler scheduler()
```
    Returns the scheduler used for publishing send results.
    
    Returns:
    
    response scheduler
  - scheduler
```
@NonNull
SenderOptions<K,V> scheduler(@NonNull
                                      Scheduler scheduler)
```
    Sets the scheduler used for publishing send results.
    
    Returns:
    
    sender options with updated response scheduler
  - maxInFlight
```
@NonNull
int maxInFlight()
```
    Returns the maximum number of in-flight records that are fetched from the outbound record publisher while acknowledgements are pending.
    
    Returns:
    
    maximum number of in-flight records
  - maxInFlight
```
@NonNull
SenderOptions<K,V> maxInFlight(@NonNull
                                        int maxInFlight)
```
    Configures the maximum number of in-flight records that are fetched from the outbound record publisher while acknowledgements are pending. This limit must be configured along with ProducerConfig.BUFFER_MEMORY_CONFIG to control memory usage and to avoid blocking the reactive pipeline.
    
    Returns:
    
    sender options with new in-flight limit
  - stopOnError
```
@NonNull
boolean stopOnError()
```
    Returns stopOnError configuration which indicates if a send operation should be terminated when an error is encountered. If set to false, send is attempted for all records in a sequence even if send of one of the records fails with a non-fatal exception.
    
    Returns:
    
    boolean indicating if send sequences should fail on first error
  - stopOnError
```
@NonNull
SenderOptions<K,V> stopOnError(@NonNull
                                        boolean stopOnError)
```
    Configures error handling behaviour for KafkaSender.send(org.reactivestreams.Publisher). If set to true, send fails when an error is encountered and only records that are already in transit may be delivered after the first error. If set to false, an attempt is made to send each record to Kafka, even if one or more records cannot be delivered after the configured number of retries due to a non-fatal exception. This flag should be set along with ProducerConfig.RETRIES_CONFIG and ProducerConfig.ACKS_CONFIG to configure the required quality-of-service. By default, stopOnError is true.
    
    Parameters:
    
    stopOnError - true to stop each send sequence on first failure
    
    Returns:
    
    sender options with the new stopOnError flag.
  - closeTimeout
```
@NonNull
Duration closeTimeout()
```
    Returns the timeout for graceful shutdown of this sender.
    
    Returns:
    
    close timeout duration
  - closeTimeout
```
@NonNull
SenderOptions<K,V> closeTimeout(@NonNull
                                         Duration timeout)
```
    Configures the timeout for graceful shutdown of this sender.
    
    Returns:
    
    sender options with updated close timeout
  - producerListener
```
@Nullable
default SenderOptions.ProducerListener producerListener()
```
    Returns the listener that will be applied after a producer is added and removed.
    
    Returns:
    
    the listener.
    
    Since:
    
    1.3.17
  - producerListener
```
default SenderOptions<K,V> producerListener(@Nullable
                                            SenderOptions.ProducerListener listener)
```
    Set a listener that will be applied after a producer is added and removed.
    
    Returns:
    
    options instance with the updated listener.
    
    Since:
    
    1.3.17
  - withObservation
```
@NonNull
default SenderOptions<K,V> withObservation(@NonNull
                                                    io.micrometer.observation.ObservationRegistry observationRegistry)
```
    Configure an ObservationRegistry to observe Kafka record publishing operation.
    
    Parameters:
    
    observationRegistry - ObservationRegistry to use.
    
    Returns:
    
    sender options with updated observationRegistry
    
    Since:
    
    1.3.21
  - withObservation
```
@NonNull
SenderOptions<K,V> withObservation(@NonNull
                                            io.micrometer.observation.ObservationRegistry observationRegistry,
                                            @Nullable
                                            KafkaSenderObservationConvention observationConvention)
```
    Configure an ObservationRegistry to observe Kafka record publishing operation.
    
    Parameters:
    
    observationRegistry - ObservationRegistry to use.
    
    observationConvention - the KafkaSenderObservationConvention to use.
    
    Returns:
    
    sender options with updated observationRegistry
    
    Since:
    
    1.3.21
  - observationRegistry
```
@NonNull
io.micrometer.observation.ObservationRegistry observationRegistry()
```
    Return an ObservationRegistry to observe Kafka record publishing operation.
    
    Returns:
    
    the ObservationRegistry.
    
    Since:
    
    1.3.21
  - observationConvention
```
@Nullable
KafkaSenderObservationConvention observationConvention()
```
    Return a KafkaSenderObservationConvention to support a publishing operation observation.
    
    Returns:
    
    the KafkaSenderObservationConvention.
    
    Since:
    
    1.3.21
  - isTransactional
```
@NonNull
default boolean isTransactional()
```
    Senders created from this options will be transactional if a transactional id is configured using ProducerConfig.TRANSACTIONAL_ID_CONFIG. If transactional, KafkaProducer.initTransactions() is invoked on the producer to initialize transactions before any operations are performed on the sender. If scheduler is overridden using scheduler(Scheduler), the configured scheduler must be single-threaded. Otherwise, the behaviour is undefined and may result in unexpected exceptions.
  - clientId
```
@Nullable
default String clientId()
```
    Return the client id provided by the ProducerConfig.
    
    Returns:
    
    the client id
  - transactionalId
```
@Nullable
default String transactionalId()
```
    Returns the configured transactional id
    
    Returns:
    
    transactional id
  - bootstrapServers
```
@NonNull
default String bootstrapServers()
```
    Return the bootstrap servers from the provided ProducerConfig.
    
    Returns:
    
    the bootstrap servers list.
  - fatalException
```
@NonNull
default boolean fatalException(@NonNull
                                        Throwable t)
```

Interface SenderOptions<K,V>

Nested Class Summary

Method Summary

Method Detail

create

create

create

producerProperties

producerProperty

producerProperty

keySerializer

withKeySerializer

valueSerializer

withValueSerializer

scheduler

scheduler

maxInFlight

maxInFlight

stopOnError

stopOnError

closeTimeout

closeTimeout

producerListener

producerListener

withObservation

withObservation

observationRegistry

observationConvention

isTransactional

clientId

transactionalId

bootstrapServers

fatalException