Class ProductionExceptionHandler.Response

java.lang.Object

org.apache.kafka.streams.errors.ProductionExceptionHandler.Response

Enclosing interface:

ProductionExceptionHandler

public static class ProductionExceptionHandler.Response
extends Object

Represents the result of handling a production exception.

The Response class encapsulates a ProductionExceptionHandler.Result, indicating whether processing should continue or fail, along with an optional list of ProducerRecord instances to be sent to a dead letter queue.

Method Summary

Modifier and Type	Method	Description
List<ProducerRecord<byte[],byte[]>>	deadLetterQueueRecords()	Retrieves an unmodifiable list of records to be sent to the dead letter queue.
static ProductionExceptionHandler.Response	fail()	Creates a Response indicating that processing should fail.
static ProductionExceptionHandler.Response	fail(List<ProducerRecord<byte[],byte[]>> deadLetterQueueRecords)	Creates a Response indicating that processing should fail.
ProductionExceptionHandler.Result	result()	Retrieves the production exception handler result.
static ProductionExceptionHandler.Response	resume()	Creates a Response indicating that processing should continue.
static ProductionExceptionHandler.Response	resume(List<ProducerRecord<byte[],byte[]>> deadLetterQueueRecords)	Creates a Response indicating that processing should continue.
static ProductionExceptionHandler.Response	retry()	Creates a Response indicating that processing should retry.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

fail

public static ProductionExceptionHandler.Response fail(List<ProducerRecord<byte[],byte[]>> deadLetterQueueRecords)

Creates a Response indicating that processing should fail.

Parameters:

deadLetterQueueRecords - the list of records to be sent to the dead letter queue; may be null.

Returns:

a Response with a ProductionExceptionHandler.Result.FAIL status.

fail

public static ProductionExceptionHandler.Response fail()

Creates a Response indicating that processing should fail.

Returns:

a Response with a ProductionExceptionHandler.Result.FAIL status.

resume

public static ProductionExceptionHandler.Response resume(List<ProducerRecord<byte[],byte[]>> deadLetterQueueRecords)

Creates a Response indicating that processing should continue.

Parameters:

deadLetterQueueRecords - the list of records to be sent to the dead letter queue; may be null.

Returns:

a Response with a ProductionExceptionHandler.Result.RESUME status.

resume

public static ProductionExceptionHandler.Response resume()

Creates a Response indicating that processing should continue.

Returns:

a Response with a ProductionExceptionHandler.Result.RESUME status.

retry

public static ProductionExceptionHandler.Response retry()

Creates a Response indicating that processing should retry.

Returns:

a Response with a ProductionExceptionHandler.Result.RETRY status.

result

public ProductionExceptionHandler.Result result()

Retrieves the production exception handler result.

Returns:

the ProductionExceptionHandler.Result indicating whether processing should continue, fail or retry.

deadLetterQueueRecords

public List<ProducerRecord<byte[],byte[]>> deadLetterQueueRecords()

Retrieves an unmodifiable list of records to be sent to the dead letter queue.

If the list is null, an empty list is returned.

Returns:

an unmodifiable list of ProducerRecord instances for the dead letter queue, or an empty list if no records are available.