Send feedback
Class QueryStage (2.43.1)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.43.1 keyboard_arrow_down
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
Methods
equals(Object obj)
public final boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
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()
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
public List<Long> getInputStages ()
Returns a list of the stage IDs that are inputs to this stage.
getName()
Returns a human-readable name for the stage.
Returns
Type
Description
String
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()
Returns the slot-milliseconds used by the stage.
Returns
Type
Description
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).
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()
Returns
Type
Description
String
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]