Package org.odpi.openmetadata.adapters.connectors.apachekafka.control

Enum Class KafkaTemplateConfigurationProperty

java.lang.Object

java.lang.Enum<KafkaTemplateConfigurationProperty>

org.odpi.openmetadata.adapters.connectors.apachekafka.control.KafkaTemplateConfigurationProperty

All Implemented Interfaces:

Serializable, Comparable<KafkaTemplateConfigurationProperty>, Constable

public enum KafkaTemplateConfigurationProperty
extends Enum<KafkaTemplateConfigurationProperty>

KafkaTemplateConfigurationProperty provides definitions for the configuration properties used with the Kafka Integration Connector.

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
TEMPLATE_NAME	The property of the template to use when creating Kafka Topic assets.

Field Summary

Fields

Modifier and Type	Field	Description
final String	dataType
final String	description
final String	example
final boolean	isRequired
final String	name

Method Summary

Modifier and Type	Method	Description
ConfigurationPropertyType	getConfigurationPropertyType()	Return a summary of this enum to use in a connector provider.
static List<ConfigurationPropertyType>	getConfigurationPropertyTypes()	Retrieve all the defined configuration properties
String	getDataType()	Return the data type for the configuration property.
String	getDescription()	Return the description of the configuration property.
String	getExample()	Return an example of the configuration property to help users understand how to set it up.
String	getName()	Return the name of the request parameter.
static List<String>	getRecognizedConfigurationProperties()	Retrieve all the defined configuration property names
boolean	isRequired()	Return whether this value is required.
String	toString()	Output of this enum class and main value.
static KafkaTemplateConfigurationProperty	valueOf(String name)	Returns the enum constant of this class with the specified name.
static KafkaTemplateConfigurationProperty[]	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

Enum Constant Details

TEMPLATE_NAME

public static final KafkaTemplateConfigurationProperty TEMPLATE_NAME

The property of the template to use when creating Kafka Topic assets.

Field Details

name

public final String name

description

public final String description

dataType

public final String dataType

example

public final String example

isRequired

public final boolean isRequired

Method Details

values

public static KafkaTemplateConfigurationProperty[] 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 KafkaTemplateConfigurationProperty 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 request parameter.

Returns:

string name

getDescription

public String getDescription()

Return the description of the configuration property.

Returns:

text

getDataType

public String getDataType()

Return the data type for the configuration property.

Returns:

data type name

getExample

public String getExample()

Return an example of the configuration property to help users understand how to set it up.

Returns:

example

isRequired

public boolean isRequired()

Return whether this value is required.

Returns:

boolean

getConfigurationPropertyTypes

public static List<ConfigurationPropertyType> getConfigurationPropertyTypes()

Retrieve all the defined configuration properties

Returns:

list of configuration property types

getRecognizedConfigurationProperties

public static List<String> getRecognizedConfigurationProperties()

Retrieve all the defined configuration property names

Returns:

list of configuration property types

getConfigurationPropertyType

public ConfigurationPropertyType getConfigurationPropertyType()

Return a summary of this enum to use in a connector provider.

Returns:

request parameter type

toString

public String toString()

Output of this enum class and main value.

Overrides:

toString in class Enum<KafkaTemplateConfigurationProperty>

Returns:

string showing enum value