org.apache.flink.table.functions.python

Enum BuiltInPythonAggregateFunction

java.lang.Object

java.lang.Enum<BuiltInPythonAggregateFunction>

org.apache.flink.table.functions.python.BuiltInPythonAggregateFunction

All Implemented Interfaces:

Serializable, Comparable<BuiltInPythonAggregateFunction>, PythonFunction

@Internal
public enum BuiltInPythonAggregateFunction
extends Enum<BuiltInPythonAggregateFunction>
implements PythonFunction

The list of the built-in aggregate functions which can be mixed with the Python UDAF.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVG
COUNT
COUNT1
DECIMAL_SUM0
FIRST_VALUE
FIRST_VALUE_RETRACT
FLOAT_SUM0
INT_SUM0
LAST_VALUE
LAST_VALUE_RETRACT
LIST_AGG
LIST_AGG_RETRACT
LIST_AGG_WS_RETRACT
MAX
MAX_RETRACT
MIN
MIN_RETRACT
SUM
SUM_RETRACT

Method Summary

Modifier and Type	Method and Description
PythonEnv	getPythonEnv() Returns the Python execution environment.
byte[]	getSerializedPythonFunction() Returns the serialized representation of the user-defined python function.
static BuiltInPythonAggregateFunction	valueOf(String name) Returns the enum constant of this type with the specified name.
static BuiltInPythonAggregateFunction[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.flink.table.functions.python.PythonFunction

getPythonFunctionKind, takesRowAsInput

Enum Constant Detail

AVG

public static final BuiltInPythonAggregateFunction AVG

COUNT1

public static final BuiltInPythonAggregateFunction COUNT1

COUNT

public static final BuiltInPythonAggregateFunction COUNT

FIRST_VALUE

public static final BuiltInPythonAggregateFunction FIRST_VALUE

FIRST_VALUE_RETRACT

public static final BuiltInPythonAggregateFunction FIRST_VALUE_RETRACT

LAST_VALUE

public static final BuiltInPythonAggregateFunction LAST_VALUE

LAST_VALUE_RETRACT

public static final BuiltInPythonAggregateFunction LAST_VALUE_RETRACT

LIST_AGG

public static final BuiltInPythonAggregateFunction LIST_AGG

LIST_AGG_RETRACT

public static final BuiltInPythonAggregateFunction LIST_AGG_RETRACT

LIST_AGG_WS_RETRACT

public static final BuiltInPythonAggregateFunction LIST_AGG_WS_RETRACT

MAX

public static final BuiltInPythonAggregateFunction MAX

MAX_RETRACT

public static final BuiltInPythonAggregateFunction MAX_RETRACT

MIN

public static final BuiltInPythonAggregateFunction MIN

MIN_RETRACT

public static final BuiltInPythonAggregateFunction MIN_RETRACT

INT_SUM0

public static final BuiltInPythonAggregateFunction INT_SUM0

FLOAT_SUM0

public static final BuiltInPythonAggregateFunction FLOAT_SUM0

DECIMAL_SUM0

public static final BuiltInPythonAggregateFunction DECIMAL_SUM0

SUM

public static final BuiltInPythonAggregateFunction SUM

SUM_RETRACT

public static final BuiltInPythonAggregateFunction SUM_RETRACT

Method Detail

values

public static BuiltInPythonAggregateFunction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BuiltInPythonAggregateFunction c : BuiltInPythonAggregateFunction.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BuiltInPythonAggregateFunction valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getSerializedPythonFunction

public byte[] getSerializedPythonFunction()

Description copied from interface: PythonFunction

Returns the serialized representation of the user-defined python function.

Specified by:

getSerializedPythonFunction in interface PythonFunction

getPythonEnv

public PythonEnv getPythonEnv()

Description copied from interface: PythonFunction

Returns the Python execution environment.

Specified by:

getPythonEnv in interface PythonFunction