Package org.apache.iceberg.flink.source

Class ScanContext

java.lang.Object

org.apache.iceberg.flink.source.ScanContext

All Implemented Interfaces:

Serializable

@Internal
public class ScanContext
extends Object
implements Serializable

Context object with optional arguments for a Flink Scan.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScanContext.Builder

Method Summary

Modifier and Type	Method	Description
Long	asOfTimestamp()
String	branch()
static ScanContext.Builder	builder()
boolean	caseSensitive()
ScanContext	copyWithAppendsBetween(Long newStartSnapshotId, long newEndSnapshotId)
ScanContext	copyWithSnapshotId(long newSnapshotId)
Long	endSnapshotId()
String	endTag()
boolean	exposeLocality()
List<Expression>	filters()
boolean	includeColumnStats()
Collection<String>	includeStatsForColumns()
boolean	isStreaming()
long	limit()
int	maxAllowedPlanningFailures()
int	maxPlanningSnapshotCount()
Duration	monitorInterval()
String	nameMapping()
Integer	planParallelism()
Schema	project()
Long	snapshotId()
Integer	splitLookback()
Long	splitOpenFileCost()
Long	splitSize()
Long	startSnapshotId()
Long	startSnapshotTimestamp()
String	startTag()
StreamingStartingStrategy	streamingStartingStrategy()
String	tag()
String	watermarkColumn()
TimeUnit	watermarkColumnTimeUnit()

Methods inherited from class java.lang.Object

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

Method Details

caseSensitive

public boolean caseSensitive()

snapshotId

public Long snapshotId()

branch

public String branch()

tag

public String tag()

startTag

public String startTag()

endTag

public String endTag()

streamingStartingStrategy

public StreamingStartingStrategy streamingStartingStrategy()

startSnapshotTimestamp

public Long startSnapshotTimestamp()

startSnapshotId

public Long startSnapshotId()

endSnapshotId

public Long endSnapshotId()

asOfTimestamp

public Long asOfTimestamp()

splitSize

public Long splitSize()

splitLookback

public Integer splitLookback()

splitOpenFileCost

public Long splitOpenFileCost()

isStreaming

public boolean isStreaming()

monitorInterval

public Duration monitorInterval()

nameMapping

public String nameMapping()

project

public Schema project()

filters

public List<Expression> filters()

limit

public long limit()

includeColumnStats

public boolean includeColumnStats()

includeStatsForColumns

public Collection<String> includeStatsForColumns()

exposeLocality

public boolean exposeLocality()

planParallelism

public Integer planParallelism()

maxPlanningSnapshotCount

public int maxPlanningSnapshotCount()

maxAllowedPlanningFailures

public int maxAllowedPlanningFailures()

watermarkColumn

public String watermarkColumn()

watermarkColumnTimeUnit

public TimeUnit watermarkColumnTimeUnit()

copyWithAppendsBetween

public ScanContext copyWithAppendsBetween(Long newStartSnapshotId,
 long newEndSnapshotId)

copyWithSnapshotId

public ScanContext copyWithSnapshotId(long newSnapshotId)

builder

public static ScanContext.Builder builder()