Package org.apache.flink.python.util

Enum ProtoUtils

java.lang.Object

java.lang.Enum<ProtoUtils>

org.apache.flink.python.util.ProtoUtils

All Implemented Interfaces:

Serializable, Comparable<ProtoUtils>

@Internal
public enum ProtoUtils
extends Enum<ProtoUtils>

Utilities used to construct protobuf objects or construct objects from protobuf objects.

Method Summary

Modifier and Type	Method	Description
static FlinkFnApi.CoderInfoDescriptor	createArrowTypeCoderInfoDescriptorProto(org.apache.flink.table.types.logical.RowType rowType, FlinkFnApi.CoderInfoDescriptor.Mode mode, boolean separatedWithEndMessage)
static org.apache.beam.model.pipeline.v1.RunnerApi.Coder	createCoderProto(FlinkFnApi.CoderInfoDescriptor coderInfoDescriptor)
static FlinkFnApi.CoderInfoDescriptor	createFlattenRowTypeCoderInfoDescriptorProto(org.apache.flink.table.types.logical.RowType rowType, FlinkFnApi.CoderInfoDescriptor.Mode mode, boolean separatedWithEndMessage)
static FlinkFnApi.CoderInfoDescriptor	createOverWindowArrowTypeCoderInfoDescriptorProto(org.apache.flink.table.types.logical.RowType rowType, FlinkFnApi.CoderInfoDescriptor.Mode mode, boolean separatedWithEndMessage)
static FlinkFnApi.CoderInfoDescriptor	createRawTypeCoderInfoDescriptorProto(org.apache.flink.api.common.typeinfo.TypeInformation<?> typeInformation, FlinkFnApi.CoderInfoDescriptor.Mode mode, boolean separatedWithEndMessage, ClassLoader userCodeClassLoader)
static FlinkFnApi.UserDefinedDataStreamFunction	createReviseOutputDataStreamFunctionProto()
static FlinkFnApi.CoderInfoDescriptor	createRowTypeCoderInfoDescriptorProto(org.apache.flink.table.types.logical.RowType rowType, FlinkFnApi.CoderInfoDescriptor.Mode mode, boolean separatedWithEndMessage)
static FlinkFnApi.UserDefinedAggregateFunction	createUserDefinedAggregateFunctionProto(org.apache.flink.table.functions.python.PythonAggregateFunctionInfo pythonFunctionInfo, org.apache.flink.table.runtime.dataview.DataViewSpec[] dataViewSpecs)
static FlinkFnApi.UserDefinedDataStreamFunction	createUserDefinedDataStreamFunctionProto(DataStreamPythonFunctionInfo dataStreamPythonFunctionInfo, org.apache.flink.api.common.functions.RuntimeContext runtimeContext, Map<String,String> internalParameters, boolean inBatchExecutionMode, boolean isMetricEnabled, boolean isProfileEnabled, boolean hasSideOutput, int stateCacheSize, int mapStateReadCacheSize, int mapStateWriteCacheSize)
static List<FlinkFnApi.UserDefinedDataStreamFunction>	createUserDefinedDataStreamFunctionProtos(DataStreamPythonFunctionInfo dataStreamPythonFunctionInfo, org.apache.flink.api.common.functions.RuntimeContext runtimeContext, Map<String,String> internalParameters, boolean inBatchExecutionMode, boolean isMetricEnabled, boolean isProfileEnabled, boolean hasSideOutput, int stateCacheSize, int mapStateReadCacheSize, int mapStateWriteCacheSize)
static List<FlinkFnApi.UserDefinedDataStreamFunction>	createUserDefinedDataStreamStatefulFunctionProtos(DataStreamPythonFunctionInfo dataStreamPythonFunctionInfo, org.apache.flink.api.common.functions.RuntimeContext runtimeContext, Map<String,String> internalParameters, org.apache.flink.api.common.typeinfo.TypeInformation<?> keyTypeInfo, boolean inBatchExecutionMode, boolean isMetricEnabled, boolean isProfileEnabled, boolean hasSideOutput, int stateCacheSize, int mapStateReadCacheSize, int mapStateWriteCacheSize)
static FlinkFnApi.UserDefinedFunction	createUserDefinedFunctionProto(org.apache.flink.table.functions.python.PythonFunctionInfo pythonFunctionInfo)
static FlinkFnApi.UserDefinedFunctions	createUserDefinedFunctionsProto(org.apache.flink.api.common.functions.RuntimeContext runtimeContext, org.apache.flink.table.functions.python.PythonFunctionInfo[] userDefinedFunctions, boolean isMetricEnabled, boolean isProfileEnabled)
static org.apache.flink.api.common.state.StateTtlConfig	parseStateTtlConfigFromProto(FlinkFnApi.StateDescriptor.StateTTLConfig stateTTLConfigProto)
static ProtoUtils	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ProtoUtils[]	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

Method Detail

values

public static ProtoUtils[] 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 (ProtoUtils c : ProtoUtils.values())
    System.out.println(c);

Returns:

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

valueOf

public static ProtoUtils 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

createCoderProto

public static org.apache.beam.model.pipeline.v1.RunnerApi.Coder createCoderProto(FlinkFnApi.CoderInfoDescriptor coderInfoDescriptor)

createRowTypeCoderInfoDescriptorProto

public static FlinkFnApi.CoderInfoDescriptor createRowTypeCoderInfoDescriptorProto(org.apache.flink.table.types.logical.RowType rowType,
                                                                                   FlinkFnApi.CoderInfoDescriptor.Mode mode,
                                                                                   boolean separatedWithEndMessage)

createFlattenRowTypeCoderInfoDescriptorProto

public static FlinkFnApi.CoderInfoDescriptor createFlattenRowTypeCoderInfoDescriptorProto(org.apache.flink.table.types.logical.RowType rowType,
                                                                                          FlinkFnApi.CoderInfoDescriptor.Mode mode,
                                                                                          boolean separatedWithEndMessage)

createArrowTypeCoderInfoDescriptorProto

public static FlinkFnApi.CoderInfoDescriptor createArrowTypeCoderInfoDescriptorProto(org.apache.flink.table.types.logical.RowType rowType,
                                                                                     FlinkFnApi.CoderInfoDescriptor.Mode mode,
                                                                                     boolean separatedWithEndMessage)

createOverWindowArrowTypeCoderInfoDescriptorProto

public static FlinkFnApi.CoderInfoDescriptor createOverWindowArrowTypeCoderInfoDescriptorProto(org.apache.flink.table.types.logical.RowType rowType,
                                                                                               FlinkFnApi.CoderInfoDescriptor.Mode mode,
                                                                                               boolean separatedWithEndMessage)

createUserDefinedFunctionsProto

public static FlinkFnApi.UserDefinedFunctions createUserDefinedFunctionsProto(org.apache.flink.api.common.functions.RuntimeContext runtimeContext,
                                                                              org.apache.flink.table.functions.python.PythonFunctionInfo[] userDefinedFunctions,
                                                                              boolean isMetricEnabled,
                                                                              boolean isProfileEnabled)

createUserDefinedFunctionProto

public static FlinkFnApi.UserDefinedFunction createUserDefinedFunctionProto(org.apache.flink.table.functions.python.PythonFunctionInfo pythonFunctionInfo)

createUserDefinedAggregateFunctionProto

public static FlinkFnApi.UserDefinedAggregateFunction createUserDefinedAggregateFunctionProto(org.apache.flink.table.functions.python.PythonAggregateFunctionInfo pythonFunctionInfo,
                                                                                              org.apache.flink.table.runtime.dataview.DataViewSpec[] dataViewSpecs)

createUserDefinedDataStreamFunctionProto

public static FlinkFnApi.UserDefinedDataStreamFunction createUserDefinedDataStreamFunctionProto(DataStreamPythonFunctionInfo dataStreamPythonFunctionInfo,
                                                                                                org.apache.flink.api.common.functions.RuntimeContext runtimeContext,
                                                                                                Map<String,String> internalParameters,
                                                                                                boolean inBatchExecutionMode,
                                                                                                boolean isMetricEnabled,
                                                                                                boolean isProfileEnabled,
                                                                                                boolean hasSideOutput,
                                                                                                int stateCacheSize,
                                                                                                int mapStateReadCacheSize,
                                                                                                int mapStateWriteCacheSize)

createReviseOutputDataStreamFunctionProto

public static FlinkFnApi.UserDefinedDataStreamFunction createReviseOutputDataStreamFunctionProto()

createUserDefinedDataStreamFunctionProtos

public static List<FlinkFnApi.UserDefinedDataStreamFunction> createUserDefinedDataStreamFunctionProtos(DataStreamPythonFunctionInfo dataStreamPythonFunctionInfo,
                                                                                                       org.apache.flink.api.common.functions.RuntimeContext runtimeContext,
                                                                                                       Map<String,String> internalParameters,
                                                                                                       boolean inBatchExecutionMode,
                                                                                                       boolean isMetricEnabled,
                                                                                                       boolean isProfileEnabled,
                                                                                                       boolean hasSideOutput,
                                                                                                       int stateCacheSize,
                                                                                                       int mapStateReadCacheSize,
                                                                                                       int mapStateWriteCacheSize)

createUserDefinedDataStreamStatefulFunctionProtos

public static List<FlinkFnApi.UserDefinedDataStreamFunction> createUserDefinedDataStreamStatefulFunctionProtos(DataStreamPythonFunctionInfo dataStreamPythonFunctionInfo,
                                                                                                               org.apache.flink.api.common.functions.RuntimeContext runtimeContext,
                                                                                                               Map<String,String> internalParameters,
                                                                                                               org.apache.flink.api.common.typeinfo.TypeInformation<?> keyTypeInfo,
                                                                                                               boolean inBatchExecutionMode,
                                                                                                               boolean isMetricEnabled,
                                                                                                               boolean isProfileEnabled,
                                                                                                               boolean hasSideOutput,
                                                                                                               int stateCacheSize,
                                                                                                               int mapStateReadCacheSize,
                                                                                                               int mapStateWriteCacheSize)

createRawTypeCoderInfoDescriptorProto

public static FlinkFnApi.CoderInfoDescriptor createRawTypeCoderInfoDescriptorProto(org.apache.flink.api.common.typeinfo.TypeInformation<?> typeInformation,
                                                                                   FlinkFnApi.CoderInfoDescriptor.Mode mode,
                                                                                   boolean separatedWithEndMessage,
                                                                                   ClassLoader userCodeClassLoader)

parseStateTtlConfigFromProto

public static org.apache.flink.api.common.state.StateTtlConfig parseStateTtlConfigFromProto(FlinkFnApi.StateDescriptor.StateTTLConfig stateTTLConfigProto)