ExplainQueryStage (BigQuery API v2 (Rev. 459) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.bigquery.model.ExplainQueryStage

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class ExplainQueryStage
extends com.google.api.client.json.GenericJson
```
Model definition for ExplainQueryStage.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the BigQuery API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

ExplainQueryStage()

Constructors
Constructor and Description
`ExplainQueryStage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExplainQueryStage`	`clone()`
`java.lang.Long`	`getCompletedParallelInputs()` Number of parallel input segments completed.
`java.lang.Long`	`getComputeMsAvg()` Milliseconds the average shard spent on CPU-bound tasks.
`java.lang.Long`	`getComputeMsMax()` Milliseconds the slowest shard spent on CPU-bound tasks.
`java.lang.Double`	`getComputeRatioAvg()` Relative amount of time the average shard spent on CPU-bound tasks.
`java.lang.Double`	`getComputeRatioMax()` Relative amount of time the slowest shard spent on CPU-bound tasks.
`java.lang.Long`	`getEndMs()` Stage end time represented as milliseconds since epoch.
`java.lang.Long`	`getId()` Unique ID for stage within plan.
`java.util.List<java.lang.Long>`	`getInputStages()` IDs for stages that are inputs to this stage.
`java.lang.String`	`getName()` Human-readable name for stage.
`java.lang.Long`	`getParallelInputs()` Number of parallel input segments to be processed.
`java.lang.Long`	`getReadMsAvg()` Milliseconds the average shard spent reading input.
`java.lang.Long`	`getReadMsMax()` Milliseconds the slowest shard spent reading input.
`java.lang.Double`	`getReadRatioAvg()` Relative amount of time the average shard spent reading input.
`java.lang.Double`	`getReadRatioMax()` Relative amount of time the slowest shard spent reading input.
`java.lang.Long`	`getRecordsRead()` Number of records read into the stage.
`java.lang.Long`	`getRecordsWritten()` Number of records written by the stage.
`java.lang.Long`	`getShuffleOutputBytes()` Total number of bytes written to shuffle.
`java.lang.Long`	`getShuffleOutputBytesSpilled()` Total number of bytes written to shuffle and spilled to disk.
`java.lang.Long`	`getSlotMs()` Slot-milliseconds used by the stage.
`java.lang.Long`	`getStartMs()` Stage start time represented as milliseconds since epoch.
`java.lang.String`	`getStatus()` Current status for the stage.
`java.util.List<ExplainQueryStep>`	`getSteps()` List of operations within the stage in dependency order (approximately chronological).
`java.lang.Long`	`getWaitMsAvg()` Milliseconds the average shard spent waiting to be scheduled.
`java.lang.Long`	`getWaitMsMax()` Milliseconds the slowest shard spent waiting to be scheduled.
`java.lang.Double`	`getWaitRatioAvg()` Relative amount of time the average shard spent waiting to be scheduled.
`java.lang.Double`	`getWaitRatioMax()` Relative amount of time the slowest shard spent waiting to be scheduled.
`java.lang.Long`	`getWriteMsAvg()` Milliseconds the average shard spent on writing output.
`java.lang.Long`	`getWriteMsMax()` Milliseconds the slowest shard spent on writing output.
`java.lang.Double`	`getWriteRatioAvg()` Relative amount of time the average shard spent on writing output.
`java.lang.Double`	`getWriteRatioMax()` Relative amount of time the slowest shard spent on writing output.
`ExplainQueryStage`	`set(java.lang.String fieldName, java.lang.Object value)`
`ExplainQueryStage`	`setCompletedParallelInputs(java.lang.Long completedParallelInputs)` Number of parallel input segments completed.
`ExplainQueryStage`	`setComputeMsAvg(java.lang.Long computeMsAvg)` Milliseconds the average shard spent on CPU-bound tasks.
`ExplainQueryStage`	`setComputeMsMax(java.lang.Long computeMsMax)` Milliseconds the slowest shard spent on CPU-bound tasks.
`ExplainQueryStage`	`setComputeRatioAvg(java.lang.Double computeRatioAvg)` Relative amount of time the average shard spent on CPU-bound tasks.
`ExplainQueryStage`	`setComputeRatioMax(java.lang.Double computeRatioMax)` Relative amount of time the slowest shard spent on CPU-bound tasks.
`ExplainQueryStage`	`setEndMs(java.lang.Long endMs)` Stage end time represented as milliseconds since epoch.
`ExplainQueryStage`	`setId(java.lang.Long id)` Unique ID for stage within plan.
`ExplainQueryStage`	`setInputStages(java.util.List<java.lang.Long> inputStages)` IDs for stages that are inputs to this stage.
`ExplainQueryStage`	`setName(java.lang.String name)` Human-readable name for stage.
`ExplainQueryStage`	`setParallelInputs(java.lang.Long parallelInputs)` Number of parallel input segments to be processed.
`ExplainQueryStage`	`setReadMsAvg(java.lang.Long readMsAvg)` Milliseconds the average shard spent reading input.
`ExplainQueryStage`	`setReadMsMax(java.lang.Long readMsMax)` Milliseconds the slowest shard spent reading input.
`ExplainQueryStage`	`setReadRatioAvg(java.lang.Double readRatioAvg)` Relative amount of time the average shard spent reading input.
`ExplainQueryStage`	`setReadRatioMax(java.lang.Double readRatioMax)` Relative amount of time the slowest shard spent reading input.
`ExplainQueryStage`	`setRecordsRead(java.lang.Long recordsRead)` Number of records read into the stage.
`ExplainQueryStage`	`setRecordsWritten(java.lang.Long recordsWritten)` Number of records written by the stage.
`ExplainQueryStage`	`setShuffleOutputBytes(java.lang.Long shuffleOutputBytes)` Total number of bytes written to shuffle.
`ExplainQueryStage`	`setShuffleOutputBytesSpilled(java.lang.Long shuffleOutputBytesSpilled)` Total number of bytes written to shuffle and spilled to disk.
`ExplainQueryStage`	`setSlotMs(java.lang.Long slotMs)` Slot-milliseconds used by the stage.
`ExplainQueryStage`	`setStartMs(java.lang.Long startMs)` Stage start time represented as milliseconds since epoch.
`ExplainQueryStage`	`setStatus(java.lang.String status)` Current status for the stage.
`ExplainQueryStage`	`setSteps(java.util.List<ExplainQueryStep> steps)` List of operations within the stage in dependency order (approximately chronological).
`ExplainQueryStage`	`setWaitMsAvg(java.lang.Long waitMsAvg)` Milliseconds the average shard spent waiting to be scheduled.
`ExplainQueryStage`	`setWaitMsMax(java.lang.Long waitMsMax)` Milliseconds the slowest shard spent waiting to be scheduled.
`ExplainQueryStage`	`setWaitRatioAvg(java.lang.Double waitRatioAvg)` Relative amount of time the average shard spent waiting to be scheduled.
`ExplainQueryStage`	`setWaitRatioMax(java.lang.Double waitRatioMax)` Relative amount of time the slowest shard spent waiting to be scheduled.
`ExplainQueryStage`	`setWriteMsAvg(java.lang.Long writeMsAvg)` Milliseconds the average shard spent on writing output.
`ExplainQueryStage`	`setWriteMsMax(java.lang.Long writeMsMax)` Milliseconds the slowest shard spent on writing output.
`ExplainQueryStage`	`setWriteRatioAvg(java.lang.Double writeRatioAvg)` Relative amount of time the average shard spent on writing output.
`ExplainQueryStage`	`setWriteRatioMax(java.lang.Double writeRatioMax)` Relative amount of time the slowest shard spent on writing output.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - ExplainQueryStage
```
public ExplainQueryStage()
```
- Method Detail
  - getCompletedParallelInputs
```
public java.lang.Long getCompletedParallelInputs()
```
    Number of parallel input segments completed.
    
    Returns:
    
    value or null for none
  - setCompletedParallelInputs
```
public ExplainQueryStage setCompletedParallelInputs(java.lang.Long completedParallelInputs)
```
    Number of parallel input segments completed.
    
    Parameters:
    
    completedParallelInputs - completedParallelInputs or null for none
  - getComputeMsAvg
```
public java.lang.Long getComputeMsAvg()
```
    Milliseconds the average shard spent on CPU-bound tasks.
    
    Returns:
    
    value or null for none
  - setComputeMsAvg
```
public ExplainQueryStage setComputeMsAvg(java.lang.Long computeMsAvg)
```
    Milliseconds the average shard spent on CPU-bound tasks.
    
    Parameters:
    
    computeMsAvg - computeMsAvg or null for none
  - getComputeMsMax
```
public java.lang.Long getComputeMsMax()
```
    Milliseconds the slowest shard spent on CPU-bound tasks.
    
    Returns:
    
    value or null for none
  - setComputeMsMax
```
public ExplainQueryStage setComputeMsMax(java.lang.Long computeMsMax)
```
    Milliseconds the slowest shard spent on CPU-bound tasks.
    
    Parameters:
    
    computeMsMax - computeMsMax or null for none
  - getComputeRatioAvg
```
public java.lang.Double getComputeRatioAvg()
```
    Relative amount of time the average shard spent on CPU-bound tasks.
    
    Returns:
    
    value or null for none
  - setComputeRatioAvg
```
public ExplainQueryStage setComputeRatioAvg(java.lang.Double computeRatioAvg)
```
    Relative amount of time the average shard spent on CPU-bound tasks.
    
    Parameters:
    
    computeRatioAvg - computeRatioAvg or null for none
  - getComputeRatioMax
```
public java.lang.Double getComputeRatioMax()
```
    Relative amount of time the slowest shard spent on CPU-bound tasks.
    
    Returns:
    
    value or null for none
  - setComputeRatioMax
```
public ExplainQueryStage setComputeRatioMax(java.lang.Double computeRatioMax)
```
    Relative amount of time the slowest shard spent on CPU-bound tasks.
    
    Parameters:
    
    computeRatioMax - computeRatioMax or null for none
  - getEndMs
```
public java.lang.Long getEndMs()
```
    Stage end time represented as milliseconds since epoch.
    
    Returns:
    
    value or null for none
  - setEndMs
```
public ExplainQueryStage setEndMs(java.lang.Long endMs)
```
    Stage end time represented as milliseconds since epoch.
    
    Parameters:
    
    endMs - endMs or null for none
  - getId
```
public java.lang.Long getId()
```
    Unique ID for stage within plan.
    
    Returns:
    
    value or null for none
  - setId
```
public ExplainQueryStage setId(java.lang.Long id)
```
    Unique ID for stage within plan.
    
    Parameters:
    
    id - id or null for none
  - getInputStages
```
public java.util.List<java.lang.Long> getInputStages()
```
    IDs for stages that are inputs to this stage.
    
    Returns:
    
    value or null for none
  - setInputStages
```
public ExplainQueryStage setInputStages(java.util.List<java.lang.Long> inputStages)
```
    IDs for stages that are inputs to this stage.
    
    Parameters:
    
    inputStages - inputStages or null for none
  - getName
```
public java.lang.String getName()
```
    Human-readable name for stage.
    
    Returns:
    
    value or null for none
  - setName
```
public ExplainQueryStage setName(java.lang.String name)
```
    Human-readable name for stage.
    
    Parameters:
    
    name - name or null for none
  - getParallelInputs
```
public java.lang.Long getParallelInputs()
```
    Number of parallel input segments to be processed.
    
    Returns:
    
    value or null for none
  - setParallelInputs
```
public ExplainQueryStage setParallelInputs(java.lang.Long parallelInputs)
```
    Number of parallel input segments to be processed.
    
    Parameters:
    
    parallelInputs - parallelInputs or null for none
  - getReadMsAvg
```
public java.lang.Long getReadMsAvg()
```
    Milliseconds the average shard spent reading input.
    
    Returns:
    
    value or null for none
  - setReadMsAvg
```
public ExplainQueryStage setReadMsAvg(java.lang.Long readMsAvg)
```
    Milliseconds the average shard spent reading input.
    
    Parameters:
    
    readMsAvg - readMsAvg or null for none
  - getReadMsMax
```
public java.lang.Long getReadMsMax()
```
    Milliseconds the slowest shard spent reading input.
    
    Returns:
    
    value or null for none
  - setReadMsMax
```
public ExplainQueryStage setReadMsMax(java.lang.Long readMsMax)
```
    Milliseconds the slowest shard spent reading input.
    
    Parameters:
    
    readMsMax - readMsMax or null for none
  - getReadRatioAvg
```
public java.lang.Double getReadRatioAvg()
```
    Relative amount of time the average shard spent reading input.
    
    Returns:
    
    value or null for none
  - setReadRatioAvg
```
public ExplainQueryStage setReadRatioAvg(java.lang.Double readRatioAvg)
```
    Relative amount of time the average shard spent reading input.
    
    Parameters:
    
    readRatioAvg - readRatioAvg or null for none
  - getReadRatioMax
```
public java.lang.Double getReadRatioMax()
```
    Relative amount of time the slowest shard spent reading input.
    
    Returns:
    
    value or null for none
  - setReadRatioMax
```
public ExplainQueryStage setReadRatioMax(java.lang.Double readRatioMax)
```
    Relative amount of time the slowest shard spent reading input.
    
    Parameters:
    
    readRatioMax - readRatioMax or null for none
  - getRecordsRead
```
public java.lang.Long getRecordsRead()
```
    Number of records read into the stage.
    
    Returns:
    
    value or null for none
  - setRecordsRead
```
public ExplainQueryStage setRecordsRead(java.lang.Long recordsRead)
```
    Number of records read into the stage.
    
    Parameters:
    
    recordsRead - recordsRead or null for none
  - getRecordsWritten
```
public java.lang.Long getRecordsWritten()
```
    Number of records written by the stage.
    
    Returns:
    
    value or null for none
  - setRecordsWritten
```
public ExplainQueryStage setRecordsWritten(java.lang.Long recordsWritten)
```
    Number of records written by the stage.
    
    Parameters:
    
    recordsWritten - recordsWritten or null for none
  - getShuffleOutputBytes
```
public java.lang.Long getShuffleOutputBytes()
```
    Total number of bytes written to shuffle.
    
    Returns:
    
    value or null for none
  - setShuffleOutputBytes
```
public ExplainQueryStage setShuffleOutputBytes(java.lang.Long shuffleOutputBytes)
```
    Total number of bytes written to shuffle.
    
    Parameters:
    
    shuffleOutputBytes - shuffleOutputBytes or null for none
  - getShuffleOutputBytesSpilled
```
public java.lang.Long getShuffleOutputBytesSpilled()
```
    Total number of bytes written to shuffle and spilled to disk.
    
    Returns:
    
    value or null for none
  - setShuffleOutputBytesSpilled
```
public ExplainQueryStage setShuffleOutputBytesSpilled(java.lang.Long shuffleOutputBytesSpilled)
```
    Total number of bytes written to shuffle and spilled to disk.
    
    Parameters:
    
    shuffleOutputBytesSpilled - shuffleOutputBytesSpilled or null for none
  - getSlotMs
```
public java.lang.Long getSlotMs()
```
    Slot-milliseconds used by the stage.
    
    Returns:
    
    value or null for none
  - setSlotMs
```
public ExplainQueryStage setSlotMs(java.lang.Long slotMs)
```
    Slot-milliseconds used by the stage.
    
    Parameters:
    
    slotMs - slotMs or null for none
  - getStartMs
```
public java.lang.Long getStartMs()
```
    Stage start time represented as milliseconds since epoch.
    
    Returns:
    
    value or null for none
  - setStartMs
```
public ExplainQueryStage setStartMs(java.lang.Long startMs)
```
    Stage start time represented as milliseconds since epoch.
    
    Parameters:
    
    startMs - startMs or null for none
  - getStatus
```
public java.lang.String getStatus()
```
    Current status for the stage.
    
    Returns:
    
    value or null for none
  - setStatus
```
public ExplainQueryStage setStatus(java.lang.String status)
```
    Current status for the stage.
    
    Parameters:
    
    status - status or null for none
  - getSteps
```
public java.util.List<ExplainQueryStep> getSteps()
```
    List of operations within the stage in dependency order (approximately chronological).
    
    Returns:
    
    value or null for none
  - setSteps
```
public ExplainQueryStage setSteps(java.util.List<ExplainQueryStep> steps)
```
    List of operations within the stage in dependency order (approximately chronological).
    
    Parameters:
    
    steps - steps or null for none
  - getWaitMsAvg
```
public java.lang.Long getWaitMsAvg()
```
    Milliseconds the average shard spent waiting to be scheduled.
    
    Returns:
    
    value or null for none
  - setWaitMsAvg
```
public ExplainQueryStage setWaitMsAvg(java.lang.Long waitMsAvg)
```
    Milliseconds the average shard spent waiting to be scheduled.
    
    Parameters:
    
    waitMsAvg - waitMsAvg or null for none
  - getWaitMsMax
```
public java.lang.Long getWaitMsMax()
```
    Milliseconds the slowest shard spent waiting to be scheduled.
    
    Returns:
    
    value or null for none
  - setWaitMsMax
```
public ExplainQueryStage setWaitMsMax(java.lang.Long waitMsMax)
```
    Milliseconds the slowest shard spent waiting to be scheduled.
    
    Parameters:
    
    waitMsMax - waitMsMax or null for none
  - getWaitRatioAvg
```
public java.lang.Double getWaitRatioAvg()
```
    Relative amount of time the average shard spent waiting to be scheduled.
    
    Returns:
    
    value or null for none
  - setWaitRatioAvg
```
public ExplainQueryStage setWaitRatioAvg(java.lang.Double waitRatioAvg)
```
    Relative amount of time the average shard spent waiting to be scheduled.
    
    Parameters:
    
    waitRatioAvg - waitRatioAvg or null for none
  - getWaitRatioMax
```
public java.lang.Double getWaitRatioMax()
```
    Relative amount of time the slowest shard spent waiting to be scheduled.
    
    Returns:
    
    value or null for none
  - setWaitRatioMax
```
public ExplainQueryStage setWaitRatioMax(java.lang.Double waitRatioMax)
```
    Relative amount of time the slowest shard spent waiting to be scheduled.
    
    Parameters:
    
    waitRatioMax - waitRatioMax or null for none
  - getWriteMsAvg
```
public java.lang.Long getWriteMsAvg()
```
    Milliseconds the average shard spent on writing output.
    
    Returns:
    
    value or null for none
  - setWriteMsAvg
```
public ExplainQueryStage setWriteMsAvg(java.lang.Long writeMsAvg)
```
    Milliseconds the average shard spent on writing output.
    
    Parameters:
    
    writeMsAvg - writeMsAvg or null for none
  - getWriteMsMax
```
public java.lang.Long getWriteMsMax()
```
    Milliseconds the slowest shard spent on writing output.
    
    Returns:
    
    value or null for none
  - setWriteMsMax
```
public ExplainQueryStage setWriteMsMax(java.lang.Long writeMsMax)
```
    Milliseconds the slowest shard spent on writing output.
    
    Parameters:
    
    writeMsMax - writeMsMax or null for none
  - getWriteRatioAvg
```
public java.lang.Double getWriteRatioAvg()
```
    Relative amount of time the average shard spent on writing output.
    
    Returns:
    
    value or null for none
  - setWriteRatioAvg
```
public ExplainQueryStage setWriteRatioAvg(java.lang.Double writeRatioAvg)
```
    Relative amount of time the average shard spent on writing output.
    
    Parameters:
    
    writeRatioAvg - writeRatioAvg or null for none
  - getWriteRatioMax
```
public java.lang.Double getWriteRatioMax()
```
    Relative amount of time the slowest shard spent on writing output.
    
    Returns:
    
    value or null for none
  - setWriteRatioMax
```
public ExplainQueryStage setWriteRatioMax(java.lang.Double writeRatioMax)
```
    Relative amount of time the slowest shard spent on writing output.
    
    Parameters:
    
    writeRatioMax - writeRatioMax or null for none
  - set
```
public ExplainQueryStage set(java.lang.String fieldName,
                             java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public ExplainQueryStage clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

BigQuery API v2 (revision 459)

Class ExplainQueryStage

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

ExplainQueryStage

Method Detail

getCompletedParallelInputs

setCompletedParallelInputs

getComputeMsAvg

setComputeMsAvg

getComputeMsMax

setComputeMsMax

getComputeRatioAvg

setComputeRatioAvg

getComputeRatioMax

setComputeRatioMax

getEndMs

setEndMs

getId

setId

getInputStages

setInputStages

getName

setName

getParallelInputs

setParallelInputs

getReadMsAvg

setReadMsAvg

getReadMsMax

setReadMsMax

getReadRatioAvg

setReadRatioAvg

getReadRatioMax

setReadRatioMax

getRecordsRead

setRecordsRead

getRecordsWritten

setRecordsWritten

getShuffleOutputBytes

setShuffleOutputBytes

getShuffleOutputBytesSpilled

setShuffleOutputBytesSpilled

getSlotMs

setSlotMs

getStartMs

setStartMs

getStatus

setStatus

getSteps

setSteps

getWaitMsAvg

setWaitMsAvg

getWaitMsMax

setWaitMsMax

getWaitRatioAvg

setWaitRatioAvg

getWaitRatioMax

setWaitRatioMax

getWriteMsAvg

setWriteMsAvg

getWriteMsMax

setWriteMsMax

getWriteRatioAvg

setWriteRatioAvg

getWriteRatioMax

setWriteRatioMax

set

clone