Package org.apache.iceberg
Interface ScanTask
-
- All Superinterfaces:
java.io.Serializable
- All Known Subinterfaces:
AddedRowsScanTask,ChangelogScanTask,CombinedScanTask,ContentScanTask<F>,DataTask,DeletedDataFileScanTask,DeletedRowsScanTask,FileScanTask,MergeableScanTask<ThisT>,PartitionScanTask,PositionDeletesScanTask,ScanTaskGroup<T>,SplittableScanTask<ThisT>
- All Known Implementing Classes:
BaseCombinedScanTask,BaseFileScanTask,BaseScanTaskGroup
public interface ScanTask extends java.io.SerializableA scan task.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default CombinedScanTaskasCombinedScanTask()Returns this cast toCombinedScanTaskif it is onedefault DataTaskasDataTask()Returns this cast toDataTaskif it is onedefault FileScanTaskasFileScanTask()Returns this cast toFileScanTaskif it is onedefault longestimatedRowsCount()The estimated number of rows produced by this scan task.default intfilesCount()The number of files that will be opened by this scan task.default booleanisDataTask()Returns true if this is aDataTask, false otherwise.default booleanisFileScanTask()Returns true if this is aFileScanTask, false otherwise.default longsizeBytes()The number of bytes that should be read by this scan task.
-
-
-
Method Detail
-
sizeBytes
default long sizeBytes()
The number of bytes that should be read by this scan task.- Returns:
- the total number of bytes to read
-
estimatedRowsCount
default long estimatedRowsCount()
The estimated number of rows produced by this scan task.- Returns:
- the estimated number of produced rows
-
filesCount
default int filesCount()
The number of files that will be opened by this scan task.- Returns:
- the number of files to open
-
isFileScanTask
default boolean isFileScanTask()
Returns true if this is aFileScanTask, false otherwise.
-
asFileScanTask
default FileScanTask asFileScanTask()
Returns this cast toFileScanTaskif it is one- Returns:
- this cast to
FileScanTaskif it is one - Throws:
java.lang.IllegalStateException- if this is not aFileScanTask
-
isDataTask
default boolean isDataTask()
Returns true if this is aDataTask, false otherwise.
-
asCombinedScanTask
default CombinedScanTask asCombinedScanTask()
Returns this cast toCombinedScanTaskif it is one- Returns:
- this cast to
CombinedScanTaskif it is one - Throws:
java.lang.IllegalStateException- if this is not aCombinedScanTask
-
-