Enum Class StreamsGroupTopologyDescriptionStatus

java.lang.Object

java.lang.Enum<StreamsGroupTopologyDescriptionStatus>

org.apache.kafka.clients.admin.StreamsGroupTopologyDescriptionStatus

All Implemented Interfaces:

Serializable, Comparable<StreamsGroupTopologyDescriptionStatus>, Constable

@Public
@Evolving
public enum StreamsGroupTopologyDescriptionStatus
extends Enum<StreamsGroupTopologyDescriptionStatus>

The status of the topology description that accompanies a StreamsGroupDescription.

The status indicates whether a topology description was requested and, if so, whether one could be retrieved. It is paired with StreamsGroupDescription.topologyDescription(): the description is present if and only if the status is AVAILABLE.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AVAILABLE	The topology description is available and carried in StreamsGroupDescription.topologyDescription().
ERROR	The broker failed to fetch the topology description.
NOT_REQUESTED	The topology description was not requested (the caller did not set DescribeStreamsGroupsOptions.includeTopologyDescription(boolean)).
NOT_STORED	No topology description is recorded for this group, for example because no topology description plugin is configured on the broker or the client has not pushed a description yet.

Method Summary

Modifier and Type	Method	Description
static StreamsGroupTopologyDescriptionStatus	forId(byte id)	Returns the status corresponding to the given wire identifier.
byte	id()	The wire identifier of this status.
static StreamsGroupTopologyDescriptionStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StreamsGroupTopologyDescriptionStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NOT_REQUESTED

public static final StreamsGroupTopologyDescriptionStatus NOT_REQUESTED

The topology description was not requested (the caller did not set DescribeStreamsGroupsOptions.includeTopologyDescription(boolean)).

NOT_STORED

public static final StreamsGroupTopologyDescriptionStatus NOT_STORED

No topology description is recorded for this group, for example because no topology description plugin is configured on the broker or the client has not pushed a description yet.

ERROR

public static final StreamsGroupTopologyDescriptionStatus ERROR

The broker failed to fetch the topology description. See the broker logs for details.

AVAILABLE

public static final StreamsGroupTopologyDescriptionStatus AVAILABLE

The topology description is available and carried in StreamsGroupDescription.topologyDescription().

Method Details

values

public static StreamsGroupTopologyDescriptionStatus[] 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 StreamsGroupTopologyDescriptionStatus 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

id

public byte id()

The wire identifier of this status.

forId

public static StreamsGroupTopologyDescriptionStatus forId(byte id)

Returns the status corresponding to the given wire identifier.

Parameters:

id - the wire identifier.

Returns:

the matching status.

Throws:

IllegalArgumentException - if the identifier is unknown.