BigQueryStorageReadRowsTracer (BigQuery Connector Common Library 0.39.1 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

LoggingBigQueryStorageReadRowsTracer
```
public interface BigQueryStorageReadRowsTracer
extends Serializable
```
Interface to capture tracing in information for the BigQuery connector. Modelled after com.google.api.gax.tracing.ApiTracer
A single instance of a tracer corresponds with a single logical stream from the service.
Paired start/end methods are expected to be called from the same thread.
For internal use only.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`finished()` The ReadRows stream has finished.
`BigQueryStorageReadRowsTracer`	`forkWithPrefix(String id)` Must only be called before any calls are made to the tracer.
`long`	`getBytesRead()`
`long`	`getParseTimeInMilliSec()`
`long`	`getRowsRead()`
`long`	`getScanTimeInMilliSec()`
`long`	`getTimeInSparkInMilliSec()`
`void`	`nextBatchNeeded()` Called when the next batch is needed from spark.
`void`	`readRowsResponseObtained(long bytesReceived)` Indicates the next ReadRowsResponse was requested from the server.
`void`	`readRowsResponseRequested()` Indicates the next ReadRowsResponse was requested from the server.
`void`	`rowsParseFinished(long rowsParsed)` Indicates when a decoded item was delivered.
`void`	`rowsParseStarted()` Indicates a fully decoded element has been requested by spark (i.e.
`void`	`startStream()` Record stream initialization time.

- Method Detail
  - startStream
```
void startStream()
```
    Record stream initialization time.
  - rowsParseStarted
```
void rowsParseStarted()
```
    Indicates a fully decoded element has been requested by spark (i.e. Arrow RecordBatch).
  - rowsParseFinished
```
void rowsParseFinished(long rowsParsed)
```
    Indicates when a decoded item was delivered.
  - readRowsResponseRequested
```
void readRowsResponseRequested()
```
    Indicates the next ReadRowsResponse was requested from the server.
  - readRowsResponseObtained
```
void readRowsResponseObtained(long bytesReceived)
```
    Indicates the next ReadRowsResponse was requested from the server.
  - finished
```
void finished()
```
    The ReadRows stream has finished.
  - nextBatchNeeded
```
void nextBatchNeeded()
```
    Called when the next batch is needed from spark.
  - forkWithPrefix
```
BigQueryStorageReadRowsTracer forkWithPrefix(String id)
```
    Must only be called before any calls are made to the tracer. This is intended for cases when multiple threads might be used for processing one stream. tracer that is distinguished between IDs.
    
    Parameters:
    
    id - A distinguisher to use.
    
    Returns:
    
    A new tracer with the ID>
  - getBytesRead
```
long getBytesRead()
```
  - getRowsRead
```
long getRowsRead()
```
  - getScanTimeInMilliSec
```
long getScanTimeInMilliSec()
```
  - getParseTimeInMilliSec
```
long getParseTimeInMilliSec()
```
  - getTimeInSparkInMilliSec
```
long getTimeInSparkInMilliSec()
```

Interface BigQueryStorageReadRowsTracer

Method Summary

Method Detail

startStream

rowsParseStarted

rowsParseFinished

readRowsResponseRequested

readRowsResponseObtained

finished

nextBatchNeeded

forkWithPrefix

getBytesRead

getRowsRead

getScanTimeInMilliSec

getParseTimeInMilliSec

getTimeInSparkInMilliSec