Modifier and Type | Class and Description |
---|---|
class |
CodeAnalysisMode
Deprecated.
The code analysis code has been removed and this enum has no effect. NOTE It
can not be removed from the codebase for now, because it had been serialized as part of the
ExecutionConfig which in turn had been serialized as part of the PojoSerializer .
This class can be removed when we drop support for pre 1.8 serializer snapshots that
contained java serialized serializers ( |
class |
InputDependencyConstraint
This constraint indicates when a task should be scheduled considering its inputs status.
|
class |
JobStatus
Possible states of a job once it has been accepted by the dispatcher.
|
interface |
ProgramDescription
Implementing this interface allows a Program to have a description of the plan which can be shown
to the user.
|
class |
RuntimeExecutionMode
Runtime execution mode of DataStream programs.
|
Modifier and Type | Method and Description |
---|---|
long |
ExecutionConfig.getAutoWatermarkInterval()
Returns the interval of the automatic watermark emission.
|
InputDependencyConstraint |
ExecutionConfig.getDefaultInputDependencyConstraint()
Gets the default input dependency constraint for vertex scheduling.
|
Integer |
JobExecutionResult.getIntCounterResult(String accumulatorName)
Deprecated.
Will be removed in future versions. Use
JobExecutionResult.getAccumulatorResult(java.lang.String) instead. |
long |
ExecutionConfig.getLatencyTrackingInterval()
Returns the latency tracking interval.
|
int |
ExecutionConfig.getMaxParallelism()
Gets the maximum degree of parallelism defined for the program.
|
RestartStrategies.RestartStrategyConfiguration |
ExecutionConfig.getRestartStrategy()
Returns the restart strategy which has been set for the current job.
|
long |
ExecutionConfig.getTaskCancellationTimeout()
Returns the timeout (in milliseconds) after which an ongoing task cancellation leads to a
fatal TaskManager error.
|
ExecutionConfig |
ExecutionConfig.setAutoWatermarkInterval(long interval)
Sets the interval of the automatic watermark emission.
|
void |
ExecutionConfig.setDefaultInputDependencyConstraint(InputDependencyConstraint inputDependencyConstraint)
Sets the default input dependency constraint for vertex scheduling.
|
ExecutionConfig |
ExecutionConfig.setLatencyTrackingInterval(long interval)
Interval for sending latency tracking marks from the sources to the sinks.
|
void |
ExecutionConfig.setMaxParallelism(int maxParallelism)
Sets the maximum degree of parallelism defined for the program.
|
void |
ExecutionConfig.setRestartStrategy(RestartStrategies.RestartStrategyConfiguration restartStrategyConfiguration)
Sets the restart strategy to be used for recovery.
|
ExecutionConfig |
ExecutionConfig.setTaskCancellationTimeout(long timeout)
Sets the timeout (in milliseconds) after which an ongoing task cancellation is considered
failed, leading to a fatal TaskManager error.
|
Modifier and Type | Class and Description |
---|---|
class |
DoubleCounter
An accumulator that sums up
double values. |
class |
DoubleMaximum
An accumulator that finds the maximum
double value. |
class |
DoubleMinimum
An accumulator that finds the minimum
double value. |
class |
IntCounter
An accumulator that sums up
Integer values. |
class |
IntMaximum
An accumulator that finds the maximum
integer value. |
class |
IntMinimum
An accumulator that finds the minimum
integer value. |
class |
LongCounter
An accumulator that sums up
long values. |
class |
LongMaximum
An accumulator that finds the maximum
long value. |
class |
LongMinimum
An accumulator that finds the minimum
long value. |
class |
SerializedListAccumulator<T>
This accumulator stores a collection of objects in serialized form, so that the stored objects
are not affected by modifications to the original objects.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Aggregator<T extends Value>
Aggregators are a means of aggregating values across parallel instances of a function.
|
class |
AggregatorWithName<T extends Value>
Simple utility class holding an
Aggregator with the name it is registered under. |
interface |
ConvergenceCriterion<T extends Value>
Used to check for convergence.
|
class |
DoubleSumAggregator
An
Aggregator that sums up DoubleValue values. |
class |
DoubleZeroConvergence
A
ConvergenceCriterion over an Aggregator that defines convergence as reached
once the aggregator holds the value zero. |
class |
LongSumAggregator
An
Aggregator that sums up long values. |
class |
LongZeroConvergence
A
ConvergenceCriterion over an Aggregator that defines convergence as reached
once the aggregator holds the value zero. |
Modifier and Type | Interface and Description |
---|---|
interface |
DataDistribution |
interface |
RangeBoundaries<T>
RangeBoundaries is used to split the records into multiple ranges.
|
Modifier and Type | Interface and Description |
---|---|
interface |
SerializableTimestampAssigner<T>
A
TimestampAssigner that is also Serializable . |
interface |
TimestampAssignerSupplier<T>
A supplier for
TimestampAssigners . |
interface |
WatermarkGeneratorSupplier<T>
A supplier for
WatermarkGenerators . |
Modifier and Type | Interface and Description |
---|---|
interface |
ExternalResourceDriver
Driver which takes the responsibility to manage and provide the information of external resource.
|
interface |
ExternalResourceDriverFactory
Factory for
ExternalResourceDriver . |
interface |
ExternalResourceInfo
Contains the information of an external resource.
|
Modifier and Type | Interface and Description |
---|---|
interface |
AggregateFunction<IN,ACC,OUT>
The
AggregateFunction is a flexible aggregation function, characterized by the following
features:
The aggregates may use different types for input values, intermediate aggregates, and
result type, to support a wide range of aggregation types. |
class |
RichAggregateFunction<IN,ACC,OUT>
Rich variant of the
AggregateFunction . |
Modifier and Type | Method and Description |
---|---|
<IN,ACC,OUT> |
RuntimeContext.getAggregatingState(AggregatingStateDescriptor<IN,ACC,OUT> stateProperties)
Gets a handle to the system's key/value aggregating state.
|
DoubleCounter |
RuntimeContext.getDoubleCounter(String name)
Convenience function to create a counter object for doubles.
|
Set<ExternalResourceInfo> |
RuntimeContext.getExternalResourceInfos(String resourceName)
Get the specific external resource information by the resourceName.
|
Histogram |
RuntimeContext.getHistogram(String name)
Convenience function to create a counter object for histograms.
|
IntCounter |
RuntimeContext.getIntCounter(String name)
Convenience function to create a counter object for integers.
|
<T extends Aggregator<?>> |
IterationRuntimeContext.getIterationAggregator(String name) |
<T> ListState<T> |
RuntimeContext.getListState(ListStateDescriptor<T> stateProperties)
Gets a handle to the system's key/value list state.
|
LongCounter |
RuntimeContext.getLongCounter(String name)
Convenience function to create a counter object for longs.
|
<UK,UV> MapState<UK,UV> |
RuntimeContext.getMapState(MapStateDescriptor<UK,UV> stateProperties)
Gets a handle to the system's key/value map state.
|
int |
RuntimeContext.getMaxNumberOfParallelSubtasks()
Gets the number of max-parallelism with which the parallel task runs.
|
MetricGroup |
RuntimeContext.getMetricGroup()
Returns the metric group for this parallel subtask.
|
<T> ReducingState<T> |
RuntimeContext.getReducingState(ReducingStateDescriptor<T> stateProperties)
Gets a handle to the system's key/value reducing state.
|
<T> ValueState<T> |
RuntimeContext.getState(ValueStateDescriptor<T> stateProperties)
Gets a handle to the system's key/value state.
|
boolean |
RuntimeContext.hasBroadcastVariable(String name)
Tests for the existence of the broadcast variable identified by the given
name . |
void |
RuntimeContext.registerUserCodeClassLoaderReleaseHookIfAbsent(String releaseHookName,
Runnable releaseHook)
Registers a custom hook for the user code class loader release.
|
Modifier and Type | Method and Description |
---|---|
<IN,ACC,OUT> |
AbstractRuntimeUDFContext.getAggregatingState(AggregatingStateDescriptor<IN,ACC,OUT> stateProperties) |
<T> ListState<T> |
AbstractRuntimeUDFContext.getListState(ListStateDescriptor<T> stateProperties) |
<UK,UV> MapState<UK,UV> |
AbstractRuntimeUDFContext.getMapState(MapStateDescriptor<UK,UV> stateProperties) |
<T> ReducingState<T> |
AbstractRuntimeUDFContext.getReducingState(ReducingStateDescriptor<T> stateProperties) |
<T> ValueState<T> |
AbstractRuntimeUDFContext.getState(ValueStateDescriptor<T> stateProperties) |
Modifier and Type | Interface and Description |
---|---|
interface |
CheckpointableInputFormat<S extends InputSplit,T extends Serializable>
An interface that describes
InputFormat s that allow checkpointing/restoring their state. |
class |
FilePathFilter
The
FilePathFilter.filterPath(Path) method is responsible for deciding if a path is eligible for
further processing or not. |
class |
ParseException
Exception indicating that the parsing of input contents has failed because the data does not
match the configured parser.
|
class |
ReplicatingInputFormat<OT,S extends InputSplit>
A ReplicatingInputFormat replicates any
InputFormat to all parallel instances of a
DataSource, i.e., the full input of the replicated InputFormat is completely processed by each
parallel instance of the DataSource. |
Modifier and Type | Method and Description |
---|---|
void |
RichInputFormat.closeInputFormat()
Closes this InputFormat instance.
|
Charset |
DelimitedInputFormat.getCharset()
Get the character set used for the row delimiter.
|
Tuple2<Long,Long> |
BinaryInputFormat.getCurrentState() |
Long |
DelimitedInputFormat.getCurrentState() |
void |
RichInputFormat.openInputFormat()
Opens this InputFormat instance.
|
void |
DelimitedInputFormat.reopen(FileInputSplit split,
Long state) |
void |
BinaryInputFormat.reopen(FileInputSplit split,
Tuple2<Long,Long> state) |
void |
DelimitedInputFormat.setCharset(String charset)
Set the name of the character set used for the row delimiter.
|
Modifier and Type | Interface and Description |
---|---|
interface |
FlinkConnectorRateLimiter
An interface to create a ratelimiter
|
Modifier and Type | Field and Description |
---|---|
static float |
BaseStatistics.AVG_RECORD_BYTES_UNKNOWN
Constant indicating that average record width is unknown.
|
static long |
BaseStatistics.NUM_RECORDS_UNKNOWN
Constant indicating that the number of records is unknown;
|
static long |
BaseStatistics.SIZE_UNKNOWN
Constant indicating that the input size is unknown.
|
Modifier and Type | Method and Description |
---|---|
float |
BaseStatistics.getAverageRecordWidth()
Gets the average width of a record, in bytes.
|
long |
BaseStatistics.getNumberOfRecords()
Gets the number of records in the input (= base cardinality).
|
long |
BaseStatistics.getTotalInputSize()
Gets the total size of the input.
|
Modifier and Type | Method and Description |
---|---|
ResourceSpec |
Operator.getMinResources()
Gets the minimum resources for this operator.
|
ResourceSpec |
Operator.getPreferredResources()
Gets the preferred resources for this contract instance.
|
void |
Operator.setResources(ResourceSpec minResources,
ResourceSpec preferredResources)
Sets the minimum and preferred resources for this contract instance.
|
Modifier and Type | Class and Description |
---|---|
class |
RestartStrategies
This class defines methods to generate RestartStrategyConfigurations.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractDeserializationSchema<T>
The deserialization schema describes how to turn the byte messages delivered by certain data
sources (for example Apache Kafka) into data types (Java/Scala objects) that are processed by
Flink.
|
interface |
BulkWriter<T>
An encoder that encodes data in a bulk fashion, encoding many records together at a time.
|
static interface |
DeserializationSchema.InitializationContext
A contextual information provided for
DeserializationSchema.open(InitializationContext) method. |
interface |
Encoder<IN>
A
Encoder is used by the streaming file sink to perform the actual writing of the
incoming elements to the files in a bucket. |
static interface |
SerializationSchema.InitializationContext
A contextual information provided for
SerializationSchema.open(InitializationContext) method. |
class |
SimpleStringEncoder<IN>
A simple
Encoder that uses toString() on the input elements and writes them to
the output bucket file separated by newline. |
class |
SimpleStringSchema
Very simple serialization schema for strings.
|
Modifier and Type | Method and Description |
---|---|
default void |
DeserializationSchema.deserialize(byte[] message,
Collector<T> out)
Deserializes the byte message.
|
default void |
DeserializationSchema.open(DeserializationSchema.InitializationContext context)
Initialization method for the schema.
|
default void |
SerializationSchema.open(SerializationSchema.InitializationContext context)
Initialization method for the schema.
|
Modifier and Type | Interface and Description |
---|---|
interface |
AggregatingState<IN,OUT>
State interface for aggregating state, based on an AggregateFunction . |
class |
AggregatingStateDescriptor<IN,ACC,OUT>
A StateDescriptor for
AggregatingState . |
interface |
AppendingState<IN,OUT>
Base interface for partitioned state that supports adding elements and inspecting the current
state.
|
interface |
BroadcastState<K,V>
A type of state that can be created to store the state of a
BroadcastStream . |
interface |
KeyedStateStore
This interface contains methods for registering keyed state with a managed store.
|
interface |
ListState<T>
State interface for partitioned list state in Operations. |
class |
ListStateDescriptor<T>
A
StateDescriptor for ListState . |
interface |
MapState<UK,UV>
State interface for partitioned key-value state. |
class |
MapStateDescriptor<UK,UV>
A
StateDescriptor for MapState . |
interface |
MergingState<IN,OUT>
Extension of
AppendingState that allows merging of state. |
interface |
OperatorStateStore
This interface contains methods for registering operator state with a managed store.
|
interface |
ReadOnlyBroadcastState<K,V>
A read-only view of the
BroadcastState . |
interface |
ReducingState<T>
State interface for reducing state. |
class |
ReducingStateDescriptor<T>
|
interface |
State
Interface that different types of partitioned state must implement.
|
class |
StateDescriptor<S extends State,T>
Base class for state descriptors.
|
class |
StateTtlConfig
Configuration of state TTL logic.
|
interface |
ValueState<T>
State interface for partitioned single-value state. |
class |
ValueStateDescriptor<T>
|
Modifier and Type | Method and Description |
---|---|
<IN,ACC,OUT> |
KeyedStateStore.getAggregatingState(AggregatingStateDescriptor<IN,ACC,OUT> stateProperties)
Gets a handle to the system's key/value folding state.
|
<T> ListState<T> |
KeyedStateStore.getListState(ListStateDescriptor<T> stateProperties)
Gets a handle to the system's key/value list state.
|
<UK,UV> MapState<UK,UV> |
KeyedStateStore.getMapState(MapStateDescriptor<UK,UV> stateProperties)
Gets a handle to the system's key/value map state.
|
<T> ReducingState<T> |
KeyedStateStore.getReducingState(ReducingStateDescriptor<T> stateProperties)
Gets a handle to the system's key/value reducing state.
|
<T> ValueState<T> |
KeyedStateStore.getState(ValueStateDescriptor<T> stateProperties)
Gets a handle to the system's key/value state.
|
Modifier and Type | Class and Description |
---|---|
class |
Time
The definition of a time interval.
|
Modifier and Type | Class and Description |
---|---|
class |
LocalTimeTypeInfo<T extends java.time.temporal.Temporal>
Type information for Java LocalDate/LocalTime/LocalDateTime.
|
class |
SqlTimeTypeInfo<T>
Type information for Java SQL Date/Time/Timestamp.
|
class |
Types
This class gives access to the type information of the most common types for which Flink has
built-in serializers and comparators.
|
Modifier and Type | Method and Description |
---|---|
TypeComparator<T> |
BasicTypeInfo.createComparator(boolean sortOrderAscending,
ExecutionConfig executionConfig) |
PrimitiveArrayComparator<T,?> |
PrimitiveArrayTypeInfo.createComparator(boolean sortOrderAscending,
ExecutionConfig executionConfig) |
abstract TypeSerializer<T> |
TypeInformation.createSerializer(ExecutionConfig config)
Creates a serializer for the type.
|
TypeSerializer<Nothing> |
NothingTypeInfo.createSerializer(ExecutionConfig executionConfig) |
TypeSerializer<T> |
BasicArrayTypeInfo.createSerializer(ExecutionConfig executionConfig) |
TypeSerializer<T> |
BasicTypeInfo.createSerializer(ExecutionConfig executionConfig) |
TypeSerializer<T> |
PrimitiveArrayTypeInfo.createSerializer(ExecutionConfig executionConfig) |
abstract int |
TypeInformation.getArity()
Gets the arity of this type - the number of fields without nesting.
|
int |
NothingTypeInfo.getArity() |
int |
BasicArrayTypeInfo.getArity() |
int |
BasicTypeInfo.getArity() |
int |
PrimitiveArrayTypeInfo.getArity() |
Class<?> |
PrimitiveArrayTypeInfo.getComponentClass()
Gets the class that represents the component type.
|
TypeInformation<C> |
BasicArrayTypeInfo.getComponentInfo() |
TypeInformation<?> |
PrimitiveArrayTypeInfo.getComponentType()
Gets the type information of the component type.
|
Class<C> |
BasicArrayTypeInfo.getComponentTypeClass() |
Map<String,TypeInformation<?>> |
TypeInformation.getGenericParameters()
Optional method for giving Flink's type extraction system information about the mapping of a
generic type parameter to the type information of a subtype.
|
static <X> BasicTypeInfo<X> |
BasicTypeInfo.getInfoFor(Class<X> type) |
static <X> PrimitiveArrayTypeInfo<X> |
PrimitiveArrayTypeInfo.getInfoFor(Class<X> type)
Tries to get the PrimitiveArrayTypeInfo for an array.
|
static <X,C> BasicArrayTypeInfo<X,C> |
BasicArrayTypeInfo.getInfoFor(Class<X> type) |
abstract int |
TypeInformation.getTotalFields()
Gets the number of logical fields in this type.
|
int |
NothingTypeInfo.getTotalFields() |
int |
BasicArrayTypeInfo.getTotalFields() |
int |
BasicTypeInfo.getTotalFields() |
int |
PrimitiveArrayTypeInfo.getTotalFields() |
abstract Class<T> |
TypeInformation.getTypeClass()
Gets the class of the type represented by this type information.
|
Class<Nothing> |
NothingTypeInfo.getTypeClass() |
Class<T> |
BasicArrayTypeInfo.getTypeClass() |
Class<T> |
BasicTypeInfo.getTypeClass() |
Class<T> |
PrimitiveArrayTypeInfo.getTypeClass() |
abstract boolean |
TypeInformation.isBasicType()
Checks if this type information represents a basic type.
|
boolean |
NothingTypeInfo.isBasicType() |
boolean |
BasicArrayTypeInfo.isBasicType() |
boolean |
BasicTypeInfo.isBasicType() |
boolean |
PrimitiveArrayTypeInfo.isBasicType() |
abstract boolean |
TypeInformation.isKeyType()
Checks whether this type can be used as a key.
|
boolean |
NothingTypeInfo.isKeyType() |
boolean |
BasicArrayTypeInfo.isKeyType() |
boolean |
BasicTypeInfo.isKeyType() |
boolean |
PrimitiveArrayTypeInfo.isKeyType() |
boolean |
TypeInformation.isSortKeyType()
Checks whether this type can be used as a key for sorting.
|
abstract boolean |
TypeInformation.isTupleType()
Checks if this type information represents a Tuple type.
|
boolean |
NothingTypeInfo.isTupleType() |
boolean |
BasicArrayTypeInfo.isTupleType() |
boolean |
BasicTypeInfo.isTupleType() |
boolean |
PrimitiveArrayTypeInfo.isTupleType() |
boolean |
BasicTypeInfo.shouldAutocastTo(BasicTypeInfo<?> to)
Returns whether this type should be automatically casted to the target type in an arithmetic
operation.
|
Modifier and Type | Class and Description |
---|---|
static class |
CompositeType.FlatFieldDescriptor |
static class |
CompositeType.InvalidFieldReferenceException |
protected static interface |
CompositeType.TypeComparatorBuilder<T> |
class |
CompositeTypeComparator<T> |
class |
CompositeTypeSerializerSnapshot<T,S extends TypeSerializer<T>>
A
CompositeTypeSerializerSnapshot is a convenient serializer snapshot class that can be
used by simple serializers which 1) delegates its serialization to multiple nested serializers,
and 2) may contain some extra static information that needs to be persisted as part of its
snapshot. |
class |
SimpleTypeSerializerSnapshot<T>
A simple base class for TypeSerializerSnapshots, for serializers that have no parameters.
|
class |
TypeComparator<T>
This interface describes the methods that are required for a data type to be handled by the pact
runtime.
|
class |
TypeSerializer<T>
This interface describes the methods that are required for a data type to be handled by the Flink
runtime.
|
class |
TypeSerializerConfigSnapshot<T>
Deprecated.
|
class |
TypeSerializerSchemaCompatibility<T>
A
TypeSerializerSchemaCompatibility represents information about whether or not a TypeSerializer can be safely used to read data written by a previous type serializer. |
interface |
TypeSerializerSnapshot<T>
A
TypeSerializerSnapshot is a point-in-time view of a TypeSerializer 's
configuration. |
Modifier and Type | Method and Description |
---|---|
TypeComparator<T> |
CompositeType.createComparator(int[] logicalKeyFields,
boolean[] orders,
int logicalFieldOffset,
ExecutionConfig config)
Generic implementation of the comparator creation.
|
protected abstract CompositeType.TypeComparatorBuilder<T> |
CompositeType.createTypeComparatorBuilder() |
abstract int |
CompositeType.getFieldIndex(String fieldName)
Returns the field index of the composite field of the given name.
|
abstract String[] |
CompositeType.getFieldNames()
Returns the names of the composite fields of this type.
|
List<CompositeType.FlatFieldDescriptor> |
CompositeType.getFlatFields(String fieldExpression)
Returns the flat field descriptors for the given field expression.
|
abstract void |
CompositeType.getFlatFields(String fieldExpression,
int offset,
List<CompositeType.FlatFieldDescriptor> result)
Computes the flat field descriptors for the given field expression with the given offset.
|
abstract <X> TypeInformation<X> |
CompositeType.getTypeAt(int pos)
Returns the type of the (unnested) field at the given field position.
|
abstract <X> TypeInformation<X> |
CompositeType.getTypeAt(String fieldExpression)
Returns the type of the (nested) field at the given field expression position.
|
Class<T> |
CompositeType.getTypeClass()
Returns the type class of the composite type
|
boolean |
CompositeType.hasDeterministicFieldOrder()
True if this type has an inherent ordering of the fields, such that a user can always be sure
in which order the fields will be in.
|
boolean |
CompositeType.hasField(String fieldName)
Returns true when this type has a composite field with the given name.
|
boolean |
CompositeType.isKeyType() |
boolean |
CompositeType.isSortKeyType() |
Constructor and Description |
---|
CompositeType(Class<T> typeClass) |
Modifier and Type | Class and Description |
---|---|
class |
Boundedness
The boundedness of a stream.
|
interface |
ExternallyInducedSourceReader<T,SplitT extends SourceSplit>
Sources that implement this interface do not trigger checkpoints when receiving a trigger message
from the checkpoint coordinator, but when their input data/events indicate that a checkpoint
should be triggered.
|
class |
ReaderInfo
A container class hosting the information of a
SourceReader . |
interface |
ReaderOutput<T>
The interface provided by the Flink runtime to the
SourceReader to emit records, and
optionally watermarks, to downstream operators for message processing. |
interface |
Source<T,SplitT extends SourceSplit,EnumChkT>
The interface for Source.
|
interface |
SourceEvent
An base class for the events passed between the SourceReaders and Enumerators.
|
interface |
SourceOutput<T>
The
SourceOutput is the gateway for a SourceReader ) to emit the produced records
and watermarks. |
interface |
SourceReader<T,SplitT extends SourceSplit>
The interface for a source reader which is responsible for reading the records from the source
splits assigned by
SplitEnumerator . |
interface |
SourceReaderContext
The class that expose some context from runtime to the
SourceReader . |
interface |
SourceSplit
An interface for all the Split types to extend.
|
interface |
SplitEnumerator<SplitT extends SourceSplit,CheckpointT>
A interface of a split enumerator responsible for the followings: 1.
|
interface |
SplitEnumeratorContext<SplitT extends SourceSplit>
A context class for the
SplitEnumerator . |
class |
SplitsAssignment<SplitT extends SourceSplit>
A class containing the splits assignment to the source readers.
|
Modifier and Type | Class and Description |
---|---|
class |
CollectionEnvironment
Version of
ExecutionEnvironment that allows serial, local, collection-based executions of
Flink programs. |
Modifier and Type | Method and Description |
---|---|
void |
ExecutionEnvironment.clearJobListeners()
Clear all registered
JobListener s. |
void |
ExecutionEnvironment.configure(ReadableConfig configuration,
ClassLoader classLoader)
Sets all relevant options contained in the
ReadableConfig such as e.g. |
static CollectionEnvironment |
ExecutionEnvironment.createCollectionsEnvironment()
Creates a
CollectionEnvironment that uses Java Collections underneath. |
static ExecutionEnvironment |
ExecutionEnvironment.createLocalEnvironmentWithWebUI(Configuration conf)
Creates a
LocalEnvironment for local program execution that also starts the web
monitoring UI. |
JobClient |
ExecutionEnvironment.executeAsync()
Triggers the program execution asynchronously.
|
JobClient |
ExecutionEnvironment.executeAsync(String jobName)
Triggers the program execution asynchronously.
|
int |
ExecutionEnvironment.getNumberOfExecutionRetries()
Deprecated.
This method will be replaced by
ExecutionEnvironment.getRestartStrategy() . The RestartStrategies.FixedDelayRestartStrategyConfiguration contains the number of
execution retries. |
RestartStrategies.RestartStrategyConfiguration |
ExecutionEnvironment.getRestartStrategy()
Returns the specified restart strategy configuration.
|
DataSink<T> |
DataSet.print(String sinkIdentifier)
Deprecated.
Use
DataSet.printOnTaskManager(String) instead. |
DataSink<T> |
DataSet.printToErr(String sinkIdentifier)
Deprecated.
Use
DataSet.printOnTaskManager(String) instead, or the PrintingOutputFormat . |
void |
ExecutionEnvironment.registerJobListener(JobListener jobListener)
Register a
JobListener in this environment. |
void |
ExecutionEnvironment.setNumberOfExecutionRetries(int numberOfExecutionRetries)
Deprecated.
This method will be replaced by
ExecutionEnvironment.setRestartStrategy(org.apache.flink.api.common.restartstrategy.RestartStrategies.RestartStrategyConfiguration) . The RestartStrategies.FixedDelayRestartStrategyConfiguration contains the number of
execution retries. |
void |
ExecutionEnvironment.setRestartStrategy(RestartStrategies.RestartStrategyConfiguration restartStrategyConfiguration)
Sets the restart strategy configuration.
|
Constructor and Description |
---|
ExecutionEnvironment(Configuration configuration)
Creates a new
ExecutionEnvironment that will use the given Configuration to
configure the PipelineExecutor . |
ExecutionEnvironment(Configuration configuration,
ClassLoader userClassloader)
Creates a new
ExecutionEnvironment that will use the given Configuration to
configure the PipelineExecutor . |
ExecutionEnvironment(PipelineExecutorServiceLoader executorServiceLoader,
Configuration configuration,
ClassLoader userClassloader)
Creates a new
ExecutionEnvironment that will use the given Configuration to
configure the PipelineExecutor . |
Modifier and Type | Class and Description |
---|---|
class |
UnsupportedAggregationTypeException
Exception indicating an unsupported type was used for an aggregation.
|
Modifier and Type | Class and Description |
---|---|
class |
FlatMapIterator<IN,OUT>
A convenience variant of the
RichFlatMapFunction
that returns elements through an iterator, rather then through a collector. |
static interface |
FunctionAnnotation.ReadFields
The ReadFields annotation declares for a function all fields which it accesses and evaluates,
i.e., all fields that are used by the function to compute its result.
|
static interface |
FunctionAnnotation.ReadFieldsFirst
The ReadFieldsFirst annotation declares for a function all fields of the first input which it
accesses and evaluates, i.e., all fields of the first input that are used by the function to
compute its result.
|
static interface |
FunctionAnnotation.ReadFieldsSecond
The ReadFieldsSecond annotation declares for a function all fields of the second input which
it accesses and evaluates, i.e., all fields of the second input that are used by the function
to compute its result.
|
class |
GroupReduceIterator<IN,OUT>
Base class that simplifies reducing all values provided as
Iterable . |
Modifier and Type | Class and Description |
---|---|
class |
HadoopDummyProgressable
This is a dummy progress.
|
class |
HadoopDummyReporter
This is a dummy progress monitor / reporter.
|
Modifier and Type | Class and Description |
---|---|
class |
CollectionInputFormat<T>
An input format that returns objects from a collection.
|
class |
CsvOutputFormat<T extends Tuple>
This is an OutputFormat to serialize
Tuple s to text. |
class |
IteratorInputFormat<T>
An input format that returns objects from an iterator.
|
class |
LocalCollectionOutputFormat<T>
An output format that adds records to a collection.
|
class |
ParallelIteratorInputFormat<T>
An input format that generates data in parallel through a
SplittableIterator . |
class |
PrimitiveInputFormat<OT>
An input format that reads single field primitive data from a given file.
|
class |
PrintingOutputFormat<T>
Output format that prints results into either stdout or stderr.
|
class |
RowCsvInputFormat
Input format that reads csv into
Row . |
class |
SplitDataProperties<T>
SplitDataProperties define data properties on
InputSplit
generated by the InputFormat of a DataSource . |
class |
TextInputFormat
Input Format that reads text files.
|
class |
TextOutputFormat<T>
A
FileOutputFormat that writes objects to a text file. |
class |
TextValueInputFormat
Input format that reads text files.
|
class |
TypeSerializerInputFormat<T>
Reads elements by deserializing them with a given type serializer.
|
class |
TypeSerializerOutputFormat<T>
Stores elements by serializing them with their type serializer.
|
Modifier and Type | Method and Description |
---|---|
CsvReader |
CsvReader.fieldDelimiter(char delimiter)
Deprecated.
Please use
CsvReader.fieldDelimiter(String) . |
String |
CsvReader.getCharset()
Gets the character set for the reader.
|
void |
CsvReader.setCharset(String charset)
Sets the charset of the reader.
|
Modifier and Type | Method and Description |
---|---|
AggregatorRegistry |
DeltaIteration.getAggregators()
Gets the registry for aggregators for the iteration.
|
AggregatorRegistry |
IterativeDataSet.getAggregators()
Gets the registry for aggregators.
|
ResourceSpec |
DeltaIteration.getMinResources()
Gets the minimum resources from this iteration.
|
ResourceSpec |
DataSink.getMinResources()
Returns the minimum resources of this data sink.
|
ResourceSpec |
DeltaIteration.getPreferredResources()
Gets the preferred resources from this iteration.
|
ResourceSpec |
DataSink.getPreferredResources()
Returns the preferred resources of this data sink.
|
SplitDataProperties<OUT> |
DataSource.getSplitDataProperties()
Returns the
SplitDataProperties for the InputSplit s of this DataSource for configurations. |
<X extends Value> |
DeltaIteration.registerAggregationConvergenceCriterion(String name,
Aggregator<X> aggregator,
ConvergenceCriterion<X> convergenceCheck)
Registers an
Aggregator for the iteration together with a ConvergenceCriterion . |
<X extends Value> |
IterativeDataSet.registerAggregationConvergenceCriterion(String name,
Aggregator<X> aggregator,
ConvergenceCriterion<X> convergenceCheck)
Registers an
Aggregator for the iteration together with a ConvergenceCriterion . |
DeltaIteration<ST,WT> |
DeltaIteration.registerAggregator(String name,
Aggregator<?> aggregator)
Registers an
Aggregator for the iteration. |
IterativeDataSet<T> |
IterativeDataSet.registerAggregator(String name,
Aggregator<?> aggregator)
Registers an
Aggregator for the iteration. |
DistinctOperator<T> |
DistinctOperator.setCombineHint(ReduceOperatorBase.CombineHint strategy)
Sets the strategy to use for the combine phase of the reduce.
|
ReduceOperator<IN> |
ReduceOperator.setCombineHint(ReduceOperatorBase.CombineHint strategy)
Sets the strategy to use for the combine phase of the reduce.
|
DataSink<T> |
DataSink.sortLocalOutput(int field,
Order order)
Deprecated.
Use
DataSet.sortPartition(int, Order) instead |
DataSink<T> |
DataSink.sortLocalOutput(String fieldExpression,
Order order)
Deprecated.
Use
DataSet.sortPartition(String, Order) instead |
<OUT extends Tuple> |
JoinOperator.ProjectJoin.types(Class<?>... types)
Deprecated.
Deprecated method only kept for compatibility.
|
<OUT extends Tuple> |
CrossOperator.ProjectCross.types(Class<?>... types)
Deprecated.
Deprecated method only kept for compatibility.
|
<R extends Tuple> |
ProjectOperator.types(Class<?>... types)
Deprecated.
Deprecated method only kept for compatibility.
|
PartitionOperator<T> |
PartitionOperator.withOrders(Order... orders)
Sets the order of keys for range partitioning.
|
Modifier and Type | Class and Description |
---|---|
class |
BooleanColumnSummary
Summary for a column of booleans.
|
class |
ColumnSummary
Summary for a column of values.
|
class |
NumericColumnSummary<T>
Generic Column Summary for Numeric Types.
|
class |
ObjectColumnSummary
Summary for a column of generic Objects (this is a fallback for unsupported types).
|
class |
StringColumnSummary
Summary for a column of Strings.
|
Modifier and Type | Class and Description |
---|---|
class |
ListTypeInfo<T>
A
TypeInformation for the list types of the Java API. |
class |
MapTypeInfo<K,V>
Special
TypeInformation used by MapStateDescriptor . |
class |
MultisetTypeInfo<T>
A
TypeInformation for the Multiset types of the Java API. |
class |
RowTypeInfo
TypeInformation for Row . |
Modifier and Type | Method and Description |
---|---|
TypeComparator<T> |
WritableTypeInfo.createComparator(boolean sortOrderAscending,
ExecutionConfig executionConfig) |
TypeComparator<T> |
GenericTypeInfo.createComparator(boolean sortOrderAscending,
ExecutionConfig executionConfig) |
TypeComparator<T> |
EnumTypeInfo.createComparator(boolean sortOrderAscending,
ExecutionConfig executionConfig) |
TypeComparator<T> |
ValueTypeInfo.createComparator(boolean sortOrderAscending,
ExecutionConfig executionConfig) |
TypeSerializer<T> |
WritableTypeInfo.createSerializer(ExecutionConfig executionConfig) |
TypeSerializer<T> |
GenericTypeInfo.createSerializer(ExecutionConfig config) |
TypeSerializer<Either<L,R>> |
EitherTypeInfo.createSerializer(ExecutionConfig config) |
TypeSerializer<T> |
ObjectArrayTypeInfo.createSerializer(ExecutionConfig executionConfig) |
TypeSerializer<T> |
PojoTypeInfo.createSerializer(ExecutionConfig config) |
TypeSerializer<T> |
EnumTypeInfo.createSerializer(ExecutionConfig executionConfig) |
TupleSerializer<T> |
TupleTypeInfo.createSerializer(ExecutionConfig executionConfig) |
TypeSerializer<T> |
ValueTypeInfo.createSerializer(ExecutionConfig executionConfig) |
protected CompositeType.TypeComparatorBuilder<T> |
PojoTypeInfo.createTypeComparatorBuilder() |
static <IN1,IN2,OUT> |
TypeExtractor.createTypeInfo(Class<?> baseClass,
Class<?> clazz,
int returnParamPos,
TypeInformation<IN1> in1Type,
TypeInformation<IN2> in2Type) |
static <OUT> TypeInformation<OUT> |
TypeExtractor.createTypeInfo(Object instance,
Class<?> baseClass,
Class<?> clazz,
int returnParamPos)
Creates a
TypeInformation from the given parameters. |
static <IN,ACC> TypeInformation<ACC> |
TypeExtractor.getAggregateFunctionAccumulatorType(AggregateFunction<IN,ACC,?> function,
TypeInformation<IN> inType,
String functionName,
boolean allowMissing) |
static <IN,OUT> TypeInformation<OUT> |
TypeExtractor.getAggregateFunctionReturnType(AggregateFunction<IN,?,OUT> function,
TypeInformation<IN> inType,
String functionName,
boolean allowMissing) |
static List<Field> |
TypeExtractor.getAllDeclaredFields(Class<?> clazz,
boolean ignoreDuplicates)
Recursively determine all declared fields This is required because class.getFields() is not
returning fields defined in parent classes.
|
int |
WritableTypeInfo.getArity() |
int |
GenericTypeInfo.getArity() |
int |
EitherTypeInfo.getArity() |
int |
ObjectArrayTypeInfo.getArity() |
int |
PojoTypeInfo.getArity() |
int |
EnumTypeInfo.getArity() |
int |
ValueTypeInfo.getArity() |
static <X extends Tuple> |
TupleTypeInfo.getBasicAndBasicValueTupleTypeInfo(Class<?>... basicTypes) |
static <X extends Tuple> |
TupleTypeInfo.getBasicTupleTypeInfo(Class<?>... basicTypes) |
static <IN1,IN2,OUT> |
TypeExtractor.getBinaryOperatorReturnType(Function function,
Class<?> baseClass,
int input1TypeArgumentIndex,
int input2TypeArgumentIndex,
int outputTypeArgumentIndex,
int[] lambdaOutputTypeArgumentIndices,
TypeInformation<IN1> in1Type,
TypeInformation<IN2> in2Type,
String functionName,
boolean allowMissing)
Returns the binary operator's return type.
|
static <IN1,IN2,OUT> |
TypeExtractor.getCoGroupReturnTypes(CoGroupFunction<IN1,IN2,OUT> coGroupInterface,
TypeInformation<IN1> in1Type,
TypeInformation<IN2> in2Type) |
static <IN1,IN2,OUT> |
TypeExtractor.getCoGroupReturnTypes(CoGroupFunction<IN1,IN2,OUT> coGroupInterface,
TypeInformation<IN1> in1Type,
TypeInformation<IN2> in2Type,
String functionName,
boolean allowMissing) |
TypeInformation<C> |
ObjectArrayTypeInfo.getComponentInfo() |
static <IN1,IN2,OUT> |
TypeExtractor.getCrossReturnTypes(CrossFunction<IN1,IN2,OUT> crossInterface,
TypeInformation<IN1> in1Type,
TypeInformation<IN2> in2Type) |
static <IN1,IN2,OUT> |
TypeExtractor.getCrossReturnTypes(CrossFunction<IN1,IN2,OUT> crossInterface,
TypeInformation<IN1> in1Type,
TypeInformation<IN2> in2Type,
String functionName,
boolean allowMissing) |
static Field |
TypeExtractor.getDeclaredField(Class<?> clazz,
String name) |
int |
PojoTypeInfo.getFieldIndex(String fieldName) |
int |
TupleTypeInfo.getFieldIndex(String fieldName) |
String[] |
PojoTypeInfo.getFieldNames() |
String[] |
TupleTypeInfo.getFieldNames() |
void |
PojoTypeInfo.getFlatFields(String fieldExpression,
int offset,
List<CompositeType.FlatFieldDescriptor> result) |
static <IN1,IN2,OUT> |
TypeExtractor.getFlatJoinReturnTypes(FlatJoinFunction<IN1,IN2,OUT> joinInterface,
TypeInformation<IN1> in1Type,
TypeInformation<IN2> in2Type) |
static <IN1,IN2,OUT> |
TypeExtractor.getFlatJoinReturnTypes(FlatJoinFunction<IN1,IN2,OUT> joinInterface,
TypeInformation<IN1> in1Type,
TypeInformation<IN2> in2Type,
String functionName,
boolean allowMissing) |
static <IN,OUT> TypeInformation<OUT> |
TypeExtractor.getFlatMapReturnTypes(FlatMapFunction<IN,OUT> flatMapInterface,
TypeInformation<IN> inType) |
static <IN,OUT> TypeInformation<OUT> |
TypeExtractor.getFlatMapReturnTypes(FlatMapFunction<IN,OUT> flatMapInterface,
TypeInformation<IN> inType,
String functionName,
boolean allowMissing) |
Map<String,TypeInformation<?>> |
EitherTypeInfo.getGenericParameters() |
static <IN,OUT> TypeInformation<OUT> |
TypeExtractor.getGroupCombineReturnTypes(GroupCombineFunction<IN,OUT> combineInterface,
TypeInformation<IN> inType) |
static <IN,OUT> TypeInformation<OUT> |
TypeExtractor.getGroupCombineReturnTypes(GroupCombineFunction<IN,OUT> combineInterface,
TypeInformation<IN> inType,
String functionName,
boolean allowMissing) |
static <IN,OUT> TypeInformation<OUT> |
TypeExtractor.getGroupReduceReturnTypes(GroupReduceFunction<IN,OUT> groupReduceInterface,
TypeInformation<IN> inType) |
static <IN,OUT> TypeInformation<OUT> |
TypeExtractor.getGroupReduceReturnTypes(GroupReduceFunction<IN,OUT> groupReduceInterface,
TypeInformation<IN> inType,
String functionName,
boolean allowMissing) |
static <T,C> ObjectArrayTypeInfo<T,C> |
ObjectArrayTypeInfo.getInfoFor(Class<T> arrayClass,
TypeInformation<C> componentInfo) |
static <C> MultisetTypeInfo<C> |
MultisetTypeInfo.getInfoFor(TypeInformation<C> componentInfo) |
static <T,C> ObjectArrayTypeInfo<T,C> |
ObjectArrayTypeInfo.getInfoFor(TypeInformation<C> componentInfo)
Creates a new
ObjectArrayTypeInfo from a TypeInformation for the component type. |
static <IN> TypeInformation<IN> |
TypeExtractor.getInputFormatTypes(InputFormat<IN,?> inputFormatInterface) |
static <IN1,IN2,OUT> |
TypeExtractor.getJoinReturnTypes(JoinFunction<IN1,IN2,OUT> joinInterface,
TypeInformation<IN1> in1Type,
TypeInformation<IN2> in2Type) |
static <IN1,IN2,OUT> |
TypeExtractor.getJoinReturnTypes(JoinFunction<IN1,IN2,OUT> joinInterface,
TypeInformation<IN1> in1Type,
TypeInformation<IN2> in2Type,
String functionName,
boolean allowMissing) |
static <IN,OUT> TypeInformation<OUT> |
TypeExtractor.getKeySelectorTypes(KeySelector<IN,OUT> selectorInterface,
TypeInformation<IN> inType) |
static <IN,OUT> TypeInformation<OUT> |
TypeExtractor.getKeySelectorTypes(KeySelector<IN,OUT> selectorInterface,
TypeInformation<IN> inType,
String functionName,
boolean allowMissing) |
static <IN,OUT> TypeInformation<OUT> |
TypeExtractor.getMapPartitionReturnTypes(MapPartitionFunction<IN,OUT> mapPartitionInterface,
TypeInformation<IN> inType) |
static <IN,OUT> TypeInformation<OUT> |
TypeExtractor.getMapPartitionReturnTypes(MapPartitionFunction<IN,OUT> mapPartitionInterface,
TypeInformation<IN> inType,
String functionName,
boolean allowMissing) |
static <IN,OUT> TypeInformation<OUT> |
TypeExtractor.getMapReturnTypes(MapFunction<IN,OUT> mapInterface,
TypeInformation<IN> inType) |
static <IN,OUT> TypeInformation<OUT> |
TypeExtractor.getMapReturnTypes(MapFunction<IN,OUT> mapInterface,
TypeInformation<IN> inType,
String functionName,
boolean allowMissing) |
static Type |
TypeExtractor.getParameterType(Class<?> baseClass,
Class<?> clazz,
int pos) |
static <T> TypeInformation<T> |
TypeExtractor.getPartitionerTypes(Partitioner<T> partitioner) |
static <T> TypeInformation<T> |
TypeExtractor.getPartitionerTypes(Partitioner<T> partitioner,
String functionName,
boolean allowMissing) |
PojoField |
PojoTypeInfo.getPojoFieldAt(int pos) |
int |
WritableTypeInfo.getTotalFields() |
int |
GenericTypeInfo.getTotalFields() |
int |
EitherTypeInfo.getTotalFields() |
int |
ObjectArrayTypeInfo.getTotalFields() |
int |
PojoTypeInfo.getTotalFields() |
int |
EnumTypeInfo.getTotalFields() |
int |
ValueTypeInfo.getTotalFields() |
<X> TypeInformation<X> |
PojoTypeInfo.getTypeAt(int pos) |
<X> TypeInformation<X> |
PojoTypeInfo.getTypeAt(String fieldExpression) |
Class<T> |
WritableTypeInfo.getTypeClass() |
Class<T> |
GenericTypeInfo.getTypeClass() |
Class<Either<L,R>> |
EitherTypeInfo.getTypeClass() |
Class<T> |
ObjectArrayTypeInfo.getTypeClass() |
Class<T> |
EnumTypeInfo.getTypeClass() |
Class<T> |
ValueTypeInfo.getTypeClass() |
static <IN,OUT> TypeInformation<OUT> |
TypeExtractor.getUnaryOperatorReturnType(Function function,
Class<?> baseClass,
int inputTypeArgumentIndex,
int outputTypeArgumentIndex,
int[] lambdaOutputTypeArgumentIndices,
TypeInformation<IN> inType,
String functionName,
boolean allowMissing)
Returns the unary operator's return type.
|
boolean |
WritableTypeInfo.isBasicType() |
boolean |
GenericTypeInfo.isBasicType() |
boolean |
EitherTypeInfo.isBasicType() |
boolean |
ObjectArrayTypeInfo.isBasicType() |
boolean |
PojoTypeInfo.isBasicType() |
boolean |
EnumTypeInfo.isBasicType() |
boolean |
ValueTypeInfo.isBasicType() |
boolean |
ValueTypeInfo.isBasicValueType() |
boolean |
WritableTypeInfo.isKeyType() |
boolean |
GenericTypeInfo.isKeyType() |
boolean |
EitherTypeInfo.isKeyType() |
boolean |
ObjectArrayTypeInfo.isKeyType() |
boolean |
EnumTypeInfo.isKeyType() |
boolean |
ValueTypeInfo.isKeyType() |
boolean |
PojoTypeInfo.isSortKeyType() |
boolean |
WritableTypeInfo.isTupleType() |
boolean |
GenericTypeInfo.isTupleType() |
boolean |
EitherTypeInfo.isTupleType() |
boolean |
ObjectArrayTypeInfo.isTupleType() |
boolean |
PojoTypeInfo.isTupleType() |
boolean |
EnumTypeInfo.isTupleType() |
boolean |
ValueTypeInfo.isTupleType() |
Constructor and Description |
---|
EitherTypeInfo(TypeInformation<L> leftType,
TypeInformation<R> rightType) |
EnumTypeInfo(Class<T> typeClass) |
GenericTypeInfo(Class<T> typeClass) |
PojoTypeInfo(Class<T> typeClass,
List<PojoField> fields) |
TupleTypeInfo(Class<T> tupleType,
TypeInformation<?>... types) |
TupleTypeInfo(TypeInformation<?>... types) |
ValueTypeInfo(Class<T> type) |
WritableTypeInfo(Class<T> typeClass) |
Modifier and Type | Class and Description |
---|---|
class |
DataSetUtils
This class provides simple utility methods for zipping elements in a data set with an index or
with a unique identifier.
|
class |
MultipleParameterTool
This class provides simple utility methods for reading and parsing program arguments from
different sources.
|
Modifier and Type | Method and Description |
---|---|
Set<String> |
AbstractParameterTool.getUnrequestedParameters()
Returns the set of parameter names which have not been requested with
AbstractParameterTool.has(String) or
one of the get methods. |
Modifier and Type | Class and Description |
---|---|
class |
ScalaCsvOutputFormat<T extends scala.Product>
This is an OutputFormat to serialize Scala Tuples to text.
|
Modifier and Type | Class and Description |
---|---|
class |
PatternProcessFunction<IN,OUT>
It is called with a map of detected events which are identified by their names.
|
interface |
TimedOutPartialMatchHandler<IN>
Enables handling timed out partial matches.
|
Modifier and Type | Class and Description |
---|---|
class |
IterativeCondition<T>
A user-defined condition that decides if an element should be accepted in the pattern or not.
|
Modifier and Type | Interface and Description |
---|---|
interface |
TimeContext
Enables access to time related characteristics such as current processing time or timestamp of
currently processed element.
|
Modifier and Type | Class and Description |
---|---|
class |
ClientOptions
Describes a client configuration parameter.
|
Modifier and Type | Class and Description |
---|---|
class |
ApplicationExecutionException
A
FlinkException thrown in case something during application execution went wrong. |
class |
WebSubmissionJobClient
A
JobClient that only allows asking for the job id of the job it is attached to. |
Modifier and Type | Class and Description |
---|---|
class |
StreamContextEnvironment
Special
StreamExecutionEnvironment that will be used in cases where the CLI client or
testing utilities create a StreamExecutionEnvironment that should be used when StreamExecutionEnvironment.getExecutionEnvironment() is called. |
class |
StreamPlanEnvironment
A special
StreamExecutionEnvironment that is used in the web frontend when generating a
user-inspectable graph of a streaming job. |
Modifier and Type | Class and Description |
---|---|
class |
AkkaOptions
Akka configuration options.
|
class |
BlobServerOptions
Configuration options for the BlobServer and BlobCache.
|
class |
ClusterOptions
Options which control the cluster behaviour.
|
class |
ConfigOption<T>
A
ConfigOption describes a configuration parameter. |
class |
ConfigOptions
ConfigOptions are used to build a ConfigOption . |
class |
CoreOptions
The set of configuration options for core parameters.
|
class |
DeploymentOptions
The
configuration options relevant for all Executors. |
class |
ExecutionOptions
ConfigOption s specific for a single execution of a user program. |
class |
ExternalResourceOptions
Configuration options for external resources and external resource drivers.
|
class |
HeartbeatManagerOptions
The set of configuration options relating to heartbeat manager settings.
|
class |
HistoryServerOptions
The set of configuration options relating to the HistoryServer.
|
class |
IllegalConfigurationException
An
IllegalConfigurationException is thrown when the values in a given Configuration are not valid. |
class |
JMXServerOptions
The set of configuration options relating to JMX server.
|
class |
JobManagerOptions
Configuration options for the JobManager.
|
class |
MemorySize
MemorySize is a representation of a number of bytes, viewable in different units.
|
class |
MetricOptions
Configuration options for metrics and metric reporters.
|
class |
NettyShuffleEnvironmentOptions
The set of configuration options relating to network stack.
|
class |
OptimizerOptions
Configuration options for the optimizer.
|
class |
PipelineOptions
The
configuration options for job execution. |
class |
QueryableStateOptions
The set of configuration options relating to Queryable State.
|
interface |
ReadableConfig
Read access to a configuration object.
|
class |
ResourceManagerOptions
The set of configuration options relating to the ResourceManager.
|
class |
RestartStrategyOptions
Config options for restart strategies.
|
class |
TaskManagerOptions
The set of configuration options relating to TaskManager and Task settings.
|
class |
WebOptions
Configuration options for the WebMonitorEndpoint.
|
interface |
WritableConfig
Write access to a configuration object.
|
Modifier and Type | Method and Description |
---|---|
boolean |
Configuration.contains(ConfigOption<?> configOption)
Checks whether there is an entry for the given config option.
|
boolean |
Configuration.getBoolean(ConfigOption<Boolean> configOption)
Returns the value associated with the given config option as a boolean.
|
boolean |
Configuration.getBoolean(ConfigOption<Boolean> configOption,
boolean overrideDefault)
Returns the value associated with the given config option as a boolean.
|
double |
Configuration.getDouble(ConfigOption<Double> configOption)
Returns the value associated with the given config option as a
double . |
double |
Configuration.getDouble(ConfigOption<Double> configOption,
double overrideDefault)
Returns the value associated with the given config option as a
double . |
<T extends Enum<T>> |
Configuration.getEnum(Class<T> enumClass,
ConfigOption<String> configOption)
Returns the value associated with the given config option as an enum.
|
float |
Configuration.getFloat(ConfigOption<Float> configOption)
Returns the value associated with the given config option as a float.
|
float |
Configuration.getFloat(ConfigOption<Float> configOption,
float overrideDefault)
Returns the value associated with the given config option as a float.
|
int |
Configuration.getInteger(ConfigOption<Integer> configOption)
Returns the value associated with the given config option as an integer.
|
int |
Configuration.getInteger(ConfigOption<Integer> configOption,
int overrideDefault)
Returns the value associated with the given config option as an integer.
|
long |
Configuration.getLong(ConfigOption<Long> configOption)
Returns the value associated with the given config option as a long integer.
|
long |
Configuration.getLong(ConfigOption<Long> configOption,
long overrideDefault)
Returns the value associated with the given config option as a long integer.
|
String |
Configuration.getString(ConfigOption<String> configOption)
Returns the value associated with the given config option as a string.
|
String |
Configuration.getString(ConfigOption<String> configOption,
String overrideDefault)
Returns the value associated with the given config option as a string.
|
String |
Configuration.getValue(ConfigOption<?> configOption)
Returns the value associated with the given config option as a string.
|
void |
Configuration.setBoolean(ConfigOption<Boolean> key,
boolean value)
Adds the given value to the configuration object.
|
void |
Configuration.setDouble(ConfigOption<Double> key,
double value)
Adds the given value to the configuration object.
|
void |
Configuration.setFloat(ConfigOption<Float> key,
float value)
Adds the given value to the configuration object.
|
void |
Configuration.setInteger(ConfigOption<Integer> key,
int value)
Adds the given value to the configuration object.
|
void |
Configuration.setLong(ConfigOption<Long> key,
long value)
Adds the given value to the configuration object.
|
void |
Configuration.setString(ConfigOption<String> key,
String value)
Adds the given value to the configuration object.
|
Modifier and Type | Class and Description |
---|---|
static class |
FileSink.BulkFormatBuilder<IN,T extends FileSink.BulkFormatBuilder<IN,T>>
A builder for configuring the sink for bulk-encoding formats, e.g.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractFileSource<T,SplitT extends FileSourceSplit>
The base class for File Sources.
|
class |
FileSource<T>
A unified data source that reads files - both in batch and in streaming mode.
|
class |
FileSourceSplit
A
SourceSplit that represents a file, or a region of a file. |
class |
FileSourceSplitSerializer
A serializer for the
FileSourceSplit . |
class |
FileSourceSplitState<SplitT extends FileSourceSplit>
State of the reader, essentially a mutable version of the
FileSourceSplit . |
class |
PendingSplitsCheckpoint<SplitT extends FileSourceSplit>
A checkpoint of the current state of the containing the currently pending splits that are not yet
assigned.
|
class |
PendingSplitsCheckpointSerializer<T extends FileSourceSplit>
A serializer for the
PendingSplitsCheckpoint . |
Modifier and Type | Interface and Description |
---|---|
interface |
FileSplitAssigner
The
FileSplitAssigner is responsible for deciding what split should be processed next by
which node. |
class |
LocalityAwareSplitAssigner
A
FileSplitAssigner that assigns to each host preferably splits that are local, before
assigning splits that are not local. |
class |
SimpleSplitAssigner
The
SimpleSplitAssigner hands out splits in a random order, without any consideration for
order or locality. |
Modifier and Type | Class and Description |
---|---|
class |
StandardDeCompressors
A collection of common compression formats and de-compressors.
|
Modifier and Type | Class and Description |
---|---|
class |
BlockSplittingRecursiveEnumerator
This
FileEnumerator enumerates all files under the given paths recursively, and creates a
separate split for each file block. |
class |
DefaultFileFilter
A file filter that filters out hidden files based on common naming patterns, i.e., files where
the filename starts with '.' or with '_'.
|
interface |
FileEnumerator
The
FileEnumerator 's task is to discover all files to be read and to split them into a
set of FileSourceSplit . |
class |
NonSplittingRecursiveEnumerator
This
FileEnumerator enumerates all files under the given paths recursively. |
Modifier and Type | Interface and Description |
---|---|
interface |
BulkFormat<T,SplitT extends FileSourceSplit>
The
BulkFormat reads and decodes batches of records at a time. |
interface |
FileRecordFormat<T>
A reader format that reads individual records from a file.
|
class |
SimpleStreamFormat<T>
A simple version of the
StreamFormat , for formats that are not splittable. |
interface |
StreamFormat<T>
A reader format that reads individual records from a stream.
|
class |
TextLineFormat
A reader format that text lines from a file.
|
Modifier and Type | Class and Description |
---|---|
class |
ArrayResultIterator<E>
A simple
BulkFormat.RecordIterator that returns the elements of an array, one after the
other. |
class |
CheckpointedPosition
The position of a reader, to be stored in a checkpoint.
|
class |
IteratorResultIterator<E>
A simple
BulkFormat.RecordIterator that returns the elements of an iterator, augmented
with position information. |
class |
MutableRecordAndPosition<E>
A mutable version of the
RecordAndPosition . |
class |
Pool<T>
A pool to cache and recycle heavyweight objects, to reduce object allocation.
|
class |
RecordAndPosition<E>
A record, together with the reader position to be stored in the checkpoint.
|
class |
SingletonResultIterator<E>
A simple
BulkFormat.RecordIterator that returns a single value. |
class |
Utils
Miscellaneous utilities for the file source.
|
Modifier and Type | Class and Description |
---|---|
class |
JdbcConnectionOptions
JDBC connection options.
|
class |
JdbcExecutionOptions
JDBC sink batch options.
|
class |
JdbcSink
Facade to create JDBC
sinks . |
interface |
JdbcStatementBuilder<T>
Sets
PreparedStatement parameters to use in JDBC Sink based on a specific type of
StreamRecord. |
Modifier and Type | Class and Description |
---|---|
class |
JdbcCatalog
Catalogs for relational databases via JDBC.
|
Modifier and Type | Interface and Description |
---|---|
interface |
OffsetsInitializer
A interface for users to specify the starting / stopping offset of a
KafkaPartitionSplit . |
Modifier and Type | Class and Description |
---|---|
class |
FlinkHiveException
Exception used by flink's hive data connector.
|
Modifier and Type | Interface and Description |
---|---|
interface |
JobClient
A client that is scoped to a specific job.
|
interface |
JobListener
A listener that is notified on specific job status changed, which should be firstly registered by
#registerJobListener of execution environments. |
Modifier and Type | Interface and Description |
---|---|
interface |
EntropyInjectingFileSystem
An interface to be implemented by a
FileSystem that is aware of entropy injection. |
class |
EntropyInjector
This class offers utilities for entropy injection for FileSystems that implement
EntropyInjectingFileSystem . |
interface |
FileSystemFactory
A factory to create file systems.
|
class |
FileSystemKind
An enumeration defining the kind and characteristics of a
FileSystem . |
class |
RecoverableFsDataOutputStream
An output stream to a file system that can be recovered at well defined points.
|
interface |
RecoverableWriter
The RecoverableWriter creates and recovers
RecoverableFsDataOutputStream . |
Modifier and Type | Class and Description |
---|---|
class |
LocalFileSystemFactory
A factory for the
LocalFileSystem . |
Modifier and Type | Interface and Description |
---|---|
interface |
InputSplitAssigner
An input split assigner distributes the
InputSplit s among the instances on which a data
source exists. |
class |
InputStatus
An
InputStatus indicates the availability of data from an asynchronous input. |
class |
SimpleVersionedSerialization
Simple serialization / deserialization methods for the
SimpleVersionedSerializer . |
interface |
Versioned
This interface is implemented by classes that provide a version number.
|
class |
VersionMismatchException
This exception signals that incompatible versions have been found during serialization.
|
Modifier and Type | Class and Description |
---|---|
class |
DataInputViewStreamWrapper
Utility class that turns an
InputStream into a DataInputView . |
class |
DataOutputViewStreamWrapper
Utility class that turns an
OutputStream into a DataOutputView . |
interface |
SeekableDataInputView
Interface marking a
DataInputView as seekable. |
interface |
SeekableDataOutputView
Interface marking a
DataOutputView as seekable. |
Modifier and Type | Interface and Description |
---|---|
interface |
Plugin
Interface for plugins.
|
Modifier and Type | Class and Description |
---|---|
class |
ScheduledDropwizardReporter
Base class for
MetricReporter that wraps a Dropwizard
Reporter . |
Modifier and Type | Class and Description |
---|---|
class |
AvroRowDataDeserializationSchema
Deserialization schema from Avro bytes to
RowData . |
class |
AvroRowDeserializationSchema
Deserialization schema from Avro bytes to
Row . |
Modifier and Type | Class and Description |
---|---|
class |
CompressWriterFactory<IN>
A factory that creates for
bulk writers that, when provided with a CompressionCodec , they compress the data they write. |
Modifier and Type | Class and Description |
---|---|
class |
CsvRowDataSerializationSchema
Serialization schema that serializes an object of Flink Table & SQL internal data structure into
a CSV bytes.
|
static class |
CsvRowDataSerializationSchema.Builder
A builder for creating a
CsvRowDataSerializationSchema . |
class |
CsvRowDeserializationSchema
Deserialization schema from CSV to Flink types.
|
static class |
CsvRowDeserializationSchema.Builder
A builder for creating a
CsvRowDeserializationSchema . |
class |
CsvRowSerializationSchema
Serialization schema that serializes an object of Flink types into a CSV bytes.
|
static class |
CsvRowSerializationSchema.Builder
A builder for creating a
CsvRowSerializationSchema . |
Modifier and Type | Class and Description |
---|---|
class |
JsonNodeDeserializationSchema
DeserializationSchema that deserializes a JSON String into an ObjectNode.
|
class |
JsonRowDeserializationSchema
Deserialization schema from JSON to Flink types.
|
class |
JsonRowSerializationSchema
Serialization schema that serializes an object of Flink types into a JSON bytes.
|
static class |
JsonRowSerializationSchema.Builder
Builder for
JsonRowSerializationSchema . |
Modifier and Type | Class and Description |
---|---|
class |
ParquetBulkWriter<T>
A simple
BulkWriter implementation that wraps a ParquetWriter . |
class |
ParquetWriterFactory<T>
A factory that creates a Parquet
BulkWriter . |
Modifier and Type | Class and Description |
---|---|
class |
SequenceFileWriter<K extends org.apache.hadoop.io.Writable,V extends org.apache.hadoop.io.Writable>
A
BulkWriter implementation that wraps a SequenceFile.Writer . |
class |
SequenceFileWriterFactory<K extends org.apache.hadoop.io.Writable,V extends org.apache.hadoop.io.Writable>
A factory that creates a SequenceFile
BulkWriter . |
Modifier and Type | Class and Description |
---|---|
class |
S3RecoverableFsDataOutputStream
A RecoverableFsDataOutputStream to S3 that is based on a recoverable multipart upload.
|
class |
S3RecoverableWriter
An implementation of the
RecoverableWriter against S3. |
Modifier and Type | Class and Description |
---|---|
class |
KubernetesConfigOptions
This class holds configuration constants used by Flink's kubernetes runners.
|
class |
KubernetesHighAvailabilityOptions
The set of configuration options relating to Kubernetes high-availability settings.
|
Modifier and Type | Class and Description |
---|---|
class |
GraphiteReporter
This class acts as a factory for the
GraphiteReporter and
allows using it as a Flink reporter. |
Modifier and Type | Class and Description |
---|---|
class |
AbstractPrometheusReporter
base prometheus reporter for prometheus metrics.
|
class |
PrometheusPushGatewayReporter
|
class |
PrometheusReporter
MetricReporter that exports Metrics via Prometheus. |
Modifier and Type | Class and Description |
---|---|
class |
StatsDReporter
Largely based on the StatsDReporter class by ReadyTalk.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Estimator<E extends Estimator<E,M>,M extends Model<M>>
Estimators are
PipelineStage s responsible for training and generating machine learning
models. |
interface |
Model<M extends Model<M>>
A model is an ordinary
Transformer except how it is created. |
class |
Pipeline
A pipeline is a linear workflow which chains
Estimator s and Transformer s to
execute an algorithm. |
interface |
Transformer<T extends Transformer<T>>
|
Modifier and Type | Class and Description |
---|---|
class |
ParamInfo<V>
Definition of a parameter, including name, type, default value, validator and so on.
|
class |
Params
The map-like container class for parameter.
|
interface |
ParamValidator<V>
An interface used by
ParamInfo to do validation when a parameter value is set. |
Modifier and Type | Class and Description |
---|---|
class |
Vectorizer<T>
This class provides an abstracted set of methods to handle the lifecycle of
VectorizedRowBatch . |
Modifier and Type | Class and Description |
---|---|
class |
OrcBulkWriterFactory<T>
A factory that creates an ORC
BulkWriter . |
Modifier and Type | Class and Description |
---|---|
class |
PythonOptions
Configuration options for the Python API.
|
Modifier and Type | Class and Description |
---|---|
class |
QueryableStateClient
Client for querying Flink's managed state.
|
Modifier and Type | Method and Description |
---|---|
<K,S extends State,V> |
QueryableStateClient.getKvState(JobID jobId,
String queryableStateName,
K key,
TypeHint<K> keyTypeHint,
StateDescriptor<S,V> stateDescriptor)
Returns a future holding the request result.
|
<K,S extends State,V> |
QueryableStateClient.getKvState(JobID jobId,
String queryableStateName,
K key,
TypeInformation<K> keyTypeInfo,
StateDescriptor<S,V> stateDescriptor)
Returns a future holding the request result.
|
Modifier and Type | Class and Description |
---|---|
class |
SavepointConfigOptions
The
configuration options used when restoring from a savepoint. |
Modifier and Type | Class and Description |
---|---|
class |
AbstractStateBackend
An abstract base implementation of the
StateBackend interface. |
interface |
FunctionInitializationContext
This interface provides a context in which user functions can initialize by registering to
managed state (i.e.
|
interface |
FunctionSnapshotContext
This interface provides a context in which user functions that use managed state (i.e.
|
class |
KeyedStateCheckpointOutputStream
Checkpoint output stream that allows to write raw keyed state in a partitioned way, split into
key-groups.
|
class |
KeyGroupStatePartitionStreamProvider
This class provides access to an input stream that contains state data for one key group and the
key group id.
|
interface |
ManagedSnapshotContext
This interface provides a context in which operators that use managed state (i.e.
|
class |
OperatorStateCheckpointOutputStream
Checkpoint output stream that allows to write raw operator state in a partitioned way.
|
interface |
StateBackend
A State Backend defines how the state of a streaming application is stored and
checkpointed.
|
interface |
StateBackendFactory<T extends StateBackend>
A factory to create a specific state backend.
|
interface |
StateInitializationContext
This interface provides a context in which operators can initialize by registering to managed
state (i.e.
|
class |
StatePartitionStreamProvider
This class provides access to input streams that contain data of one state partition of a
partitionable state.
|
interface |
StateSnapshotContext
This interface provides a context in which operators that use managed (i.e.
|
Modifier and Type | Method and Description |
---|---|
boolean |
VoidNamespaceTypeInfo.canEqual(Object obj) |
TypeSerializer<VoidNamespace> |
VoidNamespaceTypeInfo.createSerializer(ExecutionConfig config) |
boolean |
VoidNamespaceTypeInfo.equals(Object obj) |
int |
VoidNamespaceTypeInfo.getArity() |
int |
VoidNamespaceTypeInfo.getTotalFields() |
Class<VoidNamespace> |
VoidNamespaceTypeInfo.getTypeClass() |
int |
VoidNamespaceTypeInfo.hashCode() |
boolean |
VoidNamespaceTypeInfo.isBasicType() |
boolean |
VoidNamespaceTypeInfo.isKeyType() |
boolean |
VoidNamespaceTypeInfo.isTupleType() |
String |
VoidNamespaceTypeInfo.toString() |
Modifier and Type | Class and Description |
---|---|
class |
AbstractFileStateBackend
A base class for all state backends that store their metadata (and data) in files.
|
class |
FsStateBackend
This state backend holds the working state in the memory (JVM heap) of the TaskManagers.
|
class |
FsStateBackendFactory
A factory that creates an
FsStateBackend from a configuration. |
Modifier and Type | Class and Description |
---|---|
class |
MemoryStateBackend
This state backend holds the working state in the memory (JVM heap) of the TaskManagers.
|
class |
MemoryStateBackendFactory
A factory that creates an
MemoryStateBackend from a configuration. |
Modifier and Type | Class and Description |
---|---|
class |
BootstrapTransformation<T>
A
BootstrapTransformation represents a procedure of writing new operator state into a
Savepoint . |
class |
EvictingWindowReader<W extends Window>
This class provides entry points for reading keyed state written out using the
WindowOperator . |
class |
ExistingSavepoint
An existing savepoint.
|
class |
KeyedOperatorTransformation<K,T>
A
KeyedOperatorTransformation represents a OneInputOperatorTransformation on
which operator state is partitioned by key using a provided KeySelector . |
class |
NewSavepoint
A new savepoint.
|
class |
OneInputOperatorTransformation<T>
OneInputOperatorTransformation represents a user defined transformation applied on an
OperatorTransformation with one input. |
class |
OperatorTransformation
This class provides the entry point for building
BootstrapTransformation s, which
represents procedures to bootstrap new operator states with a given DataSet . |
class |
Savepoint
This class provides entry points for loading an existing savepoint, or a new empty savepoint.
|
interface |
SavepointWriterOperatorFactory
Creates a savepoint writing operator from a savepoint path.
|
class |
WindowedOperatorTransformation<T,K,W extends Window>
A
WindowedOperatorTransformation represents a OneInputOperatorTransformation for
bootstrapping window state. |
class |
WindowReader<W extends Window>
This class provides entry points for reading keyed state written out using the
WindowOperator . |
class |
WritableSavepoint<F extends WritableSavepoint>
A
WritableSavepoint is any savepoint that can be written to from a batch context. |
Modifier and Type | Method and Description |
---|---|
<ACC,R> BootstrapTransformation<T> |
WindowedOperatorTransformation.aggregate(AggregateFunction<T,ACC,R> function)
Applies the given aggregation function to each window.
|
<ACC,R> BootstrapTransformation<T> |
WindowedOperatorTransformation.aggregate(AggregateFunction<T,ACC,R> function,
TypeInformation<ACC> accumulatorType)
Applies the given aggregation function to each window.
|
<ACC,V,R> BootstrapTransformation<T> |
WindowedOperatorTransformation.aggregate(AggregateFunction<T,ACC,V> aggFunction,
ProcessWindowFunction<V,R,K,W> windowFunction)
Applies the given window function to each window.
|
<ACC,V,R> BootstrapTransformation<T> |
WindowedOperatorTransformation.aggregate(AggregateFunction<T,ACC,V> aggregateFunction,
ProcessWindowFunction<V,R,K,W> windowFunction,
TypeInformation<ACC> accumulatorType)
Applies the given window function to each window.
|
<ACC,V,R> BootstrapTransformation<T> |
WindowedOperatorTransformation.aggregate(AggregateFunction<T,ACC,V> aggFunction,
WindowFunction<V,R,K,W> windowFunction)
Applies the given window function to each window.
|
<ACC,V,R> BootstrapTransformation<T> |
WindowedOperatorTransformation.aggregate(AggregateFunction<T,ACC,V> aggregateFunction,
WindowFunction<V,R,K,W> windowFunction,
TypeInformation<ACC> accumulatorType)
Applies the given window function to each window.
|
WindowedOperatorTransformation<T,K,W> |
WindowedOperatorTransformation.evictor(Evictor<? super T,? super W> evictor)
Sets the
Evictor that should be used to evict elements from a window before emission. |
<R> BootstrapTransformation<T> |
WindowedOperatorTransformation.process(ProcessWindowFunction<T,R,K,W> function)
Applies the given window function to each window.
|
OneInputOperatorTransformation<T> |
OneInputOperatorTransformation.setMaxParallelism(int maxParallelism)
Sets the maximum parallelism of this operator.
|
WindowedOperatorTransformation<T,K,W> |
WindowedOperatorTransformation.trigger(Trigger<? super T,? super W> trigger)
Sets the
Trigger that should be used to trigger window emission. |
Modifier and Type | Class and Description |
---|---|
class |
BroadcastStateBootstrapFunction<IN>
Interface for writing elements to broadcast state.
|
class |
KeyedStateBootstrapFunction<K,IN>
A function that writes keyed state to a new operator.
|
class |
KeyedStateReaderFunction<K,OUT>
A function that processes keys from a restored operator
|
class |
StateBootstrapFunction<IN>
Interface for writing elements to operator state.
|
interface |
Timestamper<T>
Assigns an event time timestamp to the given record.
|
class |
WindowReaderFunction<IN,OUT,KEY,W extends Window>
Base abstract class for functions that are evaluated over keyed (grouped) windows using a context
for retrieving extra information.
|
Modifier and Type | Class and Description |
---|---|
class |
TimeCharacteristic
Deprecated.
In Flink 1.12 the default stream time characteristic has been changed to
TimeCharacteristic.EventTime , thus you don't need to call this method for enabling
event-time support anymore. Explicitly using processing-time windows and timers works in
event-time mode. If you need to disable watermarks, please use ExecutionConfig.setAutoWatermarkInterval(long) . If you are using TimeCharacteristic.IngestionTime , please manually set an appropriate WatermarkStrategy . If you are using generic "time window" operations (for example KeyedStream.timeWindow(org.apache.flink.streaming.api.windowing.time.Time)
that change behaviour based on the time characteristic, please use equivalent operations that
explicitly specify processing time or event time. |
interface |
TimerService
Interface for working with time and timers.
|
Modifier and Type | Interface and Description |
---|---|
interface |
ExternallyInducedSource<T,CD>
Sources that implement this interface do not trigger checkpoints when receiving a trigger message
from the checkpoint coordinator, but when their input data/events indicate that a checkpoint
should be triggered.
|
interface |
ListCheckpointed<T extends Serializable>
Deprecated.
If you need to do non-keyed state snapshots of your operator, use
CheckpointedFunction . This should only be needed in rare cases, though. |
interface |
WithMasterCheckpointHook<E>
This interface can be implemented by streaming functions that need to trigger a "global action"
on the master (in the checkpoint coordinator) as part of every checkpoint and restore operation.
|
Modifier and Type | Class and Description |
---|---|
class |
AsyncDataStream
A helper class to apply
AsyncFunction to a data stream. |
class |
BroadcastConnectedStream<IN1,IN2>
A BroadcastConnectedStream represents the result of connecting a keyed or non-keyed stream, with
a
BroadcastStream with broadcast
state(s) . |
class |
BroadcastStream<T>
A
BroadcastStream is a stream with broadcast state(s) . |
class |
IterativeStream<T>
The iterative data stream represents the start of an iteration in a
DataStream . |
static class |
KeyedStream.IntervalJoin<T1,T2,KEY>
Perform a join over a time interval.
|
static class |
KeyedStream.IntervalJoined<IN1,IN2,KEY>
IntervalJoined is a container for two streams that have keys for both sides as well as the
time boundaries over which elements should be joined.
|
class |
QueryableStateStream<K,V>
Queryable state stream instance.
|
class |
StreamProjection<IN>
The result of
DataStream.project(int...) . |
class |
UnsupportedTimeCharacteristicException
An exception that indicates that a time characteristic was used that is not supported in the
current operation.
|
Modifier and Type | Method and Description |
---|---|
<ACC,R> SingleOutputStreamOperator<R> |
WindowedStream.aggregate(AggregateFunction<T,ACC,R> function)
Applies the given aggregation function to each window.
|
<ACC,R> SingleOutputStreamOperator<R> |
AllWindowedStream.aggregate(AggregateFunction<T,ACC,R> function)
Applies the given
AggregateFunction to each window. |
<ACC,R> SingleOutputStreamOperator<R> |
WindowedStream.aggregate(AggregateFunction<T,ACC,R> function,
TypeInformation<ACC> accumulatorType,
TypeInformation<R> resultType)
Applies the given aggregation function to each window.
|
<ACC,R> SingleOutputStreamOperator<R> |
AllWindowedStream.aggregate(AggregateFunction<T,ACC,R> function,
TypeInformation<ACC> accumulatorType,
TypeInformation<R> resultType)
Applies the given
AggregateFunction to each window. |
<ACC,V,R> SingleOutputStreamOperator<R> |
AllWindowedStream.aggregate(AggregateFunction<T,ACC,V> aggFunction,
AllWindowFunction<V,R,W> windowFunction)
Applies the given window function to each window.
|
<ACC,V,R> SingleOutputStreamOperator<R> |
AllWindowedStream.aggregate(AggregateFunction<T,ACC,V> aggregateFunction,
AllWindowFunction<V,R,W> windowFunction,
TypeInformation<ACC> accumulatorType,
TypeInformation<R> resultType)
Applies the given window function to each window.
|
<ACC,V,R> SingleOutputStreamOperator<R> |
AllWindowedStream.aggregate(AggregateFunction<T,ACC,V> aggFunction,
ProcessAllWindowFunction<V,R,W> windowFunction)
Applies the given window function to each window.
|
<ACC,V,R> SingleOutputStreamOperator<R> |
AllWindowedStream.aggregate(AggregateFunction<T,ACC,V> aggregateFunction,
ProcessAllWindowFunction<V,R,W> windowFunction,
TypeInformation<ACC> accumulatorType,
TypeInformation<V> aggregateResultType,
TypeInformation<R> resultType)
Applies the given window function to each window.
|
<ACC,V,R> SingleOutputStreamOperator<R> |
WindowedStream.aggregate(AggregateFunction<T,ACC,V> aggFunction,
ProcessWindowFunction<V,R,K,W> windowFunction)
Applies the given window function to each window.
|
<ACC,V,R> SingleOutputStreamOperator<R> |
WindowedStream.aggregate(AggregateFunction<T,ACC,V> aggregateFunction,
ProcessWindowFunction<V,R,K,W> windowFunction,
TypeInformation<ACC> accumulatorType,
TypeInformation<V> aggregateResultType,
TypeInformation<R> resultType)
Applies the given window function to each window.
|
<ACC,V,R> SingleOutputStreamOperator<R> |
WindowedStream.aggregate(AggregateFunction<T,ACC,V> aggFunction,
WindowFunction<V,R,K,W> windowFunction)
Applies the given window function to each window.
|
<ACC,V,R> SingleOutputStreamOperator<R> |
WindowedStream.aggregate(AggregateFunction<T,ACC,V> aggregateFunction,
WindowFunction<V,R,K,W> windowFunction,
TypeInformation<ACC> accumulatorType,
TypeInformation<R> resultType)
Applies the given window function to each window.
|
CoGroupedStreams.WithWindow<T1,T2,KEY,W> |
CoGroupedStreams.WithWindow.allowedLateness(Time newLateness)
Sets the time by which elements are allowed to be late.
|
JoinedStreams.WithWindow<T1,T2,KEY,W> |
JoinedStreams.WithWindow.allowedLateness(Time newLateness)
Sets the time by which elements are allowed to be late.
|
WindowedStream<T,K,W> |
WindowedStream.allowedLateness(Time lateness)
Sets the time by which elements are allowed to be late.
|
AllWindowedStream<T,W> |
AllWindowedStream.allowedLateness(Time lateness)
Sets the time by which elements are allowed to be late.
|
QueryableStateStream<KEY,T> |
KeyedStream.asQueryableState(String queryableStateName)
Publishes the keyed stream as queryable ValueState instance.
|
QueryableStateStream<KEY,T> |
KeyedStream.asQueryableState(String queryableStateName,
ReducingStateDescriptor<T> stateDescriptor)
Publishes the keyed stream as a queryable ReducingState instance.
|
QueryableStateStream<KEY,T> |
KeyedStream.asQueryableState(String queryableStateName,
ValueStateDescriptor<T> stateDescriptor)
Publishes the keyed stream as a queryable ValueState instance.
|
KeyedStream.IntervalJoined<T1,T2,KEY> |
KeyedStream.IntervalJoin.between(Time lowerBound,
Time upperBound)
Specifies the time boundaries over which the join operation works, so that
|
BroadcastStream<T> |
DataStream.broadcast(MapStateDescriptor<?,?>... broadcastStateDescriptors)
Sets the partitioning of the
DataStream so that the output elements are broadcasted
to every parallel instance of the next operation. |
<R> BroadcastConnectedStream<T,R> |
DataStream.connect(BroadcastStream<R> broadcastStream)
Creates a new
BroadcastConnectedStream by connecting the current DataStream
or KeyedStream with a BroadcastStream . |
DataStreamSink<T> |
DataStreamSink.disableChaining()
Turns off chaining for this operator so thread co-location will not be used as an
optimization.
|
SingleOutputStreamOperator<T> |
SingleOutputStreamOperator.disableChaining()
Turns off chaining for this operator so thread co-location will not be used as an
optimization.
|
CoGroupedStreams.WithWindow<T1,T2,KEY,W> |
CoGroupedStreams.WithWindow.evictor(Evictor<? super CoGroupedStreams.TaggedUnion<T1,T2>,? super W> newEvictor)
Sets the
Evictor that should be used to evict elements from a window before
emission. |
JoinedStreams.WithWindow<T1,T2,KEY,W> |
JoinedStreams.WithWindow.evictor(Evictor<? super CoGroupedStreams.TaggedUnion<T1,T2>,? super W> newEvictor)
Sets the
Evictor that should be used to evict elements from a window before
emission. |
WindowedStream<T,K,W> |
WindowedStream.evictor(Evictor<? super T,? super W> evictor)
Sets the
Evictor that should be used to evict elements from a window before emission. |
AllWindowedStream<T,W> |
AllWindowedStream.evictor(Evictor<? super T,? super W> evictor)
Sets the
Evictor that should be used to evict elements from a window before emission. |
SingleOutputStreamOperator<T> |
SingleOutputStreamOperator.forceNonParallel()
Sets the parallelism and maximum parallelism of this operator to one.
|
ResourceSpec |
DataStream.getMinResources()
Gets the minimum resources for this operator.
|
ResourceSpec |
DataStream.getPreferredResources()
Gets the preferred resources for this operator.
|
DataStream<T> |
DataStream.global()
Sets the partitioning of the
DataStream so that the output values all go to the first
instance of the next processing operator. |
<T1> KeyedStream.IntervalJoin<T,T1,KEY> |
KeyedStream.intervalJoin(KeyedStream<T1,KEY> otherStream)
Join elements of this
KeyedStream with elements of another KeyedStream over a
time interval that can be specified with KeyedStream.IntervalJoin.between(Time, Time) . |
IterativeStream<T> |
DataStream.iterate()
Initiates an iterative part of the program that feeds back data streams.
|
IterativeStream<T> |
DataStream.iterate(long maxWaitTimeMillis)
Initiates an iterative part of the program that feeds back data streams.
|
KeyedStream.IntervalJoined<IN1,IN2,KEY> |
KeyedStream.IntervalJoined.lowerBoundExclusive()
Set the lower bound to be exclusive.
|
DataStreamSink<T> |
DataStream.print()
Writes a DataStream to the standard output stream (stdout).
|
DataStreamSink<T> |
DataStream.print(String sinkIdentifier)
Writes a DataStream to the standard output stream (stdout).
|
DataStreamSink<T> |
DataStream.printToErr()
Writes a DataStream to the standard output stream (stderr).
|
DataStreamSink<T> |
DataStream.printToErr(String sinkIdentifier)
Writes a DataStream to the standard output stream (stderr).
|
<OUT> SingleOutputStreamOperator<OUT> |
BroadcastConnectedStream.process(BroadcastProcessFunction<IN1,IN2,OUT> function)
Assumes as inputs a
BroadcastStream and a non-keyed DataStream and applies
the given BroadcastProcessFunction on them, thereby creating a transformed output
stream. |
<OUT> SingleOutputStreamOperator<OUT> |
BroadcastConnectedStream.process(BroadcastProcessFunction<IN1,IN2,OUT> function,
TypeInformation<OUT> outTypeInfo)
Assumes as inputs a
BroadcastStream and a non-keyed DataStream and applies
the given BroadcastProcessFunction on them, thereby creating a transformed output
stream. |
<R> SingleOutputStreamOperator<R> |
ConnectedStreams.process(CoProcessFunction<IN1,IN2,R> coProcessFunction)
Applies the given
CoProcessFunction on the connected input streams, thereby creating
a transformed output stream. |
<KEY,OUT> SingleOutputStreamOperator<OUT> |
BroadcastConnectedStream.process(KeyedBroadcastProcessFunction<KEY,IN1,IN2,OUT> function)
Assumes as inputs a
BroadcastStream and a KeyedStream and applies the given
KeyedBroadcastProcessFunction on them, thereby creating a transformed output stream. |
<KEY,OUT> SingleOutputStreamOperator<OUT> |
BroadcastConnectedStream.process(KeyedBroadcastProcessFunction<KEY,IN1,IN2,OUT> function,
TypeInformation<OUT> outTypeInfo)
Assumes as inputs a
BroadcastStream and a KeyedStream and applies the given
KeyedBroadcastProcessFunction on them, thereby creating a transformed output stream. |
<K,R> SingleOutputStreamOperator<R> |
ConnectedStreams.process(KeyedCoProcessFunction<K,IN1,IN2,R> keyedCoProcessFunction)
Applies the given
KeyedCoProcessFunction on the connected input keyed streams,
thereby creating a transformed output stream. |
<R> SingleOutputStreamOperator<R> |
KeyedStream.process(KeyedProcessFunction<KEY,T,R> keyedProcessFunction)
Applies the given
KeyedProcessFunction on the input stream, thereby creating a
transformed output stream. |
<R> SingleOutputStreamOperator<R> |
AllWindowedStream.process(ProcessAllWindowFunction<T,R,W> function)
Applies the given window function to each window.
|
<R> SingleOutputStreamOperator<R> |
AllWindowedStream.process(ProcessAllWindowFunction<T,R,W> function,
TypeInformation<R> resultType)
Applies the given window function to each window.
|
<R> SingleOutputStreamOperator<R> |
KeyedStream.process(ProcessFunction<T,R> processFunction)
Deprecated.
|
<R> SingleOutputStreamOperator<R> |
DataStream.process(ProcessFunction<T,R> processFunction)
Applies the given
ProcessFunction on the input stream, thereby creating a transformed
output stream. |
<OUT> SingleOutputStreamOperator<OUT> |
KeyedStream.IntervalJoined.process(ProcessJoinFunction<IN1,IN2,OUT> processJoinFunction)
Completes the join operation with the given user function that is executed for each
joined pair of elements.
|
<OUT> SingleOutputStreamOperator<OUT> |
KeyedStream.IntervalJoined.process(ProcessJoinFunction<IN1,IN2,OUT> processJoinFunction,
TypeInformation<OUT> outputType)
Completes the join operation with the given user function that is executed for each
joined pair of elements.
|
<R> SingleOutputStreamOperator<R> |
WindowedStream.process(ProcessWindowFunction<T,R,K,W> function)
Applies the given window function to each window.
|
<R extends Tuple> |
DataStream.project(int... fieldIndexes)
Initiates a Project transformation on a
Tuple DataStream .Note: Only Tuple DataStreams can be projected. |
<R> SingleOutputStreamOperator<R> |
AllWindowedStream.reduce(ReduceFunction<T> reduceFunction,
AllWindowFunction<T,R,W> function)
Applies the given window function to each window.
|
<R> SingleOutputStreamOperator<R> |
AllWindowedStream.reduce(ReduceFunction<T> reduceFunction,
AllWindowFunction<T,R,W> function,
TypeInformation<R> resultType)
Applies the given window function to each window.
|
<R> SingleOutputStreamOperator<R> |
AllWindowedStream.reduce(ReduceFunction<T> reduceFunction,
ProcessAllWindowFunction<T,R,W> function)
Applies the given window function to each window.
|
<R> SingleOutputStreamOperator<R> |
AllWindowedStream.reduce(ReduceFunction<T> reduceFunction,
ProcessAllWindowFunction<T,R,W> function,
TypeInformation<R> resultType)
Applies the given window function to each window.
|
<R> SingleOutputStreamOperator<R> |
WindowedStream.reduce(ReduceFunction<T> reduceFunction,
ProcessWindowFunction<T,R,K,W> function)
Applies the given window function to each window.
|
DataStream<T> |
DataStream.rescale()
Sets the partitioning of the
DataStream so that the output elements are distributed
evenly to a subset of instances of the next operation in a round-robin fashion. |
SingleOutputStreamOperator<T> |
SingleOutputStreamOperator.setMaxParallelism(int maxParallelism)
Sets the maximum parallelism of this operator.
|
DataStreamSink<T> |
DataStreamSink.setUidHash(String uidHash)
Sets an user provided hash for this operator.
|
SingleOutputStreamOperator<T> |
SingleOutputStreamOperator.setUidHash(String uidHash)
Sets an user provided hash for this operator.
|
DataStream<T> |
DataStream.shuffle()
Sets the partitioning of the
DataStream so that the output elements are shuffled
uniformly randomly to the next operation. |
WindowedStream<T,K,W> |
WindowedStream.sideOutputLateData(OutputTag<T> outputTag)
Send late arriving data to the side output identified by the given
OutputTag . |
AllWindowedStream<T,W> |
AllWindowedStream.sideOutputLateData(OutputTag<T> outputTag)
Send late arriving data to the side output identified by the given
OutputTag . |
DataStreamSink<T> |
DataStreamSink.slotSharingGroup(String slotSharingGroup)
Sets the slot sharing group of this operation.
|
SingleOutputStreamOperator<T> |
SingleOutputStreamOperator.slotSharingGroup(String slotSharingGroup)
Sets the slot sharing group of this operation.
|
SingleOutputStreamOperator<T> |
SingleOutputStreamOperator.startNewChain()
Starts a new task chain beginning at this operator.
|
<R> SingleOutputStreamOperator<R> |
DataStream.transform(String operatorName,
TypeInformation<R> outTypeInfo,
OneInputStreamOperator<T,R> operator)
Method for passing user defined operators along with the type information that will transform
the DataStream.
|
<R> SingleOutputStreamOperator<R> |
DataStream.transform(String operatorName,
TypeInformation<R> outTypeInfo,
OneInputStreamOperatorFactory<T,R> operatorFactory)
Method for passing user defined operators created by the given factory along with the type
information that will transform the DataStream.
|
<R> SingleOutputStreamOperator<R> |
ConnectedStreams.transform(String functionName,
TypeInformation<R> outTypeInfo,
TwoInputStreamOperator<IN1,IN2,R> operator) |
CoGroupedStreams.WithWindow<T1,T2,KEY,W> |
CoGroupedStreams.WithWindow.trigger(Trigger<? super CoGroupedStreams.TaggedUnion<T1,T2>,? super W> newTrigger)
Sets the
Trigger that should be used to trigger window emission. |
JoinedStreams.WithWindow<T1,T2,KEY,W> |
JoinedStreams.WithWindow.trigger(Trigger<? super CoGroupedStreams.TaggedUnion<T1,T2>,? super W> newTrigger)
Sets the
Trigger that should be used to trigger window emission. |
WindowedStream<T,K,W> |
WindowedStream.trigger(Trigger<? super T,? super W> trigger)
Sets the
Trigger that should be used to trigger window emission. |
AllWindowedStream<T,W> |
AllWindowedStream.trigger(Trigger<? super T,? super W> trigger)
Sets the
Trigger that should be used to trigger window emission. |
DataStreamSink<T> |
DataStreamSink.uid(String uid)
Sets an ID for this operator.
|
SingleOutputStreamOperator<T> |
SingleOutputStreamOperator.uid(String uid)
Sets an ID for this operator.
|
KeyedStream.IntervalJoined<IN1,IN2,KEY> |
KeyedStream.IntervalJoined.upperBoundExclusive()
Set the upper bound to be exclusive.
|
<W extends Window> |
CoGroupedStreams.Where.EqualTo.window(WindowAssigner<? super CoGroupedStreams.TaggedUnion<T1,T2>,W> assigner)
Specifies the window on which the co-group operation works.
|
<W extends Window> |
JoinedStreams.Where.EqualTo.window(WindowAssigner<? super CoGroupedStreams.TaggedUnion<T1,T2>,W> assigner)
Specifies the window on which the join operation works.
|
<W extends Window> |
KeyedStream.window(WindowAssigner<? super T,W> assigner)
Windows this data stream to a
WindowedStream , which evaluates windows over a key
grouped stream. |
<W extends Window> |
DataStream.windowAll(WindowAssigner<? super T,W> assigner)
Windows this data stream to a
AllWindowedStream , which evaluates windows over a non
key grouped stream. |
<T> SingleOutputStreamOperator<T> |
CoGroupedStreams.WithWindow.with(CoGroupFunction<T1,T2,T> function)
Deprecated.
This method will be removed once the
CoGroupedStreams.WithWindow.apply(CoGroupFunction) method
is fixed in the next major version of Flink (2.0). |
<T> SingleOutputStreamOperator<T> |
CoGroupedStreams.WithWindow.with(CoGroupFunction<T1,T2,T> function,
TypeInformation<T> resultType)
Deprecated.
This method will be removed once the
CoGroupedStreams.WithWindow.apply(CoGroupFunction,
TypeInformation) method is fixed in the next major version of Flink (2.0). |
<T> SingleOutputStreamOperator<T> |
JoinedStreams.WithWindow.with(FlatJoinFunction<T1,T2,T> function)
Deprecated.
This method will be removed once the
JoinedStreams.WithWindow.apply(FlatJoinFunction) method
is fixed in the next major version of Flink (2.0). |
<T> SingleOutputStreamOperator<T> |
JoinedStreams.WithWindow.with(FlatJoinFunction<T1,T2,T> function,
TypeInformation<T> resultType)
Deprecated.
This method will be replaced by
JoinedStreams.WithWindow.apply(FlatJoinFunction,
TypeInformation) in Flink 2.0. So use the JoinedStreams.WithWindow.apply(FlatJoinFunction,
TypeInformation) in the future. |
<T> SingleOutputStreamOperator<T> |
JoinedStreams.WithWindow.with(JoinFunction<T1,T2,T> function)
Deprecated.
This method will be removed once the
JoinedStreams.WithWindow.apply(JoinFunction) method is
fixed in the next major version of Flink (2.0). |
<T> SingleOutputStreamOperator<T> |
JoinedStreams.WithWindow.with(JoinFunction<T1,T2,T> function,
TypeInformation<T> resultType)
Deprecated.
This method will be removed once the
JoinedStreams.WithWindow.apply(JoinFunction,
TypeInformation) method is fixed in the next major version of Flink (2.0). |
DataStreamSink<T> |
DataStream.writeAsCsv(String path)
Deprecated.
Please use the
StreamingFileSink explicitly
using the DataStream.addSink(SinkFunction) method. |
DataStreamSink<T> |
DataStream.writeAsCsv(String path,
FileSystem.WriteMode writeMode)
Deprecated.
Please use the
StreamingFileSink explicitly
using the DataStream.addSink(SinkFunction) method. |
<X extends Tuple> |
DataStream.writeAsCsv(String path,
FileSystem.WriteMode writeMode,
String rowDelimiter,
String fieldDelimiter)
Deprecated.
Please use the
StreamingFileSink explicitly
using the DataStream.addSink(SinkFunction) method. |
DataStreamSink<T> |
DataStream.writeAsText(String path)
Deprecated.
Please use the
StreamingFileSink explicitly
using the DataStream.addSink(SinkFunction) method. |
DataStreamSink<T> |
DataStream.writeAsText(String path,
FileSystem.WriteMode writeMode)
Deprecated.
Please use the
StreamingFileSink explicitly
using the DataStream.addSink(SinkFunction) method. |
DataStreamSink<T> |
DataStream.writeToSocket(String hostName,
int port,
SerializationSchema<T> schema)
Writes the DataStream to a socket as a byte array.
|
DataStreamSink<T> |
DataStream.writeUsingOutputFormat(OutputFormat<T> format)
Deprecated.
Please use the
StreamingFileSink explicitly
using the DataStream.addSink(SinkFunction) method. |
Constructor and Description |
---|
AllWindowedStream(DataStream<T> input,
WindowAssigner<? super T,W> windowAssigner) |
WindowedStream(KeyedStream<T,K> input,
WindowAssigner<? super T,W> windowAssigner) |
WithWindow(DataStream<T1> input1,
DataStream<T2> input2,
KeySelector<T1,KEY> keySelector1,
KeySelector<T2,KEY> keySelector2,
TypeInformation<KEY> keyType,
WindowAssigner<? super CoGroupedStreams.TaggedUnion<T1,T2>,W> windowAssigner,
Trigger<? super CoGroupedStreams.TaggedUnion<T1,T2>,? super W> trigger,
Evictor<? super CoGroupedStreams.TaggedUnion<T1,T2>,? super W> evictor,
Time allowedLateness) |
Modifier and Type | Class and Description |
---|---|
static class |
CheckpointConfig.ExternalizedCheckpointCleanup
Cleanup behaviour for externalized checkpoints when the job is cancelled.
|
class |
ExecutionCheckpointingOptions
Execution
ConfigOption for configuring checkpointing related parameters. |
interface |
StreamExecutionEnvironmentFactory
Factory class for stream execution environments.
|
class |
StreamPipelineOptions
The
configuration options for job execution. |
Modifier and Type | Method and Description |
---|---|
void |
StreamExecutionEnvironment.clearJobListeners()
Clear all registered
JobListener s. |
void |
StreamExecutionEnvironment.configure(ReadableConfig configuration,
ClassLoader classLoader)
Sets all relevant options contained in the
ReadableConfig such as e.g. |
<OUT> DataStreamSource<OUT> |
StreamExecutionEnvironment.createInput(InputFormat<OUT,?> inputFormat)
Generic method to create an input data stream with
InputFormat . |
<OUT> DataStreamSource<OUT> |
StreamExecutionEnvironment.createInput(InputFormat<OUT,?> inputFormat,
TypeInformation<OUT> typeInfo)
Generic method to create an input data stream with
InputFormat . |
static StreamExecutionEnvironment |
StreamExecutionEnvironment.createLocalEnvironmentWithWebUI(Configuration conf)
Creates a
LocalStreamEnvironment for local program execution that also starts the web
monitoring UI. |
StreamExecutionEnvironment |
StreamExecutionEnvironment.disableOperatorChaining()
Disables operator chaining for streaming operators.
|
StreamExecutionEnvironment |
StreamExecutionEnvironment.enableCheckpointing()
Deprecated.
Use
StreamExecutionEnvironment.enableCheckpointing(long) instead. |
StreamExecutionEnvironment |
StreamExecutionEnvironment.enableCheckpointing(long interval,
CheckpointingMode mode,
boolean force)
Deprecated.
Use
StreamExecutionEnvironment.enableCheckpointing(long, CheckpointingMode) instead. Forcing
checkpoints will be removed in the future. |
void |
CheckpointConfig.enableExternalizedCheckpoints(CheckpointConfig.ExternalizedCheckpointCleanup cleanupMode)
Enables checkpoints to be persisted externally.
|
void |
CheckpointConfig.enableUnalignedCheckpoints()
Enables unaligned checkpoints, which greatly reduce checkpointing times under backpressure.
|
void |
CheckpointConfig.enableUnalignedCheckpoints(boolean enabled)
Enables unaligned checkpoints, which greatly reduce checkpointing times under backpressure.
|
JobClient |
StreamExecutionEnvironment.executeAsync()
Triggers the program asynchronously.
|
JobClient |
StreamExecutionEnvironment.executeAsync(String jobName)
Triggers the program execution asynchronously.
|
long |
CheckpointConfig.getAlignmentTimeout() |
static int |
StreamExecutionEnvironment.getDefaultLocalParallelism()
Gets the default parallelism that will be used for the local execution environment created by
StreamExecutionEnvironment.createLocalEnvironment() . |
CheckpointConfig.ExternalizedCheckpointCleanup |
CheckpointConfig.getExternalizedCheckpointCleanup()
Returns the cleanup behaviour for externalized checkpoints.
|
List<JobListener> |
StreamExecutionEnvironment.getJobListeners()
Gets the config JobListeners.
|
int |
StreamExecutionEnvironment.getNumberOfExecutionRetries()
Deprecated.
This method will be replaced by
StreamExecutionEnvironment.getRestartStrategy() . |
RestartStrategies.RestartStrategyConfiguration |
StreamExecutionEnvironment.getRestartStrategy()
Returns the specified restart strategy configuration.
|
StateBackend |
StreamExecutionEnvironment.getStateBackend()
Gets the state backend that defines how to store and checkpoint state.
|
TimeCharacteristic |
StreamExecutionEnvironment.getStreamTimeCharacteristic()
Deprecated.
See
StreamExecutionEnvironment.setStreamTimeCharacteristic(TimeCharacteristic) for deprecation
notice. |
boolean |
StreamExecutionEnvironment.isChainingEnabled()
Returns whether operator chaining is enabled.
|
boolean |
CheckpointConfig.isExternalizedCheckpointsEnabled()
Returns whether checkpoints should be persisted externally.
|
boolean |
CheckpointConfig.isForceCheckpointing()
Deprecated.
This will be removed once iterations properly participate in checkpointing.
|
boolean |
StreamExecutionEnvironment.isForceCheckpointing()
Deprecated.
Forcing checkpoints will be removed in future version.
|
boolean |
CheckpointConfig.isForceUnalignedCheckpoints()
Checks whether Unaligned Checkpoints are forced, despite iteration feedback.
|
boolean |
StreamExecutionEnvironment.isForceUnalignedCheckpoints()
Returns whether Unaligned Checkpoints are force-enabled.
|
boolean |
CheckpointConfig.isPreferCheckpointForRecovery()
Deprecated.
Don't activate prefer checkpoints for recovery because it can lead to data loss
and duplicate output. This option will soon be removed. See FLINK-20427 for more
information.
|
boolean |
CheckpointConfig.isUnalignedCheckpointsEnabled()
Returns whether unaligned checkpoints are enabled.
|
boolean |
StreamExecutionEnvironment.isUnalignedCheckpointsEnabled()
Returns whether Unaligned Checkpoints are enabled.
|
<OUT> DataStreamSource<OUT> |
StreamExecutionEnvironment.readFile(FileInputFormat<OUT> inputFormat,
String filePath,
FileProcessingMode watchType,
long interval)
Reads the contents of the user-specified
filePath based on the given FileInputFormat . |
<OUT> DataStreamSource<OUT> |
StreamExecutionEnvironment.readFile(FileInputFormat<OUT> inputFormat,
String filePath,
FileProcessingMode watchType,
long interval,
FilePathFilter filter)
Deprecated.
|
<OUT> DataStreamSource<OUT> |
StreamExecutionEnvironment.readFile(FileInputFormat<OUT> inputFormat,
String filePath,
FileProcessingMode watchType,
long interval,
TypeInformation<OUT> typeInformation)
Reads the contents of the user-specified
filePath based on the given FileInputFormat . |
void |
StreamExecutionEnvironment.registerJobListener(JobListener jobListener)
Register a
JobListener in this environment. |
void |
CheckpointConfig.setAlignmentTimeout(long alignmentTimeout)
Only relevant if
CheckpointConfig.unalignedCheckpointsEnabled is enabled. |
static void |
StreamExecutionEnvironment.setDefaultLocalParallelism(int parallelism)
Sets the default parallelism that will be used for the local execution environment created by
StreamExecutionEnvironment.createLocalEnvironment() . |
void |
CheckpointConfig.setForceCheckpointing(boolean forceCheckpointing)
Deprecated.
This will be removed once iterations properly participate in checkpointing.
|
void |
CheckpointConfig.setForceUnalignedCheckpoints(boolean forceUnalignedCheckpoints)
Checks whether Unaligned Checkpoints are forced, despite currently non-checkpointable
iteration feedback.
|
void |
StreamExecutionEnvironment.setNumberOfExecutionRetries(int numberOfExecutionRetries)
Deprecated.
This method will be replaced by
StreamExecutionEnvironment.setRestartStrategy(org.apache.flink.api.common.restartstrategy.RestartStrategies.RestartStrategyConfiguration) . The RestartStrategies.fixedDelayRestart(int, Time) contains the number of execution retries. |
void |
CheckpointConfig.setPreferCheckpointForRecovery(boolean preferCheckpointForRecovery)
Deprecated.
Don't activate prefer checkpoints for recovery because it can lead to data loss
and duplicate output. This option will soon be removed. See FLINK-20427 for more
information.
|
void |
StreamExecutionEnvironment.setRestartStrategy(RestartStrategies.RestartStrategyConfiguration restartStrategyConfiguration)
Sets the restart strategy configuration.
|
StreamExecutionEnvironment |
StreamExecutionEnvironment.setRuntimeMode(RuntimeExecutionMode executionMode)
Sets the runtime execution mode for the application (see
RuntimeExecutionMode ). |
StreamExecutionEnvironment |
StreamExecutionEnvironment.setStateBackend(StateBackend backend)
Sets the state backend that describes how to store and checkpoint operator state.
|
void |
StreamExecutionEnvironment.setStreamTimeCharacteristic(TimeCharacteristic characteristic)
Deprecated.
In Flink 1.12 the default stream time characteristic has been changed to
TimeCharacteristic.EventTime , thus you don't need to call this method for enabling
event-time support anymore. Explicitly using processing-time windows and timers works in
event-time mode. If you need to disable watermarks, please use ExecutionConfig.setAutoWatermarkInterval(long) . If you are using TimeCharacteristic.IngestionTime , please manually set an appropriate WatermarkStrategy . If you are using generic "time window" operations (for example KeyedStream.timeWindow(org.apache.flink.streaming.api.windowing.time.Time)
that change behaviour based on the time characteristic, please use equivalent operations
that explicitly specify processing time or event time. |
DataStreamSource<String> |
StreamExecutionEnvironment.socketTextStream(String hostname,
int port)
Creates a new data stream that contains the strings received infinitely from a socket.
|
DataStreamSource<String> |
StreamExecutionEnvironment.socketTextStream(String hostname,
int port,
String delimiter)
Creates a new data stream that contains the strings received infinitely from a socket.
|
DataStreamSource<String> |
StreamExecutionEnvironment.socketTextStream(String hostname,
int port,
String delimiter,
long maxRetry)
Creates a new data stream that contains the strings received infinitely from a socket.
|
Constructor and Description |
---|
RemoteStreamEnvironment(PipelineExecutorServiceLoader executorServiceLoader,
String host,
int port,
Configuration clientConfiguration,
String[] jarFiles,
URL[] globalClasspaths,
SavepointRestoreSettings savepointRestoreSettings) |
RemoteStreamEnvironment(String host,
int port,
Configuration clientConfiguration,
String[] jarFiles,
URL[] globalClasspaths,
SavepointRestoreSettings savepointRestoreSettings)
Creates a new RemoteStreamEnvironment that points to the master (JobManager) described by the
given host name and port.
|
StreamExecutionEnvironment(Configuration configuration)
Creates a new
StreamExecutionEnvironment that will use the given Configuration to configure the PipelineExecutor . |
StreamExecutionEnvironment(Configuration configuration,
ClassLoader userClassloader)
Creates a new
StreamExecutionEnvironment that will use the given Configuration to configure the PipelineExecutor . |
StreamExecutionEnvironment(PipelineExecutorServiceLoader executorServiceLoader,
Configuration configuration,
ClassLoader userClassloader)
Creates a new
StreamExecutionEnvironment that will use the given Configuration to configure the PipelineExecutor . |
Modifier and Type | Class and Description |
---|---|
class |
AscendingTimestampExtractor<T>
Deprecated.
Extend
AscendingTimestampExtractor instead. |
class |
KeyedProcessFunction<K,I,O>
A keyed function that processes elements of a stream.
|
class |
ProcessFunction<I,O>
A function that processes elements of a stream.
|
Modifier and Type | Interface and Description |
---|---|
interface |
AsyncFunction<IN,OUT>
A function to trigger Async I/O operation.
|
interface |
ResultFuture<OUT>
ResultFuture collects data / error in user codes while processing async i/o. |
class |
RichAsyncFunction<IN,OUT>
Rich variant of the
AsyncFunction . |
Modifier and Type | Class and Description |
---|---|
class |
BaseBroadcastProcessFunction
The base class containing the functionality available to all broadcast process function.
|
class |
BroadcastProcessFunction<IN1,IN2,OUT>
A function to be applied to a
BroadcastConnectedStream that
connects BroadcastStream , i.e. |
class |
CoProcessFunction<IN1,IN2,OUT>
A function that processes elements of two streams and produces a single output one.
|
class |
KeyedBroadcastProcessFunction<KS,IN1,IN2,OUT>
A function to be applied to a
BroadcastConnectedStream that
connects BroadcastStream , i.e. |
class |
KeyedCoProcessFunction<K,IN1,IN2,OUT>
A function that processes elements of two keyed streams and produces a single output one.
|
class |
ProcessJoinFunction<IN1,IN2,OUT>
A function that processes two joined elements and produces a single output one.
|
Modifier and Type | Class and Description |
---|---|
class |
OutputFormatSinkFunction<IN>
Deprecated.
Please use the
StreamingFileSink
for writing to files from a streaming program. |
class |
PrintSinkFunction<IN>
Implementation of the SinkFunction writing every tuple to the standard output or standard error
stream.
|
class |
SocketClientSink<IN>
Socket client that acts as a streaming sink.
|
class |
TwoPhaseCommitSinkFunction<IN,TXN,CONTEXT>
This is a recommended base class for all of the
SinkFunction that intend to implement
exactly-once semantic. |
class |
WriteFormat<IN>
Deprecated.
Please use the
StreamingFileSink
for writing to files from a streaming program. |
class |
WriteFormatAsCsv<IN>
Deprecated.
Please use the
StreamingFileSink
for writing to files from a streaming program. |
class |
WriteFormatAsText<IN>
Deprecated.
Please use the
StreamingFileSink
for writing to files from a streaming program. |
class |
WriteSinkFunction<IN>
Deprecated.
Please use the
StreamingFileSink
for writing to files from a streaming program. |
class |
WriteSinkFunctionByMillis<IN>
Deprecated.
Please use the
StreamingFileSink
for writing to files from a streaming program. |
Modifier and Type | Interface and Description |
---|---|
interface |
BucketAssigner<IN,BucketID>
A BucketAssigner is used with a file sink to determine the bucket each incoming element should be
put into.
|
static interface |
BucketAssigner.Context
Context that the
BucketAssigner can use for getting additional data about an input
record. |
static class |
OutputFileConfig.OutputFileConfigBuilder
A builder to create the part file configuration.
|
interface |
PartFileInfo<BucketID>
An interface exposing the information concerning the current (open) part file that is necessary
to the
RollingPolicy in order to determine if it should roll the part file or not. |
interface |
RollingPolicy<IN,BucketID>
The policy based on which a
Bucket in the Filesystem Sink rolls its currently
open part file and opens a new one. |
class |
StreamingFileSink<IN>
Sink that emits its input elements to
FileSystem files within buckets. |
static class |
StreamingFileSink.BulkFormatBuilder<IN,BucketID,T extends StreamingFileSink.BulkFormatBuilder<IN,BucketID,T>>
A builder for configuring the sink for bulk-encoding formats, e.g.
|
static class |
StreamingFileSink.RowFormatBuilder<IN,BucketID,T extends StreamingFileSink.RowFormatBuilder<IN,BucketID,T>>
A builder for configuring the sink for row-wise encoding formats.
|
Modifier and Type | Class and Description |
---|---|
class |
BasePathBucketAssigner<T>
A
BucketAssigner that does not perform any bucketing of files. |
class |
DateTimeBucketAssigner<IN>
A
BucketAssigner that assigns to buckets based on current system time. |
class |
SimpleVersionedStringSerializer
A
SimpleVersionedSerializer implementation for Strings. |
Modifier and Type | Class and Description |
---|---|
class |
CheckpointRollingPolicy<IN,BucketID>
An abstract
RollingPolicy which rolls on every checkpoint. |
class |
DefaultRollingPolicy<IN,BucketID>
The default implementation of the
RollingPolicy . |
static class |
DefaultRollingPolicy.PolicyBuilder
A helper class that holds the configuration properties for the
DefaultRollingPolicy . |
class |
OnCheckpointRollingPolicy<IN,BucketID>
A
RollingPolicy which rolls (ONLY) on every checkpoint. |
Modifier and Type | Class and Description |
---|---|
class |
FileProcessingMode
The mode in which the
ContinuousFileMonitoringFunction operates. |
class |
FromElementsFunction<T>
A stream source function that returns a sequence of elements.
|
class |
FromIteratorFunction<T>
A
SourceFunction that reads elements from an Iterator and emits them. |
class |
FromSplittableIteratorFunction<T>
A
SourceFunction that reads elements from an SplittableIterator and emits them. |
class |
MessageAcknowledgingSourceBase<Type,UId>
Abstract base class for data sources that receive elements from a message queue and acknowledge
them back by IDs.
|
class |
MultipleIdsMessageAcknowledgingSourceBase<Type,UId,SessionId>
Abstract base class for data sources that receive elements from a message queue and acknowledge
them back by IDs.
|
class |
SocketTextStreamFunction
A source function that reads strings from a socket.
|
class |
StatefulSequenceSource
A stateful streaming source that emits each number from a given interval exactly once, possibly
in parallel.
|
Modifier and Type | Method and Description |
---|---|
void |
SourceFunction.SourceContext.collectWithTimestamp(T element,
long timestamp)
Emits one element from the source, and attaches the given timestamp.
|
void |
SourceFunction.SourceContext.emitWatermark(Watermark mark)
Emits the given
Watermark . |
void |
SourceFunction.SourceContext.markAsTemporarilyIdle()
Marks the source to be temporarily idle.
|
Modifier and Type | Class and Description |
---|---|
class |
AscendingTimestampExtractor<T>
Deprecated.
|
Modifier and Type | Class and Description |
---|---|
class |
ProcessAllWindowFunction<IN,OUT,W extends Window>
Base abstract class for functions that are evaluated over non-keyed windows using a context for
retrieving extra information.
|
class |
ProcessWindowFunction<IN,OUT,KEY,W extends Window>
Base abstract class for functions that are evaluated over keyed (grouped) windows using a context
for retrieving extra information.
|
class |
RichProcessAllWindowFunction<IN,OUT,W extends Window>
Deprecated.
use
ProcessAllWindowFunction instead |
class |
RichProcessWindowFunction<IN,OUT,KEY,W extends Window>
Deprecated.
use
ProcessWindowFunction instead |
Modifier and Type | Class and Description |
---|---|
class |
CosineDistance<DATA>
This delta function calculates the cosine distance between two given vectors.
|
interface |
DeltaFunction<DATA>
This interface allows the implementation of a function which calculates the delta between two
data points.
|
class |
EuclideanDistance<DATA>
This delta function calculates the euclidean distance between two given points.
|
class |
ExtractionAwareDeltaFunction<DATA,TO>
Extend this abstract class to implement a delta function which is aware of extracting the data on
which the delta is calculated from a more complex data structure.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractStreamOperator<OUT>
Base class for all stream operators.
|
class |
AbstractUdfStreamOperator<OUT,F extends Function>
This is used as the base class for operators that have a user-defined function.
|
interface |
BoundedMultiInput
Interface for the multi-input operators that can process EndOfInput event.
|
interface |
BoundedOneInput
Interface for the one-input operators that can process EndOfInput event.
|
class |
ChainingStrategy
Defines the chaining scheme for the operator.
|
interface |
Input<IN>
Input interface used in MultipleInputStreamOperator . |
interface |
InputSelectable
Interface for stream operators that can select the input to get
StreamRecord . |
class |
InputSelection
Describe the input selection that stream operators want to read records.
|
interface |
MailboxExecutor
Executor like interface for an build around a mailbox-based
execution model (see TaskMailbox ). |
interface |
MultipleInputStreamOperator<OUT>
Interface for stream operators with multiple
Input s. |
interface |
OneInputStreamOperator<IN,OUT>
Interface for stream operators with one input.
|
interface |
Output<T>
A
StreamOperator is supplied with an object of
this interface that can be used to emit elements and other messages, such as barriers and
watermarks, from an operator. |
interface |
OutputTypeConfigurable<OUT>
Stream operators can implement this interface if they need access to the output type information
at
StreamGraph generation. |
interface |
SetupableStreamOperator<OUT>
Deprecated.
This class is deprecated in favour of using
StreamOperatorFactory and it's
StreamOperatorFactory.createStreamOperator(org.apache.flink.streaming.api.operators.StreamOperatorParameters<OUT>) and passing the required parameters to the
Operator's constructor in create method. |
interface |
StreamOperator<OUT>
Basic interface for stream operators.
|
interface |
TwoInputStreamOperator<IN1,IN2,OUT>
Interface for stream operators with two inputs.
|
Modifier and Type | Class and Description |
---|---|
class |
ShuffleMode
The shuffle mode defines the data exchange mode between operators.
|
Modifier and Type | Class and Description |
---|---|
class |
Watermark
A Watermark tells operators that no elements with a timestamp older or equal to the watermark
timestamp should arrive at the operator.
|
Modifier and Type | Class and Description |
---|---|
class |
DynamicEventTimeSessionWindows<T>
A
WindowAssigner that windows elements into sessions based on the timestamp of the
elements. |
class |
DynamicProcessingTimeSessionWindows<T>
A
WindowAssigner that windows elements into sessions based on the current processing
time. |
class |
GlobalWindows
A
WindowAssigner that assigns all elements to the same GlobalWindow . |
class |
MergingWindowAssigner<T,W extends Window>
A
WindowAssigner that can merge windows. |
interface |
SessionWindowTimeGapExtractor<T>
A
SessionWindowTimeGapExtractor extracts session time gaps for Dynamic Session Window
Assigners. |
class |
SlidingEventTimeWindows
A
WindowAssigner that windows elements into sliding windows based on the timestamp of the
elements. |
class |
SlidingTimeWindows
Deprecated.
Please use
SlidingEventTimeWindows . |
class |
TumblingEventTimeWindows
A
WindowAssigner that windows elements into windows based on the timestamp of the
elements. |
class |
TumblingTimeWindows
Deprecated.
Please use
TumblingEventTimeWindows . |
class |
WindowAssigner<T,W extends Window>
A
WindowAssigner assigns zero or more Windows to an element. |
class |
WindowStagger
A
WindowStagger staggers offset in runtime for each window assignment. |
Modifier and Type | Method and Description |
---|---|
static TumblingProcessingTimeWindows |
TumblingProcessingTimeWindows.of(Time size,
Time offset,
WindowStagger windowStagger)
Creates a new
TumblingProcessingTimeWindows WindowAssigner that assigns
elements to time windows based on the element timestamp, offset and a staggering offset,
depending on the staggering policy. |
static TumblingEventTimeWindows |
TumblingEventTimeWindows.of(Time size,
Time offset,
WindowStagger windowStagger)
Creates a new
TumblingEventTimeWindows WindowAssigner that assigns elements
to time windows based on the element timestamp, offset and a staggering offset, depending on
the staggering policy. |
static <T> DynamicProcessingTimeSessionWindows<T> |
ProcessingTimeSessionWindows.withDynamicGap(SessionWindowTimeGapExtractor<T> sessionWindowTimeGapExtractor)
Creates a new
SessionWindows WindowAssigner that assigns elements to sessions
based on the element timestamp. |
static <T> DynamicEventTimeSessionWindows<T> |
EventTimeSessionWindows.withDynamicGap(SessionWindowTimeGapExtractor<T> sessionWindowTimeGapExtractor)
Creates a new
SessionWindows WindowAssigner that assigns elements to sessions
based on the element timestamp. |
Modifier and Type | Class and Description |
---|---|
class |
CountEvictor<W extends Window>
An
Evictor that keeps up to a certain amount of elements. |
class |
DeltaEvictor<T,W extends Window>
An
Evictor that keeps elements based on a DeltaFunction and a threshold. |
interface |
Evictor<T,W extends Window>
An
Evictor can remove elements from a pane before/after the evaluation of WindowFunction
and after the window evaluation gets triggered by a Trigger |
class |
TimeEvictor<W extends Window>
An
Evictor that keeps elements for a certain amount of time. |
Modifier and Type | Class and Description |
---|---|
class |
ContinuousEventTimeTrigger<W extends Window>
A
Trigger that continuously fires based on a given time interval. |
class |
ContinuousProcessingTimeTrigger<W extends Window>
A
Trigger that continuously fires based on a given time interval as measured by the clock
of the machine on which the job is running. |
class |
CountTrigger<W extends Window>
A
Trigger that fires once the count of elements in a pane reaches the given count. |
class |
DeltaTrigger<T,W extends Window>
A
Trigger that fires based on a DeltaFunction and a threshold. |
class |
EventTimeTrigger
A
Trigger that fires once the watermark passes the end of the window to which a pane
belongs. |
class |
ProcessingTimeoutTrigger<T,W extends Window>
|
class |
ProcessingTimeTrigger
A
Trigger that fires once the current system time passes the end of the window to which a
pane belongs. |
class |
PurgingTrigger<T,W extends Window>
A trigger that can turn any
Trigger into a purging Trigger . |
class |
Trigger<T,W extends Window>
A
Trigger determines when a pane of a window should be evaluated to emit the results for
that part of the window. |
Modifier and Type | Class and Description |
---|---|
class |
GlobalWindow
The default window into which all data is placed (via
GlobalWindows ). |
class |
TimeWindow
|
class |
Window
A
Window is a grouping of elements into finite buckets. |
Modifier and Type | Interface and Description |
---|---|
interface |
CassandraFailureHandler
An implementation of
CassandraFailureHandler is provided by the user to define how Throwable should be handled, e.g. |
Modifier and Type | Method and Description |
---|---|
CassandraSink<IN> |
CassandraSink.setUidHash(String uidHash)
Sets an user provided hash for this operator.
|
CassandraSink<IN> |
CassandraSink.uid(String uid)
Sets an ID for this operator.
|
Modifier and Type | Interface and Description |
---|---|
interface |
ActionRequestFailureHandler
An implementation of
ActionRequestFailureHandler is provided by the user to define how
failed ActionRequests should be handled, e.g. |
static class |
ElasticsearchSinkBase.FlushBackoffType
Used to control whether the retry delay should increase exponentially or remain constant.
|
interface |
ElasticsearchSinkFunction<T>
Creates multiple
ActionRequests from an element in a stream. |
interface |
RequestIndexer
Users add multiple delete, index or update requests to a
RequestIndexer to prepare them
for sending to an Elasticsearch cluster. |
Modifier and Type | Class and Description |
---|---|
class |
RetryRejectedExecutionFailureHandler
An
ActionRequestFailureHandler that re-adds requests that failed due to temporary EsRejectedExecutionException s (which means that Elasticsearch node queues are currently full),
and fails for all other failures. |
Modifier and Type | Class and Description |
---|---|
class |
ElasticsearchSink<T>
Elasticsearch 5.x sink that requests multiple
ActionRequests against a
cluster for each incoming element. |
Modifier and Type | Class and Description |
---|---|
class |
ElasticsearchSink<T>
Elasticsearch 6.x sink that requests multiple
ActionRequests against a
cluster for each incoming element. |
static class |
ElasticsearchSink.Builder<T>
A builder for creating an
ElasticsearchSink . |
interface |
RestClientFactory
A factory that is used to configure the
RestHighLevelClient
internally used in the ElasticsearchSink . |
Modifier and Type | Class and Description |
---|---|
class |
ElasticsearchSink<T>
Elasticsearch 7.x sink that requests multiple
ActionRequests against a
cluster for each incoming element. |
static class |
ElasticsearchSink.Builder<T>
A builder for creating an
ElasticsearchSink . |
interface |
RestClientFactory
A factory that is used to configure the
RestHighLevelClient
internally used in the ElasticsearchSink . |
Modifier and Type | Class and Description |
---|---|
class |
FlinkKafkaConsumer<T>
The Flink Kafka Consumer is a streaming data source that pulls a parallel data stream from Apache
Kafka.
|
class |
FlinkKafkaErrorCode
Error codes used in
FlinkKafkaException . |
class |
FlinkKafkaException
Exception used by
FlinkKafkaProducer and FlinkKafkaConsumer . |
class |
FlinkKafkaProducer<IN>
Flink Sink to produce data into a Kafka topic.
|
interface |
KafkaContextAware<T>
An interface for
KafkaSerializationSchemas that need information
about the context where the Kafka Producer is running along with information about the available
partitions. |
interface |
KafkaDeserializationSchema<T>
The deserialization schema describes how to turn the Kafka ConsumerRecords into data types
(Java/Scala objects) that are processed by Flink.
|
interface |
KafkaSerializationSchema<T>
|
Modifier and Type | Class and Description |
---|---|
class |
FlinkKafkaInternalProducer<K,V>
Internal flink kafka producer.
|
class |
KafkaTopicPartition
Flink's description of a partition in a Kafka topic.
|
Modifier and Type | Class and Description |
---|---|
class |
FlinkFixedPartitioner<T>
A partitioner ensuring that each internal Flink partition ends up in one Kafka partition.
|
class |
FlinkKafkaPartitioner<T>
A
FlinkKafkaPartitioner wraps logic on how to partition records across partitions of
multiple Kafka topics. |
Modifier and Type | Class and Description |
---|---|
class |
FixedKinesisPartitioner<T>
A partitioner ensuring that each internal Flink partition ends up in the same Kinesis partition.
|
class |
FlinkKinesisConsumer<T>
The Flink Kinesis Consumer is an exactly-once parallel streaming data source that subscribes to
multiple AWS Kinesis streams within the same AWS service region, and can handle resharding of
streams.
|
class |
FlinkKinesisProducer<OUT>
The FlinkKinesisProducer allows to produce from a Flink DataStream into Kinesis.
|
class |
KinesisPartitioner<T>
An interface for partitioning records.
|
interface |
KinesisShardAssigner
Utility to map Kinesis shards to Flink subtask indices.
|
class |
RandomKinesisPartitioner<T>
A
KinesisPartitioner that maps an arbitrary input element to a random partition
ID. |
Modifier and Type | Class and Description |
---|---|
class |
AWSConfigConstants
Configuration keys for AWS service usage.
|
class |
ConsumerConfigConstants
Optional consumer specific configuration keys and default values for
FlinkKinesisConsumer . |
Modifier and Type | Interface and Description |
---|---|
interface |
KinesisDeserializationSchema<T>
This is a deserialization schema specific for the Flink Kinesis Consumer.
|
interface |
KinesisSerializationSchema<T>
Kinesis-specific serialization schema, allowing users to specify a target stream based on a
record's contents.
|
Modifier and Type | Class and Description |
---|---|
class |
JobManagerWatermarkTracker
A
WatermarkTracker that shares state through GlobalAggregateManager . |
class |
WatermarkTracker
The watermark tracker is responsible for aggregating watermarks across distributed operators.
|
Modifier and Type | Interface and Description |
---|---|
interface |
RMQDeserializationSchema<T>
Interface for the set of methods required to parse an RMQ delivery.
|
interface |
RMQSinkPublishOptions<IN>
The message computation provides methods to compute the message routing key and/or the
properties.
|
Constructor and Description |
---|
RMQSink(RMQConnectionConfig rmqConnectionConfig,
SerializationSchema<IN> schema,
RMQSinkPublishOptions<IN> publishOptions) |
RMQSink(RMQConnectionConfig rmqConnectionConfig,
SerializationSchema<IN> schema,
RMQSinkPublishOptions<IN> publishOptions,
SerializableReturnListener returnListener) |
RMQSink(RMQConnectionConfig rmqConnectionConfig,
String queueName,
SerializationSchema<IN> schema) |
Modifier and Type | Class and Description |
---|---|
class |
TimestampedValue<T>
Stores the value and the timestamp of the record.
|
Modifier and Type | Class and Description |
---|---|
class |
LatencyMarker
Special record type carrying a timestamp of its creation time at a source operator and the
vertexId and subtask index of the operator.
|
Modifier and Type | Interface and Description |
---|---|
interface |
ProcessingTimeServiceAware
Interface for
StreamOperatorFactory , which
enables stream operators to access ProcessingTimeService . |
Modifier and Type | Class and Description |
---|---|
class |
AbstractDeserializationSchema<T>
Deprecated.
Use
AbstractDeserializationSchema
instead. |
class |
JSONKeyValueDeserializationSchema
DeserializationSchema that deserializes a JSON String into an ObjectNode.
|
interface |
KeyedDeserializationSchema<T>
Deprecated.
|
interface |
KeyedSerializationSchema<T>
Deprecated.
|
class |
SimpleStringSchema
Deprecated.
Use
SimpleStringSchema instead. |
class |
TypeInformationKeyValueSerializationSchema<K,V>
A serialization and deserialization schema for Key Value Pairs that uses Flink's serialization
stack to transform typed from and to byte arrays.
|
Modifier and Type | Class and Description |
---|---|
interface |
DataTypeHint
A hint that influences the reflection-based extraction of a
DataType . |
class |
ExtractionVersion
Logical version that describes the expected behavior of the reflection-based data type
extraction.
|
interface |
FunctionHint
A hint that influences the reflection-based extraction of input types, accumulator types, and
output types for constructing the
TypeInference logic of a UserDefinedFunction . |
interface |
FunctionHints
Helper annotation for repeatable
FunctionHint s. |
class |
HintFlag
Three-valued flag for representing
TRUE , FALSE , and UNKNOWN . |
class |
InputGroup
A list of commonly used pre-defined groups of similar types for accepting more than just one data
type as an input argument in
DataTypeHint s. |
Modifier and Type | Interface and Description |
---|---|
interface |
AggregatedTable
A table that has been performed on the aggregate function.
|
class |
CatalogNotExistException
Exception for an operation on a nonexistent catalog.
|
class |
DataTypes
A
DataType can be used to declare input and/or output types of operations. |
class |
EnvironmentSettings
Defines all parameters that initialize a table environment.
|
class |
ExplainDetail
ExplainDetail defines the types of details for explain result.
|
class |
Expressions
Entry point of the Table API Expression DSL such as:
$("myField").plus(10).abs() |
interface |
FlatAggregateTable
|
interface |
GroupedTable
A table that has been grouped on a set of grouping keys.
|
class |
GroupWindow
A group window specification.
|
interface |
GroupWindowedTable
A table that has been windowed for
GroupWindow s. |
class |
Over
Helper class for creating an over window.
|
class |
OverWindow
An over window specification.
|
interface |
OverWindowedTable
A table that has been windowed for
OverWindow s. |
class |
OverWindowPartitioned
Partially defined over window with partitioning.
|
class |
OverWindowPartitionedOrdered
Partially defined over window with (optional) partitioning and order.
|
class |
OverWindowPartitionedOrderedPreceding
Partially defined over window with (optional) partitioning, order, and preceding.
|
interface |
PlannerConfig
The
PlannerConfig holds parameters to configure the behavior of queries. |
class |
ResultKind
ResultKind defines the types of the result.
|
class |
Session
Helper class for creating a session window.
|
class |
SessionWithGap
Session window.
|
class |
SessionWithGapOnTime
Session window on time.
|
class |
SessionWithGapOnTimeWithAlias
Session window on time with alias.
|
class |
Slide
Helper class for creating a sliding window.
|
class |
SlideWithSize
Partially specified sliding window.
|
class |
SlideWithSizeAndSlide
Sliding window.
|
class |
SlideWithSizeAndSlideOnTime
Sliding window on time.
|
class |
SlideWithSizeAndSlideOnTimeWithAlias
Sliding window on time with alias.
|
class |
SqlDialect
Enumeration of valid SQL compatibility modes.
|
class |
SqlParserException
Exception for all errors occurring during sql parsing.
|
interface |
StatementSet
A
StatementSet accepts DML statements or Table s, the planner can optimize all
added statements and Tables together and then submit as one job. |
interface |
Table
A Table is the core component of the Table API.
|
class |
TableColumn
Representation of a table column in the API.
|
class |
TableConfig
Configuration for the current
TableEnvironment session to adjust Table & SQL API
programs. |
interface |
TableEnvironment
A table environment is the base class, entry point, and central context for creating Table and
SQL API programs.
|
class |
TableException
General Exception for all errors during table handling.
|
class |
TableNotExistException
Exception for an operation on a nonexistent table.
|
interface |
TableResult
A TableResult is the representation of the statement execution result.
|
class |
TableSchema
A table schema that represents a table's structure with field names and data types.
|
class |
Tumble
Helper class for creating a tumbling window.
|
class |
TumbleWithSize
Tumbling window.
|
class |
TumbleWithSizeOnTime
Tumbling window on time.
|
class |
TumbleWithSizeOnTimeWithAlias
Tumbling window on time with alias.
|
class |
ValidationException
Exception for all errors occurring during validation phase.
|
interface |
WindowGroupedTable
A table that has been windowed and grouped for
GroupWindow s. |
Modifier and Type | Interface and Description |
---|---|
interface |
BatchTableEnvironment
|
interface |
StreamTableEnvironment
This table environment is the entry point and central context for creating Table and SQL API
programs that integrate with the Java-specific
DataStream API. |
Modifier and Type | Class and Description |
---|---|
class |
ExecutionConfigOptions
This class holds configuration constants used by Flink's table module.
|
class |
OptimizerConfigOptions
This class holds configuration constants used by Flink's table planner module.
|
class |
TableConfigOptions
This class holds
ConfigOption s used by table planner. |
Modifier and Type | Interface and Description |
---|---|
interface |
Constraint
Integrity constraints, generally referred to simply as constraints, define the valid states of
SQL-data by constraining the values in the base tables.
|
class |
UniqueConstraint
A unique key constraint.
|
Modifier and Type | Interface and Description |
---|---|
interface |
DataView
A
DataView is a collection type that can be used in the accumulator of an ImperativeAggregateFunction . |
class |
ListView<T>
A
DataView that provides List -like functionality in the accumulator of an AggregateFunction or TableAggregateFunction when large amounts of data are expected. |
class |
MapView<K,V>
A
DataView that provides Map -like functionality in the accumulator of an AggregateFunction or TableAggregateFunction when large amounts of data are expected. |
Modifier and Type | Class and Description |
---|---|
class |
BaseExpressions<InType,OutType>
These are Java and Scala common operations that can be used to construct an
Expression
AST for expression operations. |
Modifier and Type | Interface and Description |
---|---|
interface |
Catalog
This interface is responsible for reading and writing metadata such as database/table/views/UDFs
from a registered catalog.
|
class |
CatalogTableBuilder
A builder for creating a
CatalogTable . |
interface |
DataTypeFactory
Factory for creating fully resolved data types that can be used for planning.
|
class |
FunctionLanguage
Categorizes the language semantics of a
CatalogFunction . |
Modifier and Type | Class and Description |
---|---|
class |
ChangelogMode
The set of changes contained in a changelog.
|
interface |
ParallelismProvider
Parallelism provider for other connector providers.
|
interface |
RuntimeConverter
Base interface for converting data during runtime.
|
Modifier and Type | Interface and Description |
---|---|
interface |
DecodingFormat<I>
A
Format for a DynamicTableSource for reading rows. |
interface |
EncodingFormat<I>
A
Format for a DynamicTableSink for writing rows. |
interface |
Format
Base interface for connector formats.
|
Modifier and Type | Interface and Description |
---|---|
interface |
DataStreamSinkProvider
Provider that consumes a Java
DataStream as a runtime implementation for DynamicTableSink . |
interface |
DynamicTableSink
Sink of a dynamic table to an external storage system.
|
interface |
OutputFormatProvider
Provider of an
OutputFormat instance as a runtime implementation for DynamicTableSink . |
interface |
SinkFunctionProvider
Provider of a
SinkFunction instance as a runtime implementation for DynamicTableSink . |
Modifier and Type | Interface and Description |
---|---|
interface |
SupportsOverwrite
Enables to overwrite existing data in a
DynamicTableSink . |
interface |
SupportsPartitioning
Enables to write partitioned data in a
DynamicTableSink . |
interface |
SupportsWritingMetadata
Interface for
DynamicTableSink s that support writing metadata columns. |
Modifier and Type | Interface and Description |
---|---|
interface |
AsyncTableFunctionProvider<T>
Provider of an
AsyncTableFunction instance as a runtime implementation for LookupTableSource . |
interface |
DataStreamScanProvider
Provider that produces a Java
DataStream as a runtime implementation for ScanTableSource . |
interface |
DynamicTableSource
Source of a dynamic table from an external storage system.
|
interface |
InputFormatProvider
Provider of an
InputFormat instance as a runtime implementation for ScanTableSource . |
interface |
ScanTableSource
A
DynamicTableSource that scans all rows from an external storage system during runtime. |
interface |
SourceFunctionProvider
Provider of a
SourceFunction instance as a runtime implementation for ScanTableSource . |
interface |
SourceProvider
Provider of a
Source instance as a runtime implementation for ScanTableSource . |
interface |
TableFunctionProvider<T>
Provider of a
TableFunction instance as a runtime implementation for LookupTableSource . |
Modifier and Type | Interface and Description |
---|---|
interface |
SupportsFilterPushDown
Enables to push down filters into a
ScanTableSource . |
interface |
SupportsLimitPushDown
Enables to push down a limit (the expected maximum number of produced records) into a
ScanTableSource . |
interface |
SupportsPartitionPushDown
Enables to pass available partitions to the planner and push down partitions into a
ScanTableSource . |
interface |
SupportsProjectionPushDown
Enables to push down a (possibly nested) projection into a
ScanTableSource . |
interface |
SupportsReadingMetadata
Interface for
ScanTableSource s that support reading metadata columns. |
interface |
SupportsWatermarkPushDown
Enables to push down a watermark strategy into a
ScanTableSource . |
Modifier and Type | Interface and Description |
---|---|
interface |
ArrayData
Base interface of an internal data structure representing data of
ArrayType . |
class |
DecimalData
An internal data structure representing data of
DecimalType . |
class |
GenericArrayData
An internal data structure representing data of
ArrayType . |
class |
GenericMapData
An internal data structure representing data of
MapType or MultisetType . |
class |
GenericRowData
An internal data structure representing data of
RowType and other (possibly nested)
structured types such as StructuredType . |
interface |
MapData
Base interface of an internal data structure representing data of
MapType or MultisetType . |
interface |
RawValueData<T>
An internal data structure representing data of
RawType . |
interface |
RowData
Base interface for an internal data structure representing data of
RowType and other
(possibly nested) structured types such as StructuredType in the table ecosystem. |
interface |
StringData
An internal data structure representing data of
CharType and VarCharType . |
class |
TimestampData
An internal data structure representing data of
TimestampType and LocalZonedTimestampType . |
Modifier and Type | Class and Description |
---|---|
class |
Avro
Format descriptor for Apache Avro records.
|
class |
BatchTableDescriptor
Describes a table connected from a batch environment.
|
class |
CatalogDescriptor
Describes a catalog of tables, views, and functions.
|
class |
ClassInstance
Descriptor for a class instance.
|
class |
ConnectorDescriptor
Describes a connector to an other system.
|
class |
ConnectTableDescriptor
Describes a table connected from
TableEnvironment.connect(ConnectorDescriptor) . |
class |
Csv
Format descriptor for comma-separated values (CSV).
|
interface |
Descriptor
Interface that adds a set of string-based, normalized properties for describing DDL information.
|
class |
DescriptorBase
Base class for
Descriptor s. |
class |
Elasticsearch
Connector descriptor for the Elasticsearch search engine.
|
class |
FileSystem
Connector descriptor for a file system.
|
class |
FileSystemValidator
Validator for
FileSystem . |
class |
FormatDescriptor
Describes the format of data.
|
class |
FunctionDescriptor
Descriptor for describing a function.
|
class |
HBase
Connector descriptor for Apache HBase.
|
class |
HierarchyDescriptor
A descriptor that may exist in an arbitrary level (be recursively included by other descriptors).
|
class |
Kafka
Connector descriptor for the Apache Kafka message queue.
|
class |
LiteralValue
Descriptor for a literal value.
|
class |
ModuleDescriptor
Describes a
Module . |
class |
OldCsv
Deprecated.
Use the RFC-compliant
Csv format in the dedicated flink-formats/flink-csv
module instead when writing to Kafka. |
class |
Rowtime
Rowtime descriptor for describing an event time attribute in the schema.
|
class |
RowtimeValidator
Validator for
Rowtime . |
class |
Schema
Describes a schema of a table.
|
class |
SchemaValidator
Validator for
Schema . |
class |
StreamTableDescriptor
Describes a table connected from a streaming environment.
|
class |
TableDescriptor<D extends TableDescriptor<D>>
Describes a table consisting of a connector (in a given update mode) and a format.
|
Modifier and Type | Class and Description |
---|---|
class |
CallExpression
Resolved and validated call expression for calling a function.
|
interface |
Expression
General interface for all kinds of expressions.
|
interface |
ExpressionVisitor<R>
The visitor definition of
Expression . |
class |
FieldReferenceExpression
A reference to a field in an input.
|
class |
LookupCallExpression
A call expression where the target function has not been resolved yet.
|
interface |
ResolvedExpression
Expression that has been fully resolved and validated.
|
class |
ResolvedFieldReference
A reference to a field in an input which has been resolved.
|
class |
TableReferenceExpression
Expression that references another table.
|
interface |
TableSymbol
The base interface for all table symbols.
|
class |
TimeIntervalUnit
Units for working with time intervals.
|
class |
TimePointUnit
Units for working with points in time.
|
class |
TypeLiteralExpression
Expression that wraps
DataType as a literal. |
class |
UnresolvedCallExpression
Unresolved call expression for calling a function identified by a
FunctionDefinition . |
class |
UnresolvedReferenceExpression
An unresolved reference to a field, table, or local reference.
|
class |
ValueLiteralExpression
Expression for constant literal values.
|
Modifier and Type | Interface and Description |
---|---|
interface |
BatchTableSinkFactory<T>
Deprecated.
This interface has been replaced by
DynamicTableSinkFactory . The new
interface creates instances of DynamicTableSink and only works with the Blink
planner. See FLIP-95 for more information. |
interface |
BatchTableSourceFactory<T>
Deprecated.
This interface has been replaced by
DynamicTableSourceFactory . The new
interface creates instances of DynamicTableSource and only works with the Blink
planner. See FLIP-95 for more information. |
class |
BlackHoleTableSinkFactory
Black hole table sink factory swallowing all input records.
|
interface |
CatalogFactory
A factory to create configured catalog instances based on string-based properties.
|
interface |
ComponentFactory
A factory interface for components that enables further disambiguating in case there are multiple
matching implementations present.
|
class |
DataGenTableSourceFactory
Factory for creating configured instances of
DataGenTableSource in a stream environment. |
interface |
DecodingFormatFactory<I>
|
interface |
DeserializationFormatFactory
Factory for creating a
DecodingFormat for DeserializationSchema . |
interface |
DeserializationSchemaFactory<T>
Factory for creating configured instances of
DeserializationSchema . |
interface |
DynamicTableFactory
Base interface for configuring a dynamic table connector for an external storage system from
catalog and session information.
|
interface |
DynamicTableSinkFactory
Creates a
DynamicTableSink instance from a CatalogTable and additional context
information. |
interface |
DynamicTableSourceFactory
Creates a
DynamicTableSource instance from a CatalogTable and additional context
information. |
interface |
EncodingFormatFactory<I>
Base interface for configuring an
EncodingFormat for a DynamicTableSink . |
interface |
Factory
Base interface for all kind of factories that create object instances from a list of key-value
pairs in Flink's Table & SQL API.
|
class |
FactoryUtil
Utility for working with
Factory s. |
interface |
ModuleFactory
A factory to create configured module instances based on string-based properties.
|
class |
PrintTableSinkFactory
Print table sink factory writing every row to the standard output or standard error stream.
|
interface |
SerializationFormatFactory
Factory for creating a
EncodingFormat for SerializationSchema . |
interface |
SerializationSchemaFactory<T>
Factory for creating configured instances of
SerializationSchema . |
interface |
StreamTableSinkFactory<T>
Deprecated.
This interface has been replaced by
DynamicTableSinkFactory . The new
interface creates instances of DynamicTableSink and only works with the Blink
planner. See FLIP-95 for more information. |
interface |
StreamTableSourceFactory<T>
Deprecated.
This interface has been replaced by
DynamicTableSourceFactory . The new
interface creates instances of DynamicTableSource and only works with the Blink
planner. See FLIP-95 for more information. |
interface |
TableFactory
A factory to create different table-related instances from string-based properties.
|
interface |
TableFormatFactory<T>
A factory to create configured table format instances based on string-based properties.
|
class |
TableFormatFactoryBase<T>
Base class for
TableFormatFactory s. |
interface |
TableSinkFactory<T>
A factory to create configured table sink instances in a batch or stream environment based on
string-based properties.
|
interface |
TableSourceFactory<T>
A factory to create configured table source instances in a batch or stream environment based on
string-based properties.
|
Modifier and Type | Class and Description |
---|---|
class |
AggregateFunction<T,ACC>
Base class for a user-defined aggregate function.
|
class |
BuiltInFunctionDefinitions
Dictionary of function definitions for all built-in functions.
|
class |
FunctionContext
A
FunctionContext allows to obtain global runtime information about the context in which
the user-defined function is executed. |
interface |
FunctionDefinition
Definition of a function.
|
class |
FunctionIdentifier
Identifies a system function with function name or a catalog function with a fully qualified
identifier.
|
class |
FunctionKind
Categorizes the semantics of a
FunctionDefinition . |
class |
FunctionRequirement
Characteristics that a
FunctionDefinition requires. |
class |
ImperativeAggregateFunction<T,ACC>
Base class for user-defined
AggregateFunction and TableAggregateFunction . |
class |
ScalarFunction
Base class for a user-defined scalar function.
|
class |
TableAggregateFunction<T,ACC>
Base class for a user-defined table aggregate function.
|
class |
TableFunction<T>
Base class for a user-defined table function.
|
class |
TemporalTableFunction
Class representing temporal table function over some history table.
|
class |
UserDefinedFunction
Base class for all user-defined functions.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Module
Modules define a set of metadata, including functions, user defined types, operators, rules, etc.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Operation
Covers all sort of Table operations such as queries(DQL), modifications(DML), definitions(DDL),
or control actions(DCL).
|
Modifier and Type | Class and Description |
---|---|
class |
ColumnStats
Column statistics.
|
class |
TableStats
Table statistics.
|
Modifier and Type | Class and Description |
---|---|
class |
SortedMapTypeInfo<K,V>
The type information for sorted maps.
|
Modifier and Type | Interface and Description |
---|---|
interface |
AppendStreamTableSink<T>
Deprecated.
This interface has been replaced by
DynamicTableSink . The new interface
consumes internal data structures and only works with the Blink planner. See FLIP-95 for more
information. |
class |
CsvAppendTableSinkFactory
Factory base for creating configured instances of
CsvTableSink in a stream environment. |
class |
CsvBatchTableSinkFactory
Factory base for creating configured instances of
CsvTableSink in a batch environment. |
interface |
RetractStreamTableSink<T>
Deprecated.
This interface has been replaced by
DynamicTableSink . The new interface
consumes internal data structures and only works with the Blink planner. See FLIP-95 for more
information. |
interface |
TableSink<T>
Deprecated.
This interface has been replaced by
DynamicTableSink . The new interface
consumes internal data structures and only works with the Blink planner. See FLIP-95 for more
information. |
interface |
UpsertStreamTableSink<T>
Deprecated.
This interface has been replaced by
DynamicTableSink . The new interface
consumes internal data structures and only works with the Blink planner. See FLIP-95 for more
information. |
Modifier and Type | Class and Description |
---|---|
class |
CsvAppendTableSourceFactory
Factory for creating configured instances of
CsvTableSource in a stream environment. |
class |
CsvBatchTableSourceFactory
Factory for creating configured instances of
CsvTableSource in a batch environment. |
interface |
DefinedFieldMapping
Deprecated.
This interface will not be supported in the new source design around
DynamicTableSource which only works with the Blink planner. See FLIP-95 for more
information. |
interface |
DefinedProctimeAttribute
Deprecated.
This interface will not be supported in the new source design around
DynamicTableSource which only works with the Blink planner. Use the concept of computed
columns instead. See FLIP-95 for more information. |
interface |
DefinedRowtimeAttributes
Deprecated.
This interface will not be supported in the new source design around
DynamicTableSource which only works with the Blink planner. Use the concept of computed
columns instead. See FLIP-95 for more information. |
interface |
FieldComputer<T>
Deprecated.
This interface will not be supported in the new source design around
DynamicTableSource which only works with the Blink planner. Use the concept of computed
columns instead. See FLIP-95 for more information. |
interface |
NestedFieldsProjectableTableSource<T>
Deprecated.
This interface will not be supported in the new source design around
DynamicTableSource which only works with the Blink planner. Use SupportsProjectionPushDown instead. See FLIP-95 for more information. |
interface |
ProjectableTableSource<T>
Deprecated.
This interface will not be supported in the new source design around
DynamicTableSource which only works with the Blink planner. Use SupportsProjectionPushDown instead. See FLIP-95 for more information. |
interface |
TableSource<T>
Deprecated.
This interface has been replaced by
DynamicTableSource . The new interface
produces internal data structures and only works with the Blink planner. See FLIP-95 for more
information. |
Modifier and Type | Class and Description |
---|---|
class |
ExistingField
|
class |
StreamRecordTimestamp
Extracts the timestamp of a StreamRecord into a rowtime attribute.
|
class |
TimestampExtractor
Deprecated.
This interface will not be supported in the new source design around
DynamicTableSource which only works with the Blink planner. Use the concept of computed
columns instead. See FLIP-95 for more information. |
Modifier and Type | Class and Description |
---|---|
class |
AscendingTimestamps
A watermark strategy for ascending rowtime attributes.
|
class |
BoundedOutOfOrderTimestamps
A watermark strategy for rowtime attributes which are out-of-order by a bounded time interval.
|
class |
PeriodicWatermarkAssigner
A periodic watermark assigner.
|
class |
PreserveWatermarks
A strategy which indicates the watermarks should be preserved from the underlying datastream.
|
class |
PunctuatedWatermarkAssigner
A punctuated watermark assigner.
|
class |
WatermarkStrategy
Provides a strategy to generate watermarks for a rowtime attribute.
|
Modifier and Type | Interface and Description |
---|---|
interface |
AbstractDataType<T extends AbstractDataType<T>>
Highest abstraction that describes the data type of a value in the table ecosystem.
|
class |
AtomicDataType
A data type that does not contain further data types (e.g.
|
class |
CollectionDataType
A data type that contains an element type (e.g.
|
class |
DataType
Describes the data type of a value in the table ecosystem.
|
interface |
DataTypeVisitor<R>
The visitor definition of
DataType . |
class |
FieldsDataType
A data type that contains field data types (i.e.
|
class |
KeyValueDataType
A data type that contains a key and value data type (e.g.
|
class |
UnresolvedDataType
Partially resolved data type that requires a lookup in a catalog or configuration before creating
the corresponding
LogicalType . |
Modifier and Type | Interface and Description |
---|---|
interface |
ArgumentCount
Defines the count of accepted arguments (including open intervals) that a function can take.
|
interface |
ArgumentTypeStrategy
Strategy for inferring and validating a single input argument type of a function call.
|
interface |
CallContext
Provides details about a function call during
TypeInference . |
interface |
InputTypeStrategy
Strategy for inferring and validating input arguments in a function call.
|
class |
Signature
Describes the signature of a function.
|
class |
TypeInference
Provides logic for the type inference of function calls.
|
interface |
TypeStrategy
Strategy for inferring the data type of a function call.
|
interface |
TypeTransformation
Transforms one data type to another.
|
Modifier and Type | Class and Description |
---|---|
class |
ArrayType
Logical type of an array of elements with same subtype.
|
class |
BigIntType
Logical type of an 8-byte signed integer with values from -9,223,372,036,854,775,808 to
9,223,372,036,854,775,807.
|
class |
BinaryType
Logical type of a fixed-length binary string (=a sequence of bytes).
|
class |
BooleanType
Logical type of a boolean with a (possibly) three-valued logic of
TRUE, FALSE, UNKNOWN . |
class |
CharType
Logical type of a fixed-length character string.
|
class |
DateType
Logical type of a date consisting of
year-month-day with values ranging from 0000-01-01 to 9999-12-31 . |
class |
DayTimeIntervalType
Logical type for a group of day-time interval types.
|
class |
DecimalType
Logical type of a decimal number with fixed precision and scale.
|
class |
DistinctType
Logical type of a user-defined distinct type.
|
class |
DoubleType
Logical type of an 8-byte double precision floating point number.
|
class |
FloatType
Logical type of a 4-byte single precision floating point number.
|
class |
IntType
Logical type of a 4-byte signed integer with values from -2,147,483,648 to 2,147,483,647.
|
class |
LocalZonedTimestampType
Logical type of a timestamp WITH LOCAL time zone consisting of
year-month-day
hour:minute:second[.fractional] zone with up to nanosecond precision and values ranging from
0000-01-01 00:00:00.000000000 +14:59 to 9999-12-31 23:59:59.999999999 -14:59 . |
class |
LogicalType
A logical type that describes the data type of a value.
|
class |
LogicalTypeFamily
An enumeration of logical type families for clustering
LogicalTypeRoot s into categories. |
class |
LogicalTypeRoot
An enumeration of logical type roots containing static information about logical data types.
|
interface |
LogicalTypeVisitor<R>
The visitor definition of
LogicalType . |
class |
MapType
Logical type of an associative array that maps keys (including
NULL ) to values (including
NULL ). |
class |
MultisetType
Logical type of a multiset (=bag).
|
class |
NullType
Logical type for representing untyped
NULL values. |
class |
RawType<T>
Logical type of an arbitrary serialized type.
|
class |
RowType
Logical type of a sequence of fields.
|
class |
SmallIntType
Logical type of a 2-byte signed integer with values from -32,768 to 32,767.
|
class |
StructuredType
Logical type of a user-defined object structured type.
|
class |
SymbolType<T extends TableSymbol>
Logical type for representing symbol values.
|
class |
TimestampType
Logical type of a timestamp WITHOUT time zone consisting of
year-month-day
hour:minute:second[.fractional] with up to nanosecond precision and values ranging from 0000-01-01 00:00:00.000000000 to 9999-12-31 23:59:59.999999999 . |
class |
TimeType
Logical type of a time WITHOUT time zone consisting of
hour:minute:second[.fractional]
with up to nanosecond precision and values ranging from 00:00:00.000000000 to 23:59:59.999999999 . |
class |
TinyIntType
Logical type of a 1-byte signed integer with values from -128 to 127.
|
class |
TypeInformationRawType<T>
Deprecated.
Use
RawType instead. |
class |
UnresolvedUserDefinedType
Placeholder type of an unresolved user-defined type that is identified by an
UnresolvedIdentifier . |
class |
UserDefinedType
Logical type of a user-defined representation for one or more built-in types.
|
class |
VarBinaryType
Logical type of a variable-length binary string (=a sequence of bytes).
|
class |
VarCharType
Logical type of a variable-length character string.
|
class |
YearMonthIntervalType
Logical type for a group of year-month interval types.
|
class |
ZonedTimestampType
Logical type of a timestamp WITH time zone consisting of
year-month-day
hour:minute:second[.fractional] zone with up to nanosecond precision and values ranging from
0000-01-01 00:00:00.000000000 +14:59 to 9999-12-31 23:59:59.999999999 -14:59 . |
Modifier and Type | Class and Description |
---|---|
class |
LogicalTypeParser
Parser for creating instances of
LogicalType from a serialized string created with LogicalType.asSerializableString() . |
Modifier and Type | Class and Description |
---|---|
class |
TypeStringUtils
Deprecated.
This utility is based on
TypeInformation . However, the Table & SQL API is
currently updated to use DataType s based on LogicalType s. Use LogicalTypeParser instead. |
Modifier and Type | Class and Description |
---|---|
class |
JavaToValueConverter |
interface |
Key<T>
Deprecated.
The Key type is a relict of a deprecated and removed API and will be removed in
future (2.0) versions as well.
|
class |
Row
A row is a fixed-length, null-aware composite type for storing multiple values in a deterministic
field order.
|
class |
RowKind
Lists all kinds of changes that a row can describe in a changelog.
|
class |
RowUtils
Utilities to deal with
Row instances. |
Modifier and Type | Class and Description |
---|---|
class |
BigDecParser
Parses a text field into a
BigDecimal . |
class |
BigIntParser
Parses a text field into a
BigInteger . |
class |
BooleanParser |
class |
BooleanValueParser |
class |
ByteParser |
class |
ByteValueParser
Parses a decimal text field into a
ByteValue . |
class |
DoubleParser
Parses a text field into a Double.
|
class |
DoubleValueParser
Parses a text field into a DoubleValue.
|
class |
FieldParser<T>
A FieldParser is used parse a field from a sequence of bytes.
|
class |
FloatParser
Parses a text field into a
Float . |
class |
FloatValueParser
Parses a text field into a
FloatValue |
class |
IntParser
Parses a decimal text field into a IntValue.
|
class |
IntValueParser
Parses a decimal text field into a IntValue.
|
class |
LongParser
Parses a decimal text field into a LongValue.
|
class |
LongValueParser
Parses a decimal text field into a LongValue.
|
class |
ShortParser
Parses a decimal text field into a
Short . |
class |
ShortValueParser
Parses a decimal text field into a
ShortValue . |
class |
SqlDateParser
Parses a text field into a
Date . |
class |
SqlTimeParser
Parses a text field into a
Time . |
class |
SqlTimestampParser
Parses a text field into a
Timestamp . |
class |
StringParser
Converts a variable length field of a byte array into a
String . |
class |
StringValueParser
Converts a variable length field of a byte array into a
StringValue . |
Modifier and Type | Class and Description |
---|---|
class |
AbstractID
A statistically unique identification number.
|
class |
OutputTag<T>
An
OutputTag is a typed and named tag to use for tagging side outputs of an operator. |
class |
StringUtils
Utility class to convert objects into strings in vice-versa.
|
class |
StringValueUtils
Utility class for efficient operations on
StringValue . |
class |
TernaryBoolean
A ternary boolean, which can have the values 'true', 'false', or 'undefined'.
|
Modifier and Type | Class and Description |
---|---|
class |
Clock
A clock that gives access to time.
|
class |
ManualClock
A
Clock implementation which allows to advance time manually. |
class |
SystemClock
A clock that returns the time of the system / process.
|
Modifier and Type | Interface and Description |
---|---|
interface |
QuadConsumer<S,T,U,V>
Operation which is performed on four given arguments.
|
interface |
QuadFunction<S,T,U,V,R>
Function which takes three arguments.
|
interface |
ThrowingRunnable<E extends Throwable>
Similar to a
Runnable , this interface is used to capture a block of code to be executed. |
interface |
TriConsumer<S,T,U>
Operation which is performed on three given arguments.
|
interface |
TriFunction<S,T,U,R>
Function which takes three arguments.
|
interface |
TriFunctionWithException<S,T,U,R,E extends Throwable>
Function which takes three arguments.
|
Modifier and Type | Class and Description |
---|---|
class |
AlertSink
A sink for outputting alerts.
|
Copyright © 2014–2021 The Apache Software Foundation. All rights reserved.