Package org.apache.flink.fnexecution.v1

Class FlinkFnApi.UserDefinedDataStreamFunction

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.apache.flink.fnexecution.v1.FlinkFnApi.UserDefinedDataStreamFunction

All Implemented Interfaces:

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

Enclosing class:

FlinkFnApi

public static final class FlinkFnApi.UserDefinedDataStreamFunction
extends com.google.protobuf.GeneratedMessageV3
implements FlinkFnApi.UserDefinedDataStreamFunctionOrBuilder

 User defined DataStream function definition.
 

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

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FlinkFnApi.UserDefinedDataStreamFunction.Builder	User defined DataStream function definition.
static enum	FlinkFnApi.UserDefinedDataStreamFunction.FunctionType	Protobuf enum org.apache.flink.fn_execution.v1.UserDefinedDataStreamFunction.FunctionType
static final class	FlinkFnApi.UserDefinedDataStreamFunction.RuntimeContext	Protobuf type org.apache.flink.fn_execution.v1.UserDefinedDataStreamFunction.RuntimeContext
static interface	FlinkFnApi.UserDefinedDataStreamFunction.RuntimeContextOrBuilder

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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 final int	FUNCTION_TYPE_FIELD_NUMBER
static final int	HAS_SIDE_OUTPUT_FIELD_NUMBER
static final int	KEY_TYPE_INFO_FIELD_NUMBER
static final int	MAP_STATE_READ_CACHE_SIZE_FIELD_NUMBER
static final int	MAP_STATE_WRITE_CACHE_SIZE_FIELD_NUMBER
static final int	METRIC_ENABLED_FIELD_NUMBER
static final int	PAYLOAD_FIELD_NUMBER
static final int	PROFILE_ENABLED_FIELD_NUMBER
static final int	RUNTIME_CONTEXT_FIELD_NUMBER
static final int	STATE_CACHE_SIZE_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.UserDefinedDataStreamFunction	getDefaultInstance()
FlinkFnApi.UserDefinedDataStreamFunction	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
FlinkFnApi.UserDefinedDataStreamFunction.FunctionType	getFunctionType()	.org.apache.flink.fn_execution.v1.UserDefinedDataStreamFunction.FunctionType function_type = 1;
int	getFunctionTypeValue()	.org.apache.flink.fn_execution.v1.UserDefinedDataStreamFunction.FunctionType function_type = 1;
boolean	getHasSideOutput()	bool has_side_output = 7;
FlinkFnApi.TypeInfo	getKeyTypeInfo()	.org.apache.flink.fn_execution.v1.TypeInfo key_type_info = 5;
FlinkFnApi.TypeInfoOrBuilder	getKeyTypeInfoOrBuilder()	.org.apache.flink.fn_execution.v1.TypeInfo key_type_info = 5;
int	getMapStateReadCacheSize()	The map state read cache size.
int	getMapStateWriteCacheSize()	The map_state_write_cache_size.
boolean	getMetricEnabled()	bool metric_enabled = 4;
com.google.protobuf.Parser<FlinkFnApi.UserDefinedDataStreamFunction>	getParserForType()
com.google.protobuf.ByteString	getPayload()	bytes payload = 3;
boolean	getProfileEnabled()	bool profile_enabled = 6;
FlinkFnApi.UserDefinedDataStreamFunction.RuntimeContext	getRuntimeContext()	.org.apache.flink.fn_execution.v1.UserDefinedDataStreamFunction.RuntimeContext runtime_context = 2;
FlinkFnApi.UserDefinedDataStreamFunction.RuntimeContextOrBuilder	getRuntimeContextOrBuilder()	.org.apache.flink.fn_execution.v1.UserDefinedDataStreamFunction.RuntimeContext runtime_context = 2;
int	getSerializedSize()
int	getStateCacheSize()	The state cache size.
final com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasKeyTypeInfo()	.org.apache.flink.fn_execution.v1.TypeInfo key_type_info = 5;
boolean	hasRuntimeContext()	.org.apache.flink.fn_execution.v1.UserDefinedDataStreamFunction.RuntimeContext runtime_context = 2;
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static FlinkFnApi.UserDefinedDataStreamFunction.Builder	newBuilder()
static FlinkFnApi.UserDefinedDataStreamFunction.Builder	newBuilder(FlinkFnApi.UserDefinedDataStreamFunction prototype)
FlinkFnApi.UserDefinedDataStreamFunction.Builder	newBuilderForType()
protected FlinkFnApi.UserDefinedDataStreamFunction.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static FlinkFnApi.UserDefinedDataStreamFunction	parseDelimitedFrom(InputStream input)
static FlinkFnApi.UserDefinedDataStreamFunction	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlinkFnApi.UserDefinedDataStreamFunction	parseFrom(byte[] data)
static FlinkFnApi.UserDefinedDataStreamFunction	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlinkFnApi.UserDefinedDataStreamFunction	parseFrom(com.google.protobuf.ByteString data)
static FlinkFnApi.UserDefinedDataStreamFunction	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlinkFnApi.UserDefinedDataStreamFunction	parseFrom(com.google.protobuf.CodedInputStream input)
static FlinkFnApi.UserDefinedDataStreamFunction	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlinkFnApi.UserDefinedDataStreamFunction	parseFrom(InputStream input)
static FlinkFnApi.UserDefinedDataStreamFunction	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlinkFnApi.UserDefinedDataStreamFunction	parseFrom(ByteBuffer data)
static FlinkFnApi.UserDefinedDataStreamFunction	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FlinkFnApi.UserDefinedDataStreamFunction>	parser()
FlinkFnApi.UserDefinedDataStreamFunction.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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 Details

FUNCTION_TYPE_FIELD_NUMBER

public static final int FUNCTION_TYPE_FIELD_NUMBER

See Also:

• Constant Field Values

RUNTIME_CONTEXT_FIELD_NUMBER

public static final int RUNTIME_CONTEXT_FIELD_NUMBER

See Also:

• Constant Field Values

PAYLOAD_FIELD_NUMBER

public static final int PAYLOAD_FIELD_NUMBER

See Also:

• Constant Field Values

METRIC_ENABLED_FIELD_NUMBER

public static final int METRIC_ENABLED_FIELD_NUMBER

See Also:

• Constant Field Values

KEY_TYPE_INFO_FIELD_NUMBER

public static final int KEY_TYPE_INFO_FIELD_NUMBER

See Also:

• Constant Field Values

PROFILE_ENABLED_FIELD_NUMBER

public static final int PROFILE_ENABLED_FIELD_NUMBER

See Also:

• Constant Field Values

HAS_SIDE_OUTPUT_FIELD_NUMBER

public static final int HAS_SIDE_OUTPUT_FIELD_NUMBER

See Also:

• Constant Field Values

STATE_CACHE_SIZE_FIELD_NUMBER

public static final int STATE_CACHE_SIZE_FIELD_NUMBER

See Also:

• Constant Field Values

MAP_STATE_READ_CACHE_SIZE_FIELD_NUMBER

public static final int MAP_STATE_READ_CACHE_SIZE_FIELD_NUMBER

See Also:

• Constant Field Values

MAP_STATE_WRITE_CACHE_SIZE_FIELD_NUMBER

public static final int MAP_STATE_WRITE_CACHE_SIZE_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

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

getFunctionTypeValue

public int getFunctionTypeValue()

.org.apache.flink.fn_execution.v1.UserDefinedDataStreamFunction.FunctionType function_type = 1;

Specified by:

getFunctionTypeValue in interface FlinkFnApi.UserDefinedDataStreamFunctionOrBuilder

Returns:

The enum numeric value on the wire for functionType.

getFunctionType

public FlinkFnApi.UserDefinedDataStreamFunction.FunctionType getFunctionType()

.org.apache.flink.fn_execution.v1.UserDefinedDataStreamFunction.FunctionType function_type = 1;

Specified by:

getFunctionType in interface FlinkFnApi.UserDefinedDataStreamFunctionOrBuilder

Returns:

The functionType.

hasRuntimeContext

public boolean hasRuntimeContext()

.org.apache.flink.fn_execution.v1.UserDefinedDataStreamFunction.RuntimeContext runtime_context = 2;

Specified by:

hasRuntimeContext in interface FlinkFnApi.UserDefinedDataStreamFunctionOrBuilder

Returns:

Whether the runtimeContext field is set.

getRuntimeContext

public FlinkFnApi.UserDefinedDataStreamFunction.RuntimeContext getRuntimeContext()

.org.apache.flink.fn_execution.v1.UserDefinedDataStreamFunction.RuntimeContext runtime_context = 2;

Specified by:

getRuntimeContext in interface FlinkFnApi.UserDefinedDataStreamFunctionOrBuilder

Returns:

The runtimeContext.

getRuntimeContextOrBuilder

public FlinkFnApi.UserDefinedDataStreamFunction.RuntimeContextOrBuilder getRuntimeContextOrBuilder()

.org.apache.flink.fn_execution.v1.UserDefinedDataStreamFunction.RuntimeContext runtime_context = 2;

Specified by:

getRuntimeContextOrBuilder in interface FlinkFnApi.UserDefinedDataStreamFunctionOrBuilder

getPayload

public com.google.protobuf.ByteString getPayload()

bytes payload = 3;

Specified by:

getPayload in interface FlinkFnApi.UserDefinedDataStreamFunctionOrBuilder

Returns:

The payload.

getMetricEnabled

public boolean getMetricEnabled()

bool metric_enabled = 4;

Specified by:

getMetricEnabled in interface FlinkFnApi.UserDefinedDataStreamFunctionOrBuilder

Returns:

The metricEnabled.

hasKeyTypeInfo

public boolean hasKeyTypeInfo()

.org.apache.flink.fn_execution.v1.TypeInfo key_type_info = 5;

Specified by:

hasKeyTypeInfo in interface FlinkFnApi.UserDefinedDataStreamFunctionOrBuilder

Returns:

Whether the keyTypeInfo field is set.

getKeyTypeInfo

public FlinkFnApi.TypeInfo getKeyTypeInfo()

.org.apache.flink.fn_execution.v1.TypeInfo key_type_info = 5;

Specified by:

getKeyTypeInfo in interface FlinkFnApi.UserDefinedDataStreamFunctionOrBuilder

Returns:

The keyTypeInfo.

getKeyTypeInfoOrBuilder

public FlinkFnApi.TypeInfoOrBuilder getKeyTypeInfoOrBuilder()

.org.apache.flink.fn_execution.v1.TypeInfo key_type_info = 5;

Specified by:

getKeyTypeInfoOrBuilder in interface FlinkFnApi.UserDefinedDataStreamFunctionOrBuilder

getProfileEnabled

public boolean getProfileEnabled()

bool profile_enabled = 6;

Specified by:

getProfileEnabled in interface FlinkFnApi.UserDefinedDataStreamFunctionOrBuilder

Returns:

The profileEnabled.

getHasSideOutput

public boolean getHasSideOutput()

bool has_side_output = 7;

Specified by:

getHasSideOutput in interface FlinkFnApi.UserDefinedDataStreamFunctionOrBuilder

Returns:

The hasSideOutput.

getStateCacheSize

public int getStateCacheSize()

 The state cache size.
 

int32 state_cache_size = 8;

Specified by:

getStateCacheSize in interface FlinkFnApi.UserDefinedDataStreamFunctionOrBuilder

Returns:

The stateCacheSize.

getMapStateReadCacheSize

public int getMapStateReadCacheSize()

 The map state read cache size.
 

int32 map_state_read_cache_size = 9;

Specified by:

getMapStateReadCacheSize in interface FlinkFnApi.UserDefinedDataStreamFunctionOrBuilder

Returns:

The mapStateReadCacheSize.

getMapStateWriteCacheSize

public int getMapStateWriteCacheSize()

 The map_state_write_cache_size.
 

int32 map_state_write_cache_size = 10;

Specified by:

getMapStateWriteCacheSize in interface FlinkFnApi.UserDefinedDataStreamFunctionOrBuilder

Returns:

The mapStateWriteCacheSize.

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.UserDefinedDataStreamFunction parseFrom(ByteBuffer data)
                                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlinkFnApi.UserDefinedDataStreamFunction 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.UserDefinedDataStreamFunction parseFrom(byte[] data)
                                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public FlinkFnApi.UserDefinedDataStreamFunction.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FlinkFnApi.UserDefinedDataStreamFunction.Builder newBuilder()

newBuilder

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

toBuilder

public FlinkFnApi.UserDefinedDataStreamFunction.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static FlinkFnApi.UserDefinedDataStreamFunction getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<FlinkFnApi.UserDefinedDataStreamFunction> 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.UserDefinedDataStreamFunction getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder