Package io.debezium.operator.docs.model

Record Class Documentation.FieldDescription

java.lang.Object
java.lang.Record
io.debezium.operator.docs.model.Documentation.FieldDescription
Enclosing class:
Documentation
public static record Documentation.FieldDescription(String name, String type, String typeRef, String externalTypeRef, String defaultValue, String description) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final String
    defaultValue
    The field for the defaultValue record component.
    private final String
    description
    The field for the description record component.
    private final String
    externalTypeRef
    The field for the externalTypeRef record component.
    private final String
    name
    The field for the name record component.
    private final String
    type
    The field for the type record component.
    private final String
    typeRef
    The field for the typeRef record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FieldDescription(String name, String type, String typeRef, String externalTypeRef, String defaultValue, String description)
    Creates an instance of a FieldDescription record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    defaultValue()
    Returns the value of the defaultValue record component.
    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.
    String
    externalTypeRef()
    Returns the value of the externalTypeRef 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
    type()
    Returns the value of the type record component.
    String
    typeRef()
    Returns the value of the typeRef 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.

    • type

      private final String type
      The field for the type record component.

    • typeRef

      private final String typeRef
      The field for the typeRef record component.

    • externalTypeRef

      private final String externalTypeRef
      The field for the externalTypeRef record component.

    • defaultValue

      private final String defaultValue
      The field for the defaultValue record component.

    • description

      private final String description
      The field for the description record component.

  • Constructor Details

    • FieldDescription

      public FieldDescription(String name, String type, String typeRef, String externalTypeRef, String defaultValue, String description)
      Creates an instance of a FieldDescription record class.
      Parameters:
      name - the value for the name record component
      type - the value for the type record component
      typeRef - the value for the typeRef record component
      externalTypeRef - the value for the externalTypeRef record component
      defaultValue - the value for the defaultValue record component
      description - the value for the description 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

    • type

      public String type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • typeRef

      public String typeRef()
      Returns the value of the typeRef record component.
      Returns:
      the value of the typeRef record component

    • externalTypeRef

      public String externalTypeRef()
      Returns the value of the externalTypeRef record component.
      Returns:
      the value of the externalTypeRef record component

    • defaultValue

      public String defaultValue()
      Returns the value of the defaultValue record component.
      Returns:
      the value of the defaultValue record component

    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component