Package io.confluent.parallelconsumer.internal

Enum Class State

java.lang.Object

java.lang.Enum<State>

io.confluent.parallelconsumer.internal.State

All Implemented Interfaces:

Serializable, Comparable<State>, Constable

public enum State
extends Enum<State>

The run state of the controller.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
closed
closing
draining	When draining, the system will stop polling for more records, but will attempt to process all already downloaded records.
paused	When paused, the system will stop submitting work to the processing pool.
running
unused

Method Summary

Modifier and Type	Method	Description
static State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static State[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

unused

public static final State unused

running

public static final State running

paused

public static final State paused

When paused, the system will stop submitting work to the processing pool. Polling for new work however may continue until internal buffers have been filled sufficiently and the auto-throttling takes effect. In flight work will not be affected by transitioning to this state (i.e. processing will finish without any interrupts being sent).

draining

public static final State draining

When draining, the system will stop polling for more records, but will attempt to process all already downloaded records. Note that if you choose to close without draining, records already processed will still be committed first before closing.

closing

public static final State closing

closed

public static final State closed

Method Details

values

public static State[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static State valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null