Package io.debezium.data

Class Enum

java.lang.Object

io.debezium.data.Enum

public class Enum
extends Object

A semantic type for an enumeration, where the string values are one of the enumeration's values.

Author:

Randall Hauch

Field Summary

Fields

Modifier and Type	Field	Description
static String	LOGICAL_NAME
static String	VALUES_FIELD

Constructor Summary

Constructors

Constructor	Description
Enum()

Method Summary

Modifier and Type	Method	Description
static org.apache.kafka.connect.data.SchemaBuilder	builder(String allowedValues)	Returns a SchemaBuilder for an enumeration.
static org.apache.kafka.connect.data.SchemaBuilder	builder(List<String> allowedValues)	Returns a SchemaBuilder for an enumeration.
static org.apache.kafka.connect.data.Schema	schema(String allowedValues)	Returns a SchemaBuilder for an enumeration, with all other default Schema settings.
static org.apache.kafka.connect.data.Schema	schema(List<String> allowedValues)	Returns a SchemaBuilder for an enumeration, with all other default Schema settings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGICAL_NAME

public static final String LOGICAL_NAME

See Also:

Constant Field Values

VALUES_FIELD

public static final String VALUES_FIELD

See Also:

Constant Field Values

Constructor Detail

Enum

public Enum()

Method Detail

builder

public static org.apache.kafka.connect.data.SchemaBuilder builder(String allowedValues)

Returns a SchemaBuilder for an enumeration. You can use the resulting SchemaBuilder to set additional schema settings such as required/optional, default value, and documentation.

Parameters:

allowedValues - the comma separated list of allowed values; may not be null

Returns:

the schema builder

builder

public static org.apache.kafka.connect.data.SchemaBuilder builder(List<String> allowedValues)

Returns a SchemaBuilder for an enumeration. You can use the resulting SchemaBuilder to set additional schema settings such as required/optional, default value, and documentation.

Parameters:

allowedValues - the list of allowed values; may not be null

Returns:

the schema builder

schema

public static org.apache.kafka.connect.data.Schema schema(String allowedValues)

Returns a SchemaBuilder for an enumeration, with all other default Schema settings.

Parameters:

allowedValues - the comma separated list of allowed values; may not be null

Returns:

the schema

See Also:

builder(String)

schema

public static org.apache.kafka.connect.data.Schema schema(List<String> allowedValues)

Returns a SchemaBuilder for an enumeration, with all other default Schema settings.

Parameters:

allowedValues - the list of allowed values; may not be null

Returns:

the schema

See Also:

builder(String)