FileScanTask

All Superinterfaces:

ScanTask, java.io.Serializable

All Known Subinterfaces:

DataTask
```
public interface FileScanTask
extends ScanTask
```
A scan task over a range of a single file.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default FileScanTask`	`asFileScanTask()` Returns this cast to `FileScanTask` if it is one
`java.util.List<DeleteFile>`	`deletes()` A list of `delete files` to apply when reading the task's data file.
`DataFile`	`file()` The `file` to scan.
`default boolean`	`isFileScanTask()` Returns true if this is a `FileScanTask`, false otherwise.
`long`	`length()` The number of bytes to scan from the `start()` position in the file.
`Expression`	`residual()` Returns the residual expression that should be applied to rows in this file scan.
`PartitionSpec`	`spec()` The `spec` used to store this file.
`java.lang.Iterable<FileScanTask>`	`split(long splitSize)` Splits this scan task into component `scan tasks`, each of `splitSize` size
`long`	`start()` The starting position of this scan range in the file.

Methods inherited from interface org.apache.iceberg.ScanTask
asCombinedScanTask, asDataTask, isDataTask

- Method Detail
  - file
```
DataFile file()
```
    The file to scan.
    
    Returns:
    
    the file to scan
  - deletes
```
java.util.List<DeleteFile> deletes()
```
    A list of delete files to apply when reading the task's data file.
    
    Returns:
    
    a list of delete files to apply
  - spec
```
PartitionSpec spec()
```
    The spec used to store this file.
    
    Returns:
    
    the partition spec from this file's manifest
  - start
```
long start()
```
    The starting position of this scan range in the file.
    
    Returns:
    
    the start position of this scan range
  - length
```
long length()
```
    The number of bytes to scan from the start() position in the file.
    
    Returns:
    
    the length of this scan range in bytes
  - residual
```
Expression residual()
```
    Returns the residual expression that should be applied to rows in this file scan.
    The residual expression for a file is a filter expression created from the scan's filter, inclusive any predicates that are true or false for the entire file removed, based on the file's partition data.
    
    Returns:
    
    a residual expression to apply to rows from this scan
  - split
```
java.lang.Iterable<FileScanTask> split(long splitSize)
```
    Splits this scan task into component scan tasks, each of splitSize size
    
    Parameters:
    
    splitSize - The size of a component scan task
    
    Returns:
    
    an Iterable of scan tasks
  - isFileScanTask
```
default boolean isFileScanTask()
```
    Description copied from interface: ScanTask
    
    Returns true if this is a FileScanTask, false otherwise.
    
    Specified by:
    
    isFileScanTask in interface ScanTask
  - asFileScanTask
```
default FileScanTask asFileScanTask()
```
    Description copied from interface: ScanTask
    
    Returns this cast to FileScanTask if it is one
    
    Specified by:
    
    asFileScanTask in interface ScanTask
    
    Returns:
    
    this cast to FileScanTask if it is one

Interface FileScanTask

Method Summary

Methods inherited from interface org.apache.iceberg.ScanTask

Method Detail

file

deletes

spec

start

length

residual

split

isFileScanTask

asFileScanTask