org.apache.kafka.streams.errors

Class StreamsException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.kafka.common.KafkaException

org.apache.kafka.streams.errors.StreamsException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BrokerNotFoundException, InvalidStateStoreException, LockException, MissingSourceTopicException, ProcessorStateException, TaskAssignmentException, TaskCorruptedException, TaskIdFormatException, TaskMigratedException, TopologyException, UnknownTopologyException

public class StreamsException
extends org.apache.kafka.common.KafkaException

StreamsException is the top-level exception type generated by Kafka Streams, and indicates errors have occurred during a StreamThread's processing. It is guaranteed that any exception thrown up to the StreamsUncaughtExceptionHandler will be of the type StreamsException. For example, any user exceptions will be wrapped as a StreamsException.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StreamsException(String message)
StreamsException(String message, TaskId taskId)
StreamsException(String message, Throwable throwable)
StreamsException(String message, Throwable throwable, TaskId taskId)
StreamsException(Throwable throwable)
StreamsException(Throwable throwable, TaskId taskId)

Method Summary

Modifier and Type	Method and Description
void	setTaskId(TaskId taskId)
Optional<TaskId>	taskId()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StreamsException

public StreamsException(String message)

StreamsException

public StreamsException(String message,
                        TaskId taskId)

StreamsException

public StreamsException(String message,
                        Throwable throwable)

StreamsException

public StreamsException(String message,
                        Throwable throwable,
                        TaskId taskId)

StreamsException

public StreamsException(Throwable throwable)

StreamsException

public StreamsException(Throwable throwable,
                        TaskId taskId)

Method Detail

taskId

public Optional<TaskId> taskId()

Returns:

the TaskId that this exception originated from, or Optional.empty() if the exception cannot be traced back to a particular task. Note that the TaskId being empty does not guarantee that the exception wasn't directly related to a specific task.

setTaskId

public void setTaskId(TaskId taskId)