org.apache.flink.fnexecution.v1

Class FlinkFnApi.UserDefinedFunction.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<FlinkFnApi.UserDefinedFunction.Builder>

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

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, FlinkFnApi.UserDefinedFunctionOrBuilder

Enclosing class:

FlinkFnApi.UserDefinedFunction

public static final class FlinkFnApi.UserDefinedFunction.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<FlinkFnApi.UserDefinedFunction.Builder>
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

Method Summary

Modifier and Type	Method and Description
FlinkFnApi.UserDefinedFunction.Builder	addAllInputs(Iterable<? extends FlinkFnApi.Input> values) The input arguments of the user-defined function, it could be one of the following: 1.
FlinkFnApi.UserDefinedFunction.Builder	addInputs(FlinkFnApi.Input.Builder builderForValue) The input arguments of the user-defined function, it could be one of the following: 1.
FlinkFnApi.UserDefinedFunction.Builder	addInputs(FlinkFnApi.Input value) The input arguments of the user-defined function, it could be one of the following: 1.
FlinkFnApi.UserDefinedFunction.Builder	addInputs(int index, FlinkFnApi.Input.Builder builderForValue) The input arguments of the user-defined function, it could be one of the following: 1.
FlinkFnApi.UserDefinedFunction.Builder	addInputs(int index, FlinkFnApi.Input value) The input arguments of the user-defined function, it could be one of the following: 1.
FlinkFnApi.Input.Builder	addInputsBuilder() The input arguments of the user-defined function, it could be one of the following: 1.
FlinkFnApi.Input.Builder	addInputsBuilder(int index) The input arguments of the user-defined function, it could be one of the following: 1.
FlinkFnApi.UserDefinedFunction.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
FlinkFnApi.UserDefinedFunction	build()
FlinkFnApi.UserDefinedFunction	buildPartial()
FlinkFnApi.UserDefinedFunction.Builder	clear()
FlinkFnApi.UserDefinedFunction.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
FlinkFnApi.UserDefinedFunction.Builder	clearInputs() The input arguments of the user-defined function, it could be one of the following: 1.
FlinkFnApi.UserDefinedFunction.Builder	clearIsPandasUdf() Whether it's pandas UDF
FlinkFnApi.UserDefinedFunction.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
FlinkFnApi.UserDefinedFunction.Builder	clearPayload() The serialized representation of the user-defined function
FlinkFnApi.UserDefinedFunction.Builder	clearTakesRowAsInput() Whether the UDF takes row as input instead of each columns of a row
FlinkFnApi.UserDefinedFunction.Builder	clearWindowIndex() The index of the over window used in pandas batch over window aggregation
FlinkFnApi.UserDefinedFunction.Builder	clone()
FlinkFnApi.UserDefinedFunction	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
FlinkFnApi.Input	getInputs(int index) The input arguments of the user-defined function, it could be one of the following: 1.
FlinkFnApi.Input.Builder	getInputsBuilder(int index) The input arguments of the user-defined function, it could be one of the following: 1.
List<FlinkFnApi.Input.Builder>	getInputsBuilderList() 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
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
FlinkFnApi.UserDefinedFunction.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
FlinkFnApi.UserDefinedFunction.Builder	mergeFrom(FlinkFnApi.UserDefinedFunction other)
FlinkFnApi.UserDefinedFunction.Builder	mergeFrom(com.google.protobuf.Message other)
FlinkFnApi.UserDefinedFunction.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
FlinkFnApi.UserDefinedFunction.Builder	removeInputs(int index) The input arguments of the user-defined function, it could be one of the following: 1.
FlinkFnApi.UserDefinedFunction.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
FlinkFnApi.UserDefinedFunction.Builder	setInputs(int index, FlinkFnApi.Input.Builder builderForValue) The input arguments of the user-defined function, it could be one of the following: 1.
FlinkFnApi.UserDefinedFunction.Builder	setInputs(int index, FlinkFnApi.Input value) The input arguments of the user-defined function, it could be one of the following: 1.
FlinkFnApi.UserDefinedFunction.Builder	setIsPandasUdf(boolean value) Whether it's pandas UDF
FlinkFnApi.UserDefinedFunction.Builder	setPayload(com.google.protobuf.ByteString value) The serialized representation of the user-defined function
FlinkFnApi.UserDefinedFunction.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
FlinkFnApi.UserDefinedFunction.Builder	setTakesRowAsInput(boolean value) Whether the UDF takes row as input instead of each columns of a row
FlinkFnApi.UserDefinedFunction.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
FlinkFnApi.UserDefinedFunction.Builder	setWindowIndex(int value) The index of the over window used in pandas batch over window aggregation

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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.Builder<FlinkFnApi.UserDefinedFunction.Builder>

clear

public FlinkFnApi.UserDefinedFunction.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<FlinkFnApi.UserDefinedFunction.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<FlinkFnApi.UserDefinedFunction.Builder>

getDefaultInstanceForType

public FlinkFnApi.UserDefinedFunction getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public FlinkFnApi.UserDefinedFunction build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public FlinkFnApi.UserDefinedFunction buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public FlinkFnApi.UserDefinedFunction.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<FlinkFnApi.UserDefinedFunction.Builder>

setField

public FlinkFnApi.UserDefinedFunction.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<FlinkFnApi.UserDefinedFunction.Builder>

clearField

public FlinkFnApi.UserDefinedFunction.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<FlinkFnApi.UserDefinedFunction.Builder>

clearOneof

public FlinkFnApi.UserDefinedFunction.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<FlinkFnApi.UserDefinedFunction.Builder>

setRepeatedField

public FlinkFnApi.UserDefinedFunction.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                               int index,
                                                               Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FlinkFnApi.UserDefinedFunction.Builder>

addRepeatedField

public FlinkFnApi.UserDefinedFunction.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                               Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FlinkFnApi.UserDefinedFunction.Builder>

mergeFrom

public FlinkFnApi.UserDefinedFunction.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FlinkFnApi.UserDefinedFunction.Builder>

mergeFrom

public FlinkFnApi.UserDefinedFunction.Builder mergeFrom(FlinkFnApi.UserDefinedFunction other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FlinkFnApi.UserDefinedFunction.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FlinkFnApi.UserDefinedFunction.Builder>

Throws:

IOException

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.

setPayload

public FlinkFnApi.UserDefinedFunction.Builder setPayload(com.google.protobuf.ByteString value)

 The serialized representation of the user-defined function
 

bytes payload = 1;

Parameters:

value - The payload to set.

Returns:

This builder for chaining.

clearPayload

public FlinkFnApi.UserDefinedFunction.Builder clearPayload()

 The serialized representation of the user-defined function
 

bytes payload = 1;

Returns:

This builder for chaining.

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

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

setInputs

public FlinkFnApi.UserDefinedFunction.Builder setInputs(int index,
                                                        FlinkFnApi.Input value)

 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;

setInputs

public FlinkFnApi.UserDefinedFunction.Builder setInputs(int index,
                                                        FlinkFnApi.Input.Builder builderForValue)

 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;

addInputs

public FlinkFnApi.UserDefinedFunction.Builder addInputs(FlinkFnApi.Input value)

 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;

addInputs

public FlinkFnApi.UserDefinedFunction.Builder addInputs(int index,
                                                        FlinkFnApi.Input value)

 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;

addInputs

public FlinkFnApi.UserDefinedFunction.Builder addInputs(FlinkFnApi.Input.Builder builderForValue)

 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;

addInputs

public FlinkFnApi.UserDefinedFunction.Builder addInputs(int index,
                                                        FlinkFnApi.Input.Builder builderForValue)

 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;

addAllInputs

public FlinkFnApi.UserDefinedFunction.Builder addAllInputs(Iterable<? extends FlinkFnApi.Input> values)

 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;

clearInputs

public FlinkFnApi.UserDefinedFunction.Builder clearInputs()

 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;

removeInputs

public FlinkFnApi.UserDefinedFunction.Builder removeInputs(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;

getInputsBuilder

public FlinkFnApi.Input.Builder getInputsBuilder(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;

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

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

addInputsBuilder

public FlinkFnApi.Input.Builder addInputsBuilder()

 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;

addInputsBuilder

public FlinkFnApi.Input.Builder addInputsBuilder(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;

getInputsBuilderList

public List<FlinkFnApi.Input.Builder> getInputsBuilderList()

 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

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.

setWindowIndex

public FlinkFnApi.UserDefinedFunction.Builder setWindowIndex(int value)

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

int32 window_index = 3;

Parameters:

value - The windowIndex to set.

Returns:

This builder for chaining.

clearWindowIndex

public FlinkFnApi.UserDefinedFunction.Builder clearWindowIndex()

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

int32 window_index = 3;

Returns:

This builder for chaining.

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.

setTakesRowAsInput

public FlinkFnApi.UserDefinedFunction.Builder setTakesRowAsInput(boolean value)

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

bool takes_row_as_input = 4;

Parameters:

value - The takesRowAsInput to set.

Returns:

This builder for chaining.

clearTakesRowAsInput

public FlinkFnApi.UserDefinedFunction.Builder clearTakesRowAsInput()

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

bool takes_row_as_input = 4;

Returns:

This builder for chaining.

getIsPandasUdf

public boolean getIsPandasUdf()

 Whether it's pandas UDF
 

bool is_pandas_udf = 5;

Specified by:

getIsPandasUdf in interface FlinkFnApi.UserDefinedFunctionOrBuilder

Returns:

The isPandasUdf.

setIsPandasUdf

public FlinkFnApi.UserDefinedFunction.Builder setIsPandasUdf(boolean value)

 Whether it's pandas UDF
 

bool is_pandas_udf = 5;

Parameters:

value - The isPandasUdf to set.

Returns:

This builder for chaining.

clearIsPandasUdf

public FlinkFnApi.UserDefinedFunction.Builder clearIsPandasUdf()

 Whether it's pandas UDF
 

bool is_pandas_udf = 5;

Returns:

This builder for chaining.

setUnknownFields

public final FlinkFnApi.UserDefinedFunction.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FlinkFnApi.UserDefinedFunction.Builder>

mergeUnknownFields

public final FlinkFnApi.UserDefinedFunction.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FlinkFnApi.UserDefinedFunction.Builder>