Package org.talend.sdk.component.api.record

Interface Schema.Entry

All Known Implementing Classes:
Schema.Entry
Enclosing interface:
Schema
public static interface Schema.Entry

  • Method Details

    • getName

      String getName()
      Returns:
      The name of this entry.

    • getRawName

      String getRawName()
      Returns:
      The raw name of this entry.

    • getOriginalFieldName

      String getOriginalFieldName()
      Returns:
      the raw name of this entry if exists, else return name.

    • getType

      Schema.Type getType()
      Returns:
      Type of the entry, this determine which other fields are populated.

    • isNullable

      boolean isNullable()
      Returns:
      Is this entry nullable or always valued.

    • isMetadata

      boolean isMetadata()
      Returns:
      true if this entry is for metadata; false for ordinary data.

    • getDefaultValue

      <T> T getDefaultValue()
      Type Parameters:
      T - the default value type.
      Returns:
      Default value for this entry.

    • getElementSchema

      Schema getElementSchema()
      Returns:
      For type == record, the element type.

    • getComment

      String getComment()
      Returns:
      Allows to associate to this field a comment - for doc purposes, no use in the runtime.

    • getProps

      Map<String,String> getProps()
      Returns:
      the metadata props

    • getProp

      String getProp(String property)
      Parameters:
      property - : property name.
      Returns:
      the requested metadata prop

    • getJsonProp

      default javax.json.JsonValue getJsonProp(String name)
      Get a property values from entry with its name.
      Parameters:
      name - : property's name.
      Returns:
      property's value.

    • getLogicalType

      default String getLogicalType()
      Returns:
      the logical type property

    • toBuilder

      default Schema.Entry.Builder toBuilder()
      Returns:
      an Schema.Entry.Builder from this entry.