org.apache.flink.connector.file.src.enumerate

Interface DynamicFileEnumerator

All Superinterfaces:

FileEnumerator

All Known Implementing Classes:

HiveSourceDynamicFileEnumerator

@PublicEvolving
public interface DynamicFileEnumerator
extends FileEnumerator

FileEnumerator that supports dynamic filtering. The enumerator only enumerates splits that exist in the given DynamicFilteringData, while enumerates all splits if no DynamicFilteringData is provided when #enumerateSplits is called.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DynamicFileEnumerator.Provider Factory for the DynamicFileEnumerator.

Method Summary

Modifier and Type	Method and Description
void	setDynamicFilteringData(DynamicFilteringData data) Provides a DynamicFilteringData for filtering while the enumerator is enumerating splits.

Methods inherited from interface org.apache.flink.connector.file.src.enumerate.FileEnumerator

enumerateSplits

Method Detail

setDynamicFilteringData

void setDynamicFilteringData(DynamicFilteringData data)

Provides a DynamicFilteringData for filtering while the enumerator is enumerating splits.

The DynamicFilteringData is typically collected by a collector operator, and transferred here by a coordinating event. The method should never be called directly by users.