Package org.apache.flink.fnexecution.v1

Class FlinkFnApi.UserDefinedFunction

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.apache.flink.fnexecution.v1.FlinkFnApi.UserDefinedFunction

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, FlinkFnApi.UserDefinedFunctionOrBuilder

Enclosing class:

FlinkFnApi

public static final class FlinkFnApi.UserDefinedFunction
extends com.google.protobuf.GeneratedMessageV3
implements FlinkFnApi.UserDefinedFunctionOrBuilder

 User-defined function definition. It supports chaining functions, that's, the execution
 result of one user-defined function as the input of another user-defined function.
 

Protobuf type org.apache.flink.fn_execution.v1.UserDefinedFunction

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FlinkFnApi.UserDefinedFunction.Builder	User-defined function definition.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	INPUTS_FIELD_NUMBER
static int	IS_PANDAS_UDF_FIELD_NUMBER
static int	PAYLOAD_FIELD_NUMBER
static int	TAKES_ROW_AS_INPUT_FIELD_NUMBER
static int	WINDOW_INDEX_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static FlinkFnApi.UserDefinedFunction	getDefaultInstance()
FlinkFnApi.UserDefinedFunction	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.Parser<FlinkFnApi.UserDefinedFunction>	getParserForType()
com.google.protobuf.ByteString	getPayload()	The serialized representation of the user-defined function
int	getSerializedSize()
boolean	getTakesRowAsInput()	Whether the UDF takes row as input instead of each columns of a row
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	getWindowIndex()	The index of the over window used in pandas batch over window aggregation
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static FlinkFnApi.UserDefinedFunction.Builder	newBuilder()
static FlinkFnApi.UserDefinedFunction.Builder	newBuilder(FlinkFnApi.UserDefinedFunction prototype)
FlinkFnApi.UserDefinedFunction.Builder	newBuilderForType()
protected FlinkFnApi.UserDefinedFunction.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static FlinkFnApi.UserDefinedFunction	parseDelimitedFrom(InputStream input)
static FlinkFnApi.UserDefinedFunction	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlinkFnApi.UserDefinedFunction	parseFrom(byte[] data)
static FlinkFnApi.UserDefinedFunction	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlinkFnApi.UserDefinedFunction	parseFrom(com.google.protobuf.ByteString data)
static FlinkFnApi.UserDefinedFunction	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlinkFnApi.UserDefinedFunction	parseFrom(com.google.protobuf.CodedInputStream input)
static FlinkFnApi.UserDefinedFunction	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlinkFnApi.UserDefinedFunction	parseFrom(InputStream input)
static FlinkFnApi.UserDefinedFunction	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlinkFnApi.UserDefinedFunction	parseFrom(ByteBuffer data)
static FlinkFnApi.UserDefinedFunction	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FlinkFnApi.UserDefinedFunction>	parser()
FlinkFnApi.UserDefinedFunction.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Detail

PAYLOAD_FIELD_NUMBER

public static final int PAYLOAD_FIELD_NUMBER

See Also:

Constant Field Values

INPUTS_FIELD_NUMBER

public static final int INPUTS_FIELD_NUMBER

See Also:

Constant Field Values

WINDOW_INDEX_FIELD_NUMBER

public static final int WINDOW_INDEX_FIELD_NUMBER

See Also:

Constant Field Values

TAKES_ROW_AS_INPUT_FIELD_NUMBER

public static final int TAKES_ROW_AS_INPUT_FIELD_NUMBER

See Also:

Constant Field Values

IS_PANDAS_UDF_FIELD_NUMBER

public static final int IS_PANDAS_UDF_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getPayload

public com.google.protobuf.ByteString getPayload()

 The serialized representation of the user-defined function
 

bytes payload = 1;

Specified by:

getPayload in interface FlinkFnApi.UserDefinedFunctionOrBuilder

Returns:

The payload.

getInputsList

public 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;

Specified by:

getInputsList in interface FlinkFnApi.UserDefinedFunctionOrBuilder

getInputsOrBuilderList

public 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;

Specified by:

getInputsOrBuilderList in interface FlinkFnApi.UserDefinedFunctionOrBuilder

getInputsCount

public 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;

Specified by:

getInputsCount in interface FlinkFnApi.UserDefinedFunctionOrBuilder

getInputs

public 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;

Specified by:

getInputs in interface FlinkFnApi.UserDefinedFunctionOrBuilder

getInputsOrBuilder

public 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;

Specified by:

getInputsOrBuilder in interface FlinkFnApi.UserDefinedFunctionOrBuilder

getWindowIndex

public int getWindowIndex()

 The index of the over window used in pandas batch over window aggregation
 

int32 window_index = 3;

Specified by:

getWindowIndex in interface FlinkFnApi.UserDefinedFunctionOrBuilder

Returns:

The windowIndex.

getTakesRowAsInput

public boolean getTakesRowAsInput()

 Whether the UDF takes row as input instead of each columns of a row
 

bool takes_row_as_input = 4;

Specified by:

getTakesRowAsInput in interface FlinkFnApi.UserDefinedFunctionOrBuilder

Returns:

The takesRowAsInput.

getIsPandasUdf

public boolean getIsPandasUdf()

 Whether it's pandas UDF
 

bool is_pandas_udf = 5;

Specified by:

getIsPandasUdf in interface FlinkFnApi.UserDefinedFunctionOrBuilder

Returns:

The isPandasUdf.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static FlinkFnApi.UserDefinedFunction parseFrom(ByteBuffer data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlinkFnApi.UserDefinedFunction parseFrom(ByteBuffer data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlinkFnApi.UserDefinedFunction parseFrom(com.google.protobuf.ByteString data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlinkFnApi.UserDefinedFunction parseFrom(com.google.protobuf.ByteString data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlinkFnApi.UserDefinedFunction parseFrom(byte[] data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlinkFnApi.UserDefinedFunction parseFrom(byte[] data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlinkFnApi.UserDefinedFunction parseFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static FlinkFnApi.UserDefinedFunction parseFrom(InputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static FlinkFnApi.UserDefinedFunction parseDelimitedFrom(InputStream input)
                                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static FlinkFnApi.UserDefinedFunction parseDelimitedFrom(InputStream input,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws IOException

Throws:

IOException

parseFrom

public static FlinkFnApi.UserDefinedFunction parseFrom(com.google.protobuf.CodedInputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static FlinkFnApi.UserDefinedFunction parseFrom(com.google.protobuf.CodedInputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

newBuilderForType

public FlinkFnApi.UserDefinedFunction.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FlinkFnApi.UserDefinedFunction.Builder newBuilder()

newBuilder

public static FlinkFnApi.UserDefinedFunction.Builder newBuilder(FlinkFnApi.UserDefinedFunction prototype)

toBuilder

public FlinkFnApi.UserDefinedFunction.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected FlinkFnApi.UserDefinedFunction.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static FlinkFnApi.UserDefinedFunction getDefaultInstance()

parser

public static com.google.protobuf.Parser<FlinkFnApi.UserDefinedFunction> parser()

getParserForType

public com.google.protobuf.Parser<FlinkFnApi.UserDefinedFunction> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public FlinkFnApi.UserDefinedFunction getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder