org.springframework.kafka.annotation

Annotation Type PartitionOffset

@Target(value={})
 @Retention(value=RUNTIME)
public @interface PartitionOffset

Used to add partition/initial offset information to a KafkaListener.

Author:

Artem Bilan, Gary Russell

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	initialOffset The initial offset of the partition().
java.lang.String	partition The partition within the topic to listen on.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	relativeToCurrent By default, positive initialOffset() is absolute, negative is relative to the current topic end.

Element Detail

partition

public abstract java.lang.String partition

The partition within the topic to listen on. Property place holders and SpEL expressions are supported, which must resolve to Integer (or String that can be parsed as Integer).

Returns:

partition within the topic.

initialOffset

public abstract java.lang.String initialOffset

The initial offset of the partition(). Property place holders and SpEL expressions are supported, which must resolve to Long (or String that can be parsed as Long).

Returns:

initial offset.

relativeToCurrent

public abstract java.lang.String relativeToCurrent

By default, positive initialOffset() is absolute, negative is relative to the current topic end. When this is 'true', the initial offset (positive or negative) is relative to the current consumer position.

Returns:

whether or not the offset is relative to the current position.

Since:

1.1

Default:

"false"