Package io.github.kaststream.api

Interface Filter

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default void close()
      Tear-down method for the user code.
      boolean filter​(org.apache.flink.types.Row row)
      The filter function that evaluates the predicate.
      org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row> getProducedType​(org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row> typeInfo)
      Declare the data type information of the data produced by your function.
      default void open​(org.apache.flink.configuration.Configuration configuration, org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row> typeInfo)
      Initialization method for the function.

    • Method Detail

      • filter

        boolean filter​(org.apache.flink.types.Row row)
        throws Exception
        The filter function that evaluates the predicate.

        IMPORTANT: The system assumes that the function does not modify the elements on which the predicate is applied. Violating this assumption can lead to incorrect results.

        Parameters:
        row - The value to be filtered.
        Returns:
        True for values that should be retained, false for values to be filtered out.
        Throws:
        Exception - This method may throw exceptions. Throwing an exception will cause the operation to fail and may trigger recovery.

      • getProducedType

        org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row> getProducedType​(org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row> typeInfo)
        Declare the data type information of the data produced by your function.
        Parameters:
        typeInfo - the input row type information
        Returns:
        the produced data typeInfo

      • open

        default void open​(org.apache.flink.configuration.Configuration configuration,
                  org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row> typeInfo)
           throws Exception
        Initialization method for the function.
        Parameters:
        configuration - The configuration containing the parameters attached to the contract
        typeInfo - the input row type information
        Throws:
        Exception - The function may throw exceptions which cause the streaming program to fail and go into recovery.

      • close

        default void close()
            throws Exception
        Tear-down method for the user code. It is called after the last call to the main working methods. For functions that are part of an iteration, this method will be invoked after each iteration superstep.

        This method can be used for clean up work.

        Throws:
        Exception - The function may throw exceptions which cause the streaming program to fail and go into recovery.