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.Serializable
```
A scan task.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default CombinedScanTask`	`asCombinedScanTask()` Returns this cast to `CombinedScanTask` if it is one
`default DataTask`	`asDataTask()` Returns this cast to `DataTask` if it is one
`default FileScanTask`	`asFileScanTask()` Returns this cast to `FileScanTask` if it is one
`default long`	`estimatedRowsCount()` The estimated number of rows produced by this scan task.
`default int`	`filesCount()` The number of files that will be opened by this scan task.
`default boolean`	`isDataTask()` Returns true if this is a `DataTask`, false otherwise.
`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.

- 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 a FileScanTask, false otherwise.
  - asFileScanTask
```
default FileScanTask asFileScanTask()
```
    Returns this cast to FileScanTask if it is one
    
    Returns:
    
    this cast to FileScanTask if it is one
    
    Throws:
    
    java.lang.IllegalStateException - if this is not a FileScanTask
  - isDataTask
```
default boolean isDataTask()
```
    Returns true if this is a DataTask, false otherwise.
  - asDataTask
```
default DataTask asDataTask()
```
    Returns this cast to DataTask if it is one
    
    Returns:
    
    this cast to DataTask if it is one
    
    Throws:
    
    java.lang.IllegalStateException - if this is not a DataTask
  - asCombinedScanTask
```
default CombinedScanTask asCombinedScanTask()
```
    Returns this cast to CombinedScanTask if it is one
    
    Returns:
    
    this cast to CombinedScanTask if it is one
    
    Throws:
    
    java.lang.IllegalStateException - if this is not a CombinedScanTask

Interface ScanTask

Method Summary

Method Detail

sizeBytes

estimatedRowsCount

filesCount

isFileScanTask

asFileScanTask

isDataTask

asDataTask

asCombinedScanTask