BaseRecording (Pinot Service Provider Interface 0.12.1 API)

java.lang.Object
- org.apache.pinot.spi.trace.BaseRecording

All Implemented Interfaces:

InvocationRecording

Direct Known Subclasses:

NoOpRecording
```
public class BaseRecording
extends Object
implements InvocationRecording
```
A base recording class. SPI users should extend this class to ensure that {@see isEnabled} checks are cheap.

- Constructor Summary
  
  Constructors
  Constructor Description
  
  BaseRecording(boolean enabled)
- Method Summary
  
  Modifier and Type Method Description
  
  boolean isEnabled()
  This should not be overridden to keep the isEnabled checks as cheap as possible.
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  - Methods inherited from interface org.apache.pinot.spi.trace.InvocationRecording
    setBytesProcessed, setColumnCardinality, setColumnName, setDocIdRange, setFilter, setFunctionName, setInputDataType, setNumChildren, setNumDocsMatchingAfterFilter, setNumDocsScanned, setNumGroups, setNumSegments, setNumTasks, setOutputDataType

- Constructor Detail
  - BaseRecording
```
public BaseRecording(boolean enabled)
```
- Method Detail
  - isEnabled
```
public final boolean isEnabled()
```
    This should not be overridden to keep the isEnabled checks as cheap as possible.
    
    Specified by:
    
    isEnabled in interface InvocationRecording
    
    Returns:
    
    true if the recording is enabled. If producing a value is costly, the caller should check whether the recording is enabled before producing the value to keep tracing overhead down.