SenderOptions (Reactor Kafka 1.0.0.RELEASE)

java.lang.Object
- reactor.kafka.sender.SenderOptions<K,V>

```
public class SenderOptions<K,V>
extends Object
```
Configuration properties for reactive Kafka KafkaSender and its underlying Kafka Producer.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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`.
`boolean`	`fatalException(Throwable t)`
`boolean`	`isTransactional()` Senders created from this options will be transactional if a transactional id is configured using `ProducerConfig.TRANSACTIONAL_ID_CONFIG`.
`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.
`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)`.
`SenderOptions<K,V>`	`toImmutable()` Returns a new immutable instance with the configuration properties of this instance.
`String`	`transactionalId()` Returns the configured transactional id

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static <K,V> SenderOptions<K,V> create()
```
    Creates a sender options instance with default properties.
    
    Returns:
    
    new instance of sender options
  - create
```
public 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.
    
    Returns:
    
    new instance of sender options
  - create
```
public static <K,V> SenderOptions<K,V> create(Properties configProperties)
```
    Creates a sender options instance with the specified config overrides for the underlying Kafka Producer.
    
    Returns:
    
    new instance of sender options
  - producerProperties
```
public Map<String,Object> producerProperties()
```
    Returns the configuration properties for the underlying Kafka Producer.
    
    Returns:
    
    configuration options for Kafka producer
  - producerProperty
```
public Object producerProperty(String name)
```
    Returns the Kafka Producer configuration property value for the specified option name.
    
    Returns:
    
    Kafka producer configuration option value
  - producerProperty
```
public SenderOptions<K,V> producerProperty(String name,
                                           Object value)
```
    Sets Kafka Producer configuration property to the specified value.
    
    Returns:
    
    sender options with updated Kafka producer option
  - scheduler
```
public Scheduler scheduler()
```
    Returns the scheduler used for publishing send results.
    
    Returns:
    
    response scheduler
  - scheduler
```
public SenderOptions<K,V> scheduler(Scheduler scheduler)
```
    Sets the scheduler used for publishing send results.
    
    Returns:
    
    sender options with updated response scheduler
  - maxInFlight
```
public 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
```
public 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. 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
```
public 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
```
public SenderOptions<K,V> stopOnError(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
```
public Duration closeTimeout()
```
    Returns the timeout for graceful shutdown of this sender.
    
    Returns:
    
    close timeout duration
  - closeTimeout
```
public SenderOptions<K,V> closeTimeout(Duration timeout)
```
    Configures the timeout for graceful shutdown of this sender.
    
    Returns:
    
    sender options with updated close timeout
  - isTransactional
```
public 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(reactor.core.scheduler.Scheduler), the configured scheduler must be single-threaded. Otherwise, the behaviour is undefined and may result in unexpected exceptions.
  - transactionalId
```
public String transactionalId()
```
    Returns the configured transactional id
    
    Returns:
    
    transactional id
  - fatalException
```
public boolean fatalException(Throwable t)
```
  - toImmutable
```
public SenderOptions<K,V> toImmutable()
```
    Returns a new immutable instance with the configuration properties of this instance.
    
    Returns:
    
    new immutable instance of sender options

Class SenderOptions<K,V>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

create

create

producerProperties

producerProperty

producerProperty

scheduler

scheduler

maxInFlight

maxInFlight

stopOnError

stopOnError

closeTimeout

closeTimeout

isTransactional

transactionalId

fatalException

toImmutable