Package org.apache.flink.fnexecution.v1

Interface FlinkFnApi.UserDefinedFunctionOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      FlinkFnApi.Input getInputs​(int index)
      The input arguments of the user-defined function, it could be one of the following: 1.
      int getInputsCount()
      The input arguments of the user-defined function, it could be one of the following: 1.
      List<FlinkFnApi.Input> getInputsList()
      The input arguments of the user-defined function, it could be one of the following: 1.
      FlinkFnApi.InputOrBuilder getInputsOrBuilder​(int index)
      The input arguments of the user-defined function, it could be one of the following: 1.
      List<? extends FlinkFnApi.InputOrBuilder> getInputsOrBuilderList()
      The input arguments of the user-defined function, it could be one of the following: 1.
      boolean getIsPandasUdf()
      Whether it's pandas UDF
      com.google.protobuf.ByteString getPayload()
      The serialized representation of the user-defined function
      boolean getTakesRowAsInput()
      Whether the UDF takes row as input instead of each columns of a row
      int getWindowIndex()
      The index of the over window used in pandas batch over window aggregation

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getPayload

        com.google.protobuf.ByteString getPayload()
         The serialized representation of the user-defined function
        bytes payload = 1;
        Returns:
        The payload.

      • getInputsList

        List<FlinkFnApi.Input> getInputsList()
         The input arguments of the user-defined function, it could be one of the following:
 1. A column from the input row
 2. The result of another user-defined function
 3. The constant value of the column
        repeated .org.apache.flink.fn_execution.v1.Input inputs = 2;

      • getInputs

        FlinkFnApi.Input getInputs​(int index)
         The input arguments of the user-defined function, it could be one of the following:
 1. A column from the input row
 2. The result of another user-defined function
 3. The constant value of the column
        repeated .org.apache.flink.fn_execution.v1.Input inputs = 2;

      • getInputsCount

        int getInputsCount()
         The input arguments of the user-defined function, it could be one of the following:
 1. A column from the input row
 2. The result of another user-defined function
 3. The constant value of the column
        repeated .org.apache.flink.fn_execution.v1.Input inputs = 2;

      • getInputsOrBuilderList

        List<? extends FlinkFnApi.InputOrBuilder> getInputsOrBuilderList()
         The input arguments of the user-defined function, it could be one of the following:
 1. A column from the input row
 2. The result of another user-defined function
 3. The constant value of the column
        repeated .org.apache.flink.fn_execution.v1.Input inputs = 2;

      • getInputsOrBuilder

        FlinkFnApi.InputOrBuilder getInputsOrBuilder​(int index)
         The input arguments of the user-defined function, it could be one of the following:
 1. A column from the input row
 2. The result of another user-defined function
 3. The constant value of the column
        repeated .org.apache.flink.fn_execution.v1.Input inputs = 2;

      • getWindowIndex

        int getWindowIndex()
         The index of the over window used in pandas batch over window aggregation
        int32 window_index = 3;
        Returns:
        The windowIndex.

      • getTakesRowAsInput

        boolean getTakesRowAsInput()
         Whether the UDF takes row as input instead of each columns of a row
        bool takes_row_as_input = 4;
        Returns:
        The takesRowAsInput.

      • getIsPandasUdf

        boolean getIsPandasUdf()
         Whether it's pandas UDF
        bool is_pandas_udf = 5;
        Returns:
        The isPandasUdf.