Class QueryStage (2.45.0)

public class QueryStage implements Serializable

BigQuery provides diagnostic information about a completed query's execution plan (or query plan for short). The query plan describes a query as a series of stages, with each stage comprising a number of steps that read from data sources, perform a series of transformations on the input, and emit an output to a future stage (or the final result). This class contains information on a query stage. See Also: Query Plan

Inheritance

Object > QueryStage

Implements

Serializable

Methods

equals(Object obj)

public final boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCompletedParallelInputs()

public long getCompletedParallelInputs()

Returns the number of parallel input segments completed.

Returns
Type Description
long

getComputeMsAvg()

public long getComputeMsAvg()

Returns the time in milliseconds the average worker spent on CPU-bound tasks.

Returns
Type Description
long

getComputeMsMax()

public long getComputeMsMax()

Returns the time in milliseconds the slowest worker spent on CPU-bound tasks.

Returns
Type Description
long

getComputeRatioAvg()

public double getComputeRatioAvg()

Returns the time the average worker spent CPU-bound, divided by the longest time spent by any worker in any segment.

Returns
Type Description
double

getComputeRatioMax()

public double getComputeRatioMax()

Returns the time the slowest worker spent CPU-bound, divided by the longest time spent by any worker in any segment.

Returns
Type Description
double

getEndMs()

public long getEndMs()

Returns the stage end time represented as milliseconds since epoch.

Returns
Type Description
long

getGeneratedId()

public long getGeneratedId()

Returns a unique, server-generated ID for the stage within its plan.

Returns
Type Description
long

getInputStages()

public List<Long> getInputStages()

Returns a list of the stage IDs that are inputs to this stage.

Returns
Type Description
List<Long>

getName()

public String getName()

Returns a human-readable name for the stage.

Returns
Type Description
String

getParallelInputs()

public long getParallelInputs()

Returns the number of parallel input segments to be processed.

Returns
Type Description
long

getReadMsAvg()

public long getReadMsAvg()

Returns the time in milliseconds the average worker spent reading input.

Returns
Type Description
long

getReadMsMax()

public long getReadMsMax()

Returns the time in milliseconds the slowest worker spent reading input.

Returns
Type Description
long

getReadRatioAvg()

public double getReadRatioAvg()

Returns the time the average worker spent reading input data, divided by the longest time spent by any worker in any segment.

Returns
Type Description
double

getReadRatioMax()

public double getReadRatioMax()

Returns the time the slowest worker spent reading input data, divided by the longest time spent by any worker in any segment.

Returns
Type Description
double

getRecordsRead()

public long getRecordsRead()

Returns the number of rows (top-level records) read by the stage.

Returns
Type Description
long

getRecordsWritten()

public long getRecordsWritten()

Returns the number of rows (top-level records) written by the stage.

Returns
Type Description
long

getShuffleOutputBytes()

public long getShuffleOutputBytes()

Returns the total number of bytes written to shuffle.

Returns
Type Description
long

getShuffleOutputBytesSpilled()

public long getShuffleOutputBytesSpilled()

Returns the total number of bytes writtedn to shuffle and spilled to disk.

Returns
Type Description
long

getSlotMs()

public long getSlotMs()

Returns the slot-milliseconds used by the stage.

Returns
Type Description
long

getStartMs()

public long getStartMs()

Returns the stage start time represented as milliseconds since epoch.

Returns
Type Description
long

getStatus()

public String getStatus()

Returns the current status for the stage.

Returns
Type Description
String

getSteps()

public List<QueryStage.QueryStep> getSteps()

Returns the list of steps within the stage in dependency order (approximately chronological).

Returns
Type Description
List<QueryStep>

getWaitMsAvg()

public long getWaitMsAvg()

Returns the time in milliseconds the average worker spent waiting to be scheduled.

Returns
Type Description
long

getWaitMsMax()

public long getWaitMsMax()

Returns the time in milliseconds the slowest worker spent waiting to be scheduled.

Returns
Type Description
long

getWaitRatioAvg()

public double getWaitRatioAvg()

Returns the time the average worker spent waiting to be scheduled, divided by the longest time spent by any worker in any segment.

Returns
Type Description
double

getWaitRatioMax()

public double getWaitRatioMax()

Returns the time the slowest worker spent waiting to be scheduled, divided by the longest time spent by any worker in any segment.

Returns
Type Description
double

getWriteMsAvg()

public long getWriteMsAvg()

Returns the time in milliseconds the average worker spent writing output.

Returns
Type Description
long

getWriteMsMax()

public long getWriteMsMax()

Returns the time in milliseconds the slowest worker spent writing output.

Returns
Type Description
long

getWriteRatioAvg()

public double getWriteRatioAvg()

Returns the time the average worker spent writing output data, divided by the longest time spent by any worker in any segment.

Returns
Type Description
double

getWriteRatioMax()

public double getWriteRatioMax()

Returns the time the slowest worker spent writing output data, divided by the longest time spent by any worker in any segment.

Returns
Type Description
double

hashCode()

public final int hashCode()
Returns
Type Description
int
Overrides

toString()

public String toString()
Returns
Type Description
String
Overrides