Package io.pravega.connectors.flink

Class FlinkPravegaReader.Builder<T>

java.lang.Object

io.pravega.connectors.flink.AbstractReaderBuilder<B>

io.pravega.connectors.flink.FlinkPravegaReader.Builder<T>

Type Parameters:

T - the element type.

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

FlinkPravegaReader<T>

public static class FlinkPravegaReader.Builder<T>
extends AbstractReaderBuilder<B>

A builder for FlinkPravegaReader.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.flink.api.common.time.Time	checkpointInitiateTimeout
protected org.apache.flink.api.common.time.Time	eventReadTimeout
protected int	maxOutstandingCheckpointRequest
protected java.lang.String	readerGroupName
protected org.apache.flink.api.common.time.Time	readerGroupRefreshTime
protected java.lang.String	readerGroupScope
protected java.lang.String	uid

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FlinkPravegaReader<T>	build()	Builds a FlinkPravegaReader based on the configuration.
protected FlinkPravegaReader.Builder<T>	builder()
protected org.apache.flink.util.SerializedValue<AssignerWithTimeWindows<T>>	getAssignerWithTimeWindows()
protected org.apache.flink.api.common.serialization.DeserializationSchema<T>	getDeserializationSchema()
B	uid(java.lang.String uid)	Configures the source uid to identify the checkpoint state of this source.
B	withCheckpointInitiateTimeout(org.apache.flink.api.common.time.Time checkpointInitiateTimeout)	Sets the timeout for initiating a checkpoint in Pravega.
FlinkPravegaReader.Builder<T>	withDeserializationSchema(org.apache.flink.api.common.serialization.DeserializationSchema<T> deserializationSchema)	Sets the deserialization schema.
B	withEventReadTimeout(org.apache.flink.api.common.time.Time eventReadTimeout)	Sets the timeout for the call to read events from Pravega.
B	withMaxOutstandingCheckpointRequest(int maxOutstandingCheckpointRequest)	Configures the maximum outstanding checkpoint requests to Pravega (default=3).
B	withReaderGroupName(java.lang.String readerGroupName)	Configures the reader group name.
B	withReaderGroupRefreshTime(org.apache.flink.api.common.time.Time groupRefreshTime)	Sets the group refresh time, with a default of 1 second.
B	withReaderGroupScope(java.lang.String scope)	Configures the reader group scope for synchronization purposes.
FlinkPravegaReader.Builder<T>	withTimestampAssigner(AssignerWithTimeWindows<T> assignerWithTimeWindows)	Sets the timestamp and watermark assigner.

Methods inherited from class io.pravega.connectors.flink.AbstractReaderBuilder

enableMetrics, forStream, forStream, forStream, forStream, forStream, forStream, getPravegaConfig, isMetricsEnabled, resolveStreams, withPravegaConfig

Methods inherited from class java.lang.Object

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

Field Detail

uid

protected java.lang.String uid

readerGroupScope

protected java.lang.String readerGroupScope

readerGroupName

protected java.lang.String readerGroupName

readerGroupRefreshTime

protected org.apache.flink.api.common.time.Time readerGroupRefreshTime

checkpointInitiateTimeout

protected org.apache.flink.api.common.time.Time checkpointInitiateTimeout

eventReadTimeout

protected org.apache.flink.api.common.time.Time eventReadTimeout

maxOutstandingCheckpointRequest

protected int maxOutstandingCheckpointRequest

Constructor Detail

Builder

public Builder()

Method Detail

builder

protected FlinkPravegaReader.Builder<T> builder()

Specified by:

builder in class AbstractReaderBuilder<FlinkPravegaReader.Builder<T>>

withDeserializationSchema

public FlinkPravegaReader.Builder<T> withDeserializationSchema(org.apache.flink.api.common.serialization.DeserializationSchema<T> deserializationSchema)

Sets the deserialization schema.

Parameters:

deserializationSchema - The deserialization schema

Returns:

Builder instance.

withTimestampAssigner

public FlinkPravegaReader.Builder<T> withTimestampAssigner(AssignerWithTimeWindows<T> assignerWithTimeWindows)

Sets the timestamp and watermark assigner.

Parameters:

assignerWithTimeWindows - The timestamp and watermark assigner.

Returns:

Builder instance.

getDeserializationSchema

protected org.apache.flink.api.common.serialization.DeserializationSchema<T> getDeserializationSchema()

getAssignerWithTimeWindows

protected org.apache.flink.util.SerializedValue<AssignerWithTimeWindows<T>> getAssignerWithTimeWindows()

build

public FlinkPravegaReader<T> build()

Builds a FlinkPravegaReader based on the configuration.

Throws:

java.lang.IllegalStateException - if the configuration is invalid.

uid

public B uid(java.lang.String uid)

Configures the source uid to identify the checkpoint state of this source.

The default value is generated based on other inputs.

Parameters:

uid - the uid to use.

withReaderGroupScope

public B withReaderGroupScope(java.lang.String scope)

Configures the reader group scope for synchronization purposes.

The default value is taken from the PravegaConfig defaultScope property.

Parameters:

scope - the scope name.

withReaderGroupName

public B withReaderGroupName(java.lang.String readerGroupName)

Configures the reader group name.

Parameters:

readerGroupName - the reader group name.

withReaderGroupRefreshTime

public B withReaderGroupRefreshTime(org.apache.flink.api.common.time.Time groupRefreshTime)

Sets the group refresh time, with a default of 1 second.

Parameters:

groupRefreshTime - The group refresh time

withCheckpointInitiateTimeout

public B withCheckpointInitiateTimeout(org.apache.flink.api.common.time.Time checkpointInitiateTimeout)

Sets the timeout for initiating a checkpoint in Pravega.

Parameters:

checkpointInitiateTimeout - The timeout

withEventReadTimeout

public B withEventReadTimeout(org.apache.flink.api.common.time.Time eventReadTimeout)

Sets the timeout for the call to read events from Pravega. After the timeout expires (without an event being returned), another call will be made.

Parameters:

eventReadTimeout - The timeout

withMaxOutstandingCheckpointRequest

public B withMaxOutstandingCheckpointRequest(int maxOutstandingCheckpointRequest)

Configures the maximum outstanding checkpoint requests to Pravega (default=3). Upon requesting more checkpoints than the specified maximum, (say a checkpoint request times out on the ReaderCheckpointHook but Pravega is still working on it), this configurations allows Pravega to limit any further checkpoint request being made to the ReaderGroup. This configuration is particularly relevant when multiple checkpoint requests need to be honored (e.g., frequent savepoint requests being triggered concurrently).

Parameters:

maxOutstandingCheckpointRequest - maximum outstanding checkpoint request.