Package io.debezium.openlineage.dataset

Record Class DatasetMetadata.FieldDefinition

java.lang.Object

java.lang.Record

io.debezium.openlineage.dataset.DatasetMetadata.FieldDefinition

Record Components:

name - the name of the field

typeName - the kind name of the field

description - a human-readable description of the field's purpose or content

fields - nested field definitions for complex types (empty for primitive types)

Enclosing class:

DatasetMetadata

public static record DatasetMetadata.FieldDefinition(String name, String typeName, String description, List<DatasetMetadata.FieldDefinition> fields)
extends Record

Represents the definition of a field within a dataset. A field can be simple (primitive kind) or complex (containing nested fields).

Field Summary

Fields

Modifier and Type	Field	Description
private final String	description	The field for the description record component.
private final List<DatasetMetadata.FieldDefinition>	fields	The field for the fields record component.
private final String	name	The field for the name record component.
private final String	typeName	The field for the typeName record component.

Constructor Summary

Constructors

Constructor	Description
FieldDefinition(String name, String typeName, String description)	Convenience constructor for creating a simple field definition without nested fields.
FieldDefinition(String name, String typeName, String description, List<DatasetMetadata.FieldDefinition> fields)	Creates an instance of a FieldDefinition record class.

Method Summary

Modifier and Type	Method	Description
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<DatasetMetadata.FieldDefinition>	fields()	Returns the value of the fields record component.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.
String	typeName()	Returns the value of the typeName record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

name

private final String name

The field for the name record component.

typeName

private final String typeName

The field for the typeName record component.

description

private final String description

The field for the description record component.

fields

private final List<DatasetMetadata.FieldDefinition> fields

The field for the fields record component.

Constructor Details

FieldDefinition

public FieldDefinition(String name,
 String typeName,
 String description)

Convenience constructor for creating a simple field definition without nested fields. This is typically used for primitive types that don't contain sub-fields.

Parameters:

name - the name of the field

typeName - the kind name of the field

description - a human-readable description of the field

FieldDefinition

public FieldDefinition(String name,
 String typeName,
 String description,
 List<DatasetMetadata.FieldDefinition> fields)

Creates an instance of a FieldDefinition record class.

Parameters:

name - the value for the name record component

typeName - the value for the typeName record component

description - the value for the description record component

fields - the value for the fields record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

typeName

public String typeName()

Returns the value of the typeName record component.

Returns:

the value of the typeName record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

fields

public List<DatasetMetadata.FieldDefinition> fields()

Returns the value of the fields record component.

Returns:

the value of the fields record component