java.lang.Object
- org.apache.iceberg.flink.source.ScanContext

All Implemented Interfaces:

java.io.Serializable
```
@Internal
public class ScanContext
extends java.lang.Object
implements java.io.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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.Long`	`asOfTimestamp()`
`java.lang.String`	`branch()`
`static ScanContext.Builder`	`builder()`
`boolean`	`caseSensitive()`
`ScanContext`	`copyWithAppendsBetween(java.lang.Long newStartSnapshotId, long newEndSnapshotId)`
`ScanContext`	`copyWithSnapshotId(long newSnapshotId)`
`java.lang.Long`	`endSnapshotId()`
`java.lang.String`	`endTag()`
`boolean`	`exposeLocality()`
`java.util.List<Expression>`	`filters()`
`boolean`	`includeColumnStats()`
`boolean`	`isStreaming()`
`long`	`limit()`
`int`	`maxAllowedPlanningFailures()`
`int`	`maxPlanningSnapshotCount()`
`java.time.Duration`	`monitorInterval()`
`java.lang.String`	`nameMapping()`
`java.lang.Integer`	`planParallelism()`
`Schema`	`project()`
`java.lang.Long`	`snapshotId()`
`java.lang.Integer`	`splitLookback()`
`java.lang.Long`	`splitOpenFileCost()`
`java.lang.Long`	`splitSize()`
`java.lang.Long`	`startSnapshotId()`
`java.lang.Long`	`startSnapshotTimestamp()`
`java.lang.String`	`startTag()`
`StreamingStartingStrategy`	`streamingStartingStrategy()`
`java.lang.String`	`tag()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

caseSensitive
```
public boolean caseSensitive()
```

snapshotId
```
public java.lang.Long snapshotId()
```

branch
```
public java.lang.String branch()
```

tag
```
public java.lang.String tag()
```

startTag
```
public java.lang.String startTag()
```

endTag
```
public java.lang.String endTag()
```

streamingStartingStrategy

public StreamingStartingStrategy streamingStartingStrategy()

startSnapshotTimestamp

public java.lang.Long startSnapshotTimestamp()

startSnapshotId

public java.lang.Long startSnapshotId()

endSnapshotId
```
public java.lang.Long endSnapshotId()
```

asOfTimestamp
```
public java.lang.Long asOfTimestamp()
```

splitSize
```
public java.lang.Long splitSize()
```

splitLookback

public java.lang.Integer splitLookback()

splitOpenFileCost

public java.lang.Long splitOpenFileCost()

isStreaming
```
public boolean isStreaming()
```

monitorInterval

public java.time.Duration monitorInterval()

nameMapping
```
public java.lang.String nameMapping()
```

project
```
public Schema project()
```

filters

public java.util.List<Expression> filters()

limit
```
public long limit()
```

includeColumnStats
```
public boolean includeColumnStats()
```

exposeLocality
```
public boolean exposeLocality()
```

planParallelism

public java.lang.Integer planParallelism()

maxPlanningSnapshotCount
```
public int maxPlanningSnapshotCount()
```

maxAllowedPlanningFailures

public int maxAllowedPlanningFailures()

copyWithAppendsBetween

public ScanContext copyWithAppendsBetween(java.lang.Long newStartSnapshotId,
                                          long newEndSnapshotId)

copyWithSnapshotId

public ScanContext copyWithSnapshotId(long newSnapshotId)

builder

public static ScanContext.Builder builder()

Class ScanContext

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

caseSensitive

snapshotId

branch

tag

startTag

endTag

streamingStartingStrategy

startSnapshotTimestamp

startSnapshotId

endSnapshotId

asOfTimestamp

splitSize

splitLookback

splitOpenFileCost

isStreaming

monitorInterval

nameMapping

project

filters

limit

includeColumnStats

exposeLocality

planParallelism

maxPlanningSnapshotCount

maxAllowedPlanningFailures

copyWithAppendsBetween

copyWithSnapshotId

builder