Package org.odpi.openmetadata.adapters.connectors.apachekafka.survey.controls

Enum Class KafkaMetric

java.lang.Object

java.lang.Enum<KafkaMetric>

org.odpi.openmetadata.adapters.connectors.apachekafka.survey.controls.KafkaMetric

All Implemented Interfaces:

Serializable, Comparable<KafkaMetric>, Constable

public enum KafkaMetric
extends Enum<KafkaMetric>

KafkaMetric describes the metrics from Apache Kafka that are captured by the Apache Kafka Survey Action Service.

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Field Summary

Fields

Modifier and Type	Field	Description
final String	description
final String	name

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the description of the metric.
String	getName()	Return the name of the metric.
String	toString()	Output of this enum class and main value.
static KafkaMetric	valueOf(String name)	Returns the enum constant of this class with the specified name.
static KafkaMetric[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

name

public final String name

description

public final String description

Method Details

values

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

getName

public String getName()

Return the name of the metric.

Returns:

string name

getDescription

public String getDescription()

Return the description of the metric.

Returns:

text

toString

public String toString()

Output of this enum class and main value.

Overrides:

toString in class Enum<KafkaMetric>

Returns:

string showing enum value