com.google.api.services.bigquery.model

Class ExplainQueryStage

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.bigquery.model.ExplainQueryStage

All Implemented Interfaces:

Cloneable, Map<String,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

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ExplainQueryStage()

Method Summary

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

Number of parallel input segments completed.

Returns:

value or null for none

setCompletedParallelInputs

public ExplainQueryStage setCompletedParallelInputs(Long completedParallelInputs)

Number of parallel input segments completed.

Parameters:

completedParallelInputs - completedParallelInputs or null for none

getComputeMsAvg

public Long getComputeMsAvg()

Milliseconds the average shard spent on CPU-bound tasks.

Returns:

value or null for none

setComputeMsAvg

public ExplainQueryStage setComputeMsAvg(Long computeMsAvg)

Milliseconds the average shard spent on CPU-bound tasks.

Parameters:

computeMsAvg - computeMsAvg or null for none

getComputeMsMax

public Long getComputeMsMax()

Milliseconds the slowest shard spent on CPU-bound tasks.

Returns:

value or null for none

setComputeMsMax

public ExplainQueryStage setComputeMsMax(Long computeMsMax)

Milliseconds the slowest shard spent on CPU-bound tasks.

Parameters:

computeMsMax - computeMsMax or null for none

getComputeRatioAvg

public Double getComputeRatioAvg()

Relative amount of time the average shard spent on CPU-bound tasks.

Returns:

value or null for none

setComputeRatioAvg

public ExplainQueryStage setComputeRatioAvg(Double computeRatioAvg)

Relative amount of time the average shard spent on CPU-bound tasks.

Parameters:

computeRatioAvg - computeRatioAvg or null for none

getComputeRatioMax

public Double getComputeRatioMax()

Relative amount of time the slowest shard spent on CPU-bound tasks.

Returns:

value or null for none

setComputeRatioMax

public ExplainQueryStage setComputeRatioMax(Double computeRatioMax)

Relative amount of time the slowest shard spent on CPU-bound tasks.

Parameters:

computeRatioMax - computeRatioMax or null for none

getEndMs

public Long getEndMs()

Stage end time represented as milliseconds since epoch.

Returns:

value or null for none

setEndMs

public ExplainQueryStage setEndMs(Long endMs)

Stage end time represented as milliseconds since epoch.

Parameters:

endMs - endMs or null for none

getId

public Long getId()

Unique ID for stage within plan.

Returns:

value or null for none

setId

public ExplainQueryStage setId(Long id)

Unique ID for stage within plan.

Parameters:

id - id or null for none

getInputStages

public List<Long> getInputStages()

IDs for stages that are inputs to this stage.

Returns:

value or null for none

setInputStages

public ExplainQueryStage setInputStages(List<Long> inputStages)

IDs for stages that are inputs to this stage.

Parameters:

inputStages - inputStages or null for none

getName

public String getName()

Human-readable name for stage.

Returns:

value or null for none

setName

public ExplainQueryStage setName(String name)

Human-readable name for stage.

Parameters:

name - name or null for none

getParallelInputs

public Long getParallelInputs()

Number of parallel input segments to be processed.

Returns:

value or null for none

setParallelInputs

public ExplainQueryStage setParallelInputs(Long parallelInputs)

Number of parallel input segments to be processed.

Parameters:

parallelInputs - parallelInputs or null for none

getReadMsAvg

public Long getReadMsAvg()

Milliseconds the average shard spent reading input.

Returns:

value or null for none

setReadMsAvg

public ExplainQueryStage setReadMsAvg(Long readMsAvg)

Milliseconds the average shard spent reading input.

Parameters:

readMsAvg - readMsAvg or null for none

getReadMsMax

public Long getReadMsMax()

Milliseconds the slowest shard spent reading input.

Returns:

value or null for none

setReadMsMax

public ExplainQueryStage setReadMsMax(Long readMsMax)

Milliseconds the slowest shard spent reading input.

Parameters:

readMsMax - readMsMax or null for none

getReadRatioAvg

public Double getReadRatioAvg()

Relative amount of time the average shard spent reading input.

Returns:

value or null for none

setReadRatioAvg

public ExplainQueryStage setReadRatioAvg(Double readRatioAvg)

Relative amount of time the average shard spent reading input.

Parameters:

readRatioAvg - readRatioAvg or null for none

getReadRatioMax

public Double getReadRatioMax()

Relative amount of time the slowest shard spent reading input.

Returns:

value or null for none

setReadRatioMax

public ExplainQueryStage setReadRatioMax(Double readRatioMax)

Relative amount of time the slowest shard spent reading input.

Parameters:

readRatioMax - readRatioMax or null for none

getRecordsRead

public Long getRecordsRead()

Number of records read into the stage.

Returns:

value or null for none

setRecordsRead

public ExplainQueryStage setRecordsRead(Long recordsRead)

Number of records read into the stage.

Parameters:

recordsRead - recordsRead or null for none

getRecordsWritten

public Long getRecordsWritten()

Number of records written by the stage.

Returns:

value or null for none

setRecordsWritten

public ExplainQueryStage setRecordsWritten(Long recordsWritten)

Number of records written by the stage.

Parameters:

recordsWritten - recordsWritten or null for none

getShuffleOutputBytes

public Long getShuffleOutputBytes()

Total number of bytes written to shuffle.

Returns:

value or null for none

setShuffleOutputBytes

public ExplainQueryStage setShuffleOutputBytes(Long shuffleOutputBytes)

Total number of bytes written to shuffle.

Parameters:

shuffleOutputBytes - shuffleOutputBytes or null for none

getShuffleOutputBytesSpilled

public Long getShuffleOutputBytesSpilled()

Total number of bytes written to shuffle and spilled to disk.

Returns:

value or null for none

setShuffleOutputBytesSpilled

public ExplainQueryStage setShuffleOutputBytesSpilled(Long shuffleOutputBytesSpilled)

Total number of bytes written to shuffle and spilled to disk.

Parameters:

shuffleOutputBytesSpilled - shuffleOutputBytesSpilled or null for none

getStartMs

public Long getStartMs()

Stage start time represented as milliseconds since epoch.

Returns:

value or null for none

setStartMs

public ExplainQueryStage setStartMs(Long startMs)

Stage start time represented as milliseconds since epoch.

Parameters:

startMs - startMs or null for none

getStatus

public String getStatus()

Current status for the stage.

Returns:

value or null for none

setStatus

public ExplainQueryStage setStatus(String status)

Current status for the stage.

Parameters:

status - status or null for none

getSteps

public List<ExplainQueryStep> getSteps()

List of operations within the stage in dependency order (approximately chronological).

Returns:

value or null for none

setSteps

public ExplainQueryStage setSteps(List<ExplainQueryStep> steps)

List of operations within the stage in dependency order (approximately chronological).

Parameters:

steps - steps or null for none

getWaitMsAvg

public Long getWaitMsAvg()

Milliseconds the average shard spent waiting to be scheduled.

Returns:

value or null for none

setWaitMsAvg

public ExplainQueryStage setWaitMsAvg(Long waitMsAvg)

Milliseconds the average shard spent waiting to be scheduled.

Parameters:

waitMsAvg - waitMsAvg or null for none

getWaitMsMax

public Long getWaitMsMax()

Milliseconds the slowest shard spent waiting to be scheduled.

Returns:

value or null for none

setWaitMsMax

public ExplainQueryStage setWaitMsMax(Long waitMsMax)

Milliseconds the slowest shard spent waiting to be scheduled.

Parameters:

waitMsMax - waitMsMax or null for none

getWaitRatioAvg

public Double getWaitRatioAvg()

Relative amount of time the average shard spent waiting to be scheduled.

Returns:

value or null for none

setWaitRatioAvg

public ExplainQueryStage setWaitRatioAvg(Double waitRatioAvg)

Relative amount of time the average shard spent waiting to be scheduled.

Parameters:

waitRatioAvg - waitRatioAvg or null for none

getWaitRatioMax

public Double getWaitRatioMax()

Relative amount of time the slowest shard spent waiting to be scheduled.

Returns:

value or null for none

setWaitRatioMax

public ExplainQueryStage setWaitRatioMax(Double waitRatioMax)

Relative amount of time the slowest shard spent waiting to be scheduled.

Parameters:

waitRatioMax - waitRatioMax or null for none

getWriteMsAvg

public Long getWriteMsAvg()

Milliseconds the average shard spent on writing output.

Returns:

value or null for none

setWriteMsAvg

public ExplainQueryStage setWriteMsAvg(Long writeMsAvg)

Milliseconds the average shard spent on writing output.

Parameters:

writeMsAvg - writeMsAvg or null for none

getWriteMsMax

public Long getWriteMsMax()

Milliseconds the slowest shard spent on writing output.

Returns:

value or null for none

setWriteMsMax

public ExplainQueryStage setWriteMsMax(Long writeMsMax)

Milliseconds the slowest shard spent on writing output.

Parameters:

writeMsMax - writeMsMax or null for none

getWriteRatioAvg

public Double getWriteRatioAvg()

Relative amount of time the average shard spent on writing output.

Returns:

value or null for none

setWriteRatioAvg

public ExplainQueryStage setWriteRatioAvg(Double writeRatioAvg)

Relative amount of time the average shard spent on writing output.

Parameters:

writeRatioAvg - writeRatioAvg or null for none

getWriteRatioMax

public Double getWriteRatioMax()

Relative amount of time the slowest shard spent on writing output.

Returns:

value or null for none

setWriteRatioMax

public ExplainQueryStage setWriteRatioMax(Double writeRatioMax)

Relative amount of time the slowest shard spent on writing output.

Parameters:

writeRatioMax - writeRatioMax or null for none

set

public ExplainQueryStage set(String fieldName,
                             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