org.apache.iceberg

Interface FileScanTask

All Superinterfaces:

ContentScanTask<DataFile>, PartitionScanTask, ScanTask, java.io.Serializable, SplittableScanTask<FileScanTask>

All Known Subinterfaces:

DataTask

All Known Implementing Classes:

BaseFileScanTask

public interface FileScanTask
extends ContentScanTask<DataFile>, SplittableScanTask<FileScanTask>

A scan task over a range of bytes in a single data file.

Method Summary

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.
default int	filesCount() The number of files that will be opened by this scan task.
default boolean	isFileScanTask() Returns true if this is a FileScanTask, false otherwise.
default long	sizeBytes() The number of bytes that should be read by this scan task.

Methods inherited from interface org.apache.iceberg.ContentScanTask

estimatedRowsCount, file, length, partition, residual, start

Methods inherited from interface org.apache.iceberg.PartitionScanTask

spec

Methods inherited from interface org.apache.iceberg.ScanTask

asCombinedScanTask, asDataTask, isDataTask

Methods inherited from interface org.apache.iceberg.SplittableScanTask

split

Method Detail

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

sizeBytes

default long sizeBytes()

Description copied from interface: ScanTask

The number of bytes that should be read by this scan task.

Specified by:

sizeBytes in interface ContentScanTask<DataFile>

Specified by:

sizeBytes in interface ScanTask

Returns:

the total number of bytes to read

filesCount

default int filesCount()

Description copied from interface: ScanTask

The number of files that will be opened by this scan task.

Specified by:

filesCount in interface ScanTask

Returns:

the number of files to open

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