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

Enum Class KafkaPlaceholderProperty

java.lang.Object
java.lang.Enum<KafkaPlaceholderProperty>
org.odpi.openmetadata.adapters.connectors.apachekafka.control.KafkaPlaceholderProperty
All Implemented Interfaces:
Serializable, Comparable<KafkaPlaceholderProperty>, Constable
public enum KafkaPlaceholderProperty extends Enum<KafkaPlaceholderProperty>
PlaceholderProperty provides some standard definitions for placeholder properties used to pass properties to services that use templates.

  • Enum Constant Details

    • FULL_TOPIC_NAME

      public static final KafkaPlaceholderProperty FULL_TOPIC_NAME
      The full name of the topic.

    • SHORT_TOPIC_NAME

      public static final KafkaPlaceholderProperty SHORT_TOPIC_NAME
      The display name of the topic.

    • EVENT_DIRECTION

      public static final KafkaPlaceholderProperty EVENT_DIRECTION
      By default, this connector supports both the receiving and sending of events on a particular topic. It is possible to turn off, either the ability to listen for events through the consumer, or send events through the producer. This is achieved by setting the eventDirection configuration property, which can be 'inOut' (default value), 'outOnly' or 'inOnly'.

  • Field Details

    • name

      public final String name

    • description

      public final String description

    • dataType

      public final String dataType

    • example

      public final String example

  • Method Details

    • values

      public static KafkaPlaceholderProperty[] 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 KafkaPlaceholderProperty 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 placeholder property.
      Returns:
      string name

    • getPlaceholder

      public String getPlaceholder()
      Return the placeholder to use when building templates.
      Returns:
      placeholder property

    • getDescription

      public String getDescription()
      Return the description of the placeholder property.
      Returns:
      text

    • getDataType

      public String getDataType()
      Return the data type for the placeholder property.
      Returns:
      data type name

    • getExample

      public String getExample()
      Return an example of the placeholder property to help users understand how to set it up.
      Returns:
      example

    • getKafkaServerPlaceholderPropertyTypes

      public static List<PlaceholderPropertyType> getKafkaServerPlaceholderPropertyTypes()
      Retrieve the Kafka Server defined placeholder properties
      Returns:
      list of placeholder property types

    • getKafkaTopicPlaceholderPropertyTypes

      public static List<PlaceholderPropertyType> getKafkaTopicPlaceholderPropertyTypes()
      Retrieve the Kafka Topic defined placeholder properties
      Returns:
      list of placeholder property types

    • getPlaceholderType

      public PlaceholderPropertyType getPlaceholderType()
      Return a summary of this enum to use in a service provider.
      Returns:
      placeholder property type

    • toString

      public String toString()
      Output of this enum class and main value.
      Overrides:
      toString in class Enum<KafkaPlaceholderProperty>
      Returns:
      string showing enum value