org.apache.flink.api.common.io.statistics

Interface BaseStatistics

All Known Implementing Classes:

FileInputFormat.FileBaseStatistics

@Public
public interface BaseStatistics

Interface describing the basic statistics that can be obtained from the input.

Field Summary

Fields

Modifier and Type	Field and Description
static float	AVG_RECORD_BYTES_UNKNOWN Constant indicating that average record width is unknown.
static long	NUM_RECORDS_UNKNOWN Constant indicating that the number of records is unknown;
static long	SIZE_UNKNOWN Constant indicating that the input size is unknown.

Method Summary

Modifier and Type	Method and Description
float	getAverageRecordWidth() Gets the average width of a record, in bytes.
long	getNumberOfRecords() Gets the number of records in the input (= base cardinality).
long	getTotalInputSize() Gets the total size of the input.

Field Detail

SIZE_UNKNOWN

@PublicEvolving
static final long SIZE_UNKNOWN

Constant indicating that the input size is unknown.

See Also:

Constant Field Values

NUM_RECORDS_UNKNOWN

@PublicEvolving
static final long NUM_RECORDS_UNKNOWN

Constant indicating that the number of records is unknown;

See Also:

Constant Field Values

AVG_RECORD_BYTES_UNKNOWN

@PublicEvolving
static final float AVG_RECORD_BYTES_UNKNOWN

Constant indicating that average record width is unknown.

See Also:

Constant Field Values

Method Detail

getTotalInputSize

@PublicEvolving
long getTotalInputSize()

Gets the total size of the input.

Returns:

The total size of the input, in bytes.

getNumberOfRecords

@PublicEvolving
long getNumberOfRecords()

Gets the number of records in the input (= base cardinality).

Returns:

The number of records in the input.

getAverageRecordWidth

@PublicEvolving
float getAverageRecordWidth()

Gets the average width of a record, in bytes.

Returns:

The average width of a record in bytes.