Documentation

Google_Service_Bigquery_ExplainQueryStage extends Google_Collection
in package

Extension to the regular Google_Model that automatically exposes the items array for iteration, so you can just iterate over the object rather than a reference inside.

Table of Contents

NULL_VALUE  = "{}gapi-php-null"
If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.
$completedParallelInputs  : mixed
$computeMsAvg  : mixed
$computeMsMax  : mixed
$computeRatioAvg  : mixed
$computeRatioMax  : mixed
$endMs  : mixed
$id  : mixed
$inputStages  : mixed
$name  : mixed
$parallelInputs  : mixed
$readMsAvg  : mixed
$readMsMax  : mixed
$readRatioAvg  : mixed
$readRatioMax  : mixed
$recordsRead  : mixed
$recordsWritten  : mixed
$shuffleOutputBytes  : mixed
$shuffleOutputBytesSpilled  : mixed
$slotMs  : mixed
$startMs  : mixed
$status  : mixed
$waitMsAvg  : mixed
$waitMsMax  : mixed
$waitRatioAvg  : mixed
$waitRatioMax  : mixed
$writeMsAvg  : mixed
$writeMsMax  : mixed
$writeRatioAvg  : mixed
$writeRatioMax  : mixed
$collection_key  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$processed  : mixed
$stepsDataType  : mixed
$stepsType  : mixed
__construct()  : mixed
Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.
__get()  : mixed
Getter that handles passthrough access to the data array, and lazy object creation.
__isset()  : mixed
__unset()  : mixed
assertIsArray()  : mixed
Verify if $obj is an array.
count()  : mixed
current()  : mixed
getCompletedParallelInputs()  : mixed
getComputeMsAvg()  : mixed
getComputeMsMax()  : mixed
getComputeRatioAvg()  : mixed
getComputeRatioMax()  : mixed
getEndMs()  : mixed
getId()  : mixed
getInputStages()  : mixed
getName()  : mixed
getParallelInputs()  : mixed
getReadMsAvg()  : mixed
getReadMsMax()  : mixed
getReadRatioAvg()  : mixed
getReadRatioMax()  : mixed
getRecordsRead()  : mixed
getRecordsWritten()  : mixed
getShuffleOutputBytes()  : mixed
getShuffleOutputBytesSpilled()  : mixed
getSlotMs()  : mixed
getStartMs()  : mixed
getStatus()  : mixed
getSteps()  : Google_Service_Bigquery_ExplainQueryStep
getWaitMsAvg()  : mixed
getWaitMsMax()  : mixed
getWaitRatioAvg()  : mixed
getWaitRatioMax()  : mixed
getWriteMsAvg()  : mixed
getWriteMsMax()  : mixed
getWriteRatioAvg()  : mixed
getWriteRatioMax()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setCompletedParallelInputs()  : mixed
setComputeMsAvg()  : mixed
setComputeMsMax()  : mixed
setComputeRatioAvg()  : mixed
setComputeRatioMax()  : mixed
setEndMs()  : mixed
setId()  : mixed
setInputStages()  : mixed
setName()  : mixed
setParallelInputs()  : mixed
setReadMsAvg()  : mixed
setReadMsMax()  : mixed
setReadRatioAvg()  : mixed
setReadRatioMax()  : mixed
setRecordsRead()  : mixed
setRecordsWritten()  : mixed
setShuffleOutputBytes()  : mixed
setShuffleOutputBytesSpilled()  : mixed
setSlotMs()  : mixed
setStartMs()  : mixed
setStatus()  : mixed
setSteps()  : mixed
setWaitMsAvg()  : mixed
setWaitMsMax()  : mixed
setWaitRatioAvg()  : mixed
setWaitRatioMax()  : mixed
setWriteMsAvg()  : mixed
setWriteMsMax()  : mixed
setWriteRatioAvg()  : mixed
setWriteRatioMax()  : mixed
toSimpleObject()  : mixed
Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.
valid()  : mixed
dataType()  : mixed
gapiInit()  : mixed
Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.
isAssociativeArray()  : bool
Returns true only if the array is associative.
keyType()  : mixed
mapTypes()  : void
Initialize this object's properties from an array.
camelCase()  : string
Convert a string to camelCase
coerceType()  : mixed
getMappedName()  : mixed
If there is an internal name mapping, use that.
getSimpleValue()  : mixed
Handle different types of values, primarily other objects and map and array data types.
nullPlaceholderCheck()  : mixed
Check whether the value is the null placeholder and return true null.

Constants

NULL_VALUE

If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.

public mixed NULL_VALUE = "{}gapi-php-null"

Properties

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

$stepsType

protected mixed $stepsType = 'Google_Service_Bigquery_ExplainQueryStep'

Methods

__construct()

Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.

public final __construct() : mixed
Return values
mixed

__get()

Getter that handles passthrough access to the data array, and lazy object creation.

public __get(string $key) : mixed
Parameters
$key : string

Property name.

Return values
mixed

The value if any, or null.

__isset()

public __isset(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed

__unset()

public __unset(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed

assertIsArray()

Verify if $obj is an array.

public assertIsArray(array<string|int, mixed> $obj, string $method) : mixed
Parameters
$obj : array<string|int, mixed>

Items that should be validated.

$method : string

Method expecting an array as an argument.

Tags
throws
Google_Exception

Thrown if $obj isn't an array.

Return values
mixed

count()

public count() : mixed
Return values
mixed

current()

public current() : mixed
Return values
mixed

getCompletedParallelInputs()

public getCompletedParallelInputs() : mixed
Return values
mixed

getComputeRatioAvg()

public getComputeRatioAvg() : mixed
Return values
mixed

getComputeRatioMax()

public getComputeRatioMax() : mixed
Return values
mixed

getParallelInputs()

public getParallelInputs() : mixed
Return values
mixed

getRecordsWritten()

public getRecordsWritten() : mixed
Return values
mixed

getShuffleOutputBytes()

public getShuffleOutputBytes() : mixed
Return values
mixed

getShuffleOutputBytesSpilled()

public getShuffleOutputBytesSpilled() : mixed
Return values
mixed

getWriteRatioAvg()

public getWriteRatioAvg() : mixed
Return values
mixed

getWriteRatioMax()

public getWriteRatioMax() : mixed
Return values
mixed

key()

public key() : mixed
Return values
mixed

next()

public next() : mixed
Return values
mixed

offsetExists()

public offsetExists(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

offsetSet()

public offsetSet(mixed $offset, mixed $value) : mixed
Parameters
$offset : mixed
$value : mixed
Return values
mixed

offsetUnset()

public offsetUnset(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

rewind()

public rewind() : mixed
Return values
mixed

setCompletedParallelInputs()

public setCompletedParallelInputs(mixed $completedParallelInputs) : mixed
Parameters
$completedParallelInputs : mixed
Return values
mixed

setComputeMsAvg()

public setComputeMsAvg(mixed $computeMsAvg) : mixed
Parameters
$computeMsAvg : mixed
Return values
mixed

setComputeMsMax()

public setComputeMsMax(mixed $computeMsMax) : mixed
Parameters
$computeMsMax : mixed
Return values
mixed

setComputeRatioAvg()

public setComputeRatioAvg(mixed $computeRatioAvg) : mixed
Parameters
$computeRatioAvg : mixed
Return values
mixed

setComputeRatioMax()

public setComputeRatioMax(mixed $computeRatioMax) : mixed
Parameters
$computeRatioMax : mixed
Return values
mixed

setEndMs()

public setEndMs(mixed $endMs) : mixed
Parameters
$endMs : mixed
Return values
mixed

setId()

public setId(mixed $id) : mixed
Parameters
$id : mixed
Return values
mixed

setInputStages()

public setInputStages(mixed $inputStages) : mixed
Parameters
$inputStages : mixed
Return values
mixed

setName()

public setName(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed

setParallelInputs()

public setParallelInputs(mixed $parallelInputs) : mixed
Parameters
$parallelInputs : mixed
Return values
mixed

setReadMsAvg()

public setReadMsAvg(mixed $readMsAvg) : mixed
Parameters
$readMsAvg : mixed
Return values
mixed

setReadMsMax()

public setReadMsMax(mixed $readMsMax) : mixed
Parameters
$readMsMax : mixed
Return values
mixed

setReadRatioAvg()

public setReadRatioAvg(mixed $readRatioAvg) : mixed
Parameters
$readRatioAvg : mixed
Return values
mixed

setReadRatioMax()

public setReadRatioMax(mixed $readRatioMax) : mixed
Parameters
$readRatioMax : mixed
Return values
mixed

setRecordsRead()

public setRecordsRead(mixed $recordsRead) : mixed
Parameters
$recordsRead : mixed
Return values
mixed

setRecordsWritten()

public setRecordsWritten(mixed $recordsWritten) : mixed
Parameters
$recordsWritten : mixed
Return values
mixed

setShuffleOutputBytes()

public setShuffleOutputBytes(mixed $shuffleOutputBytes) : mixed
Parameters
$shuffleOutputBytes : mixed
Return values
mixed

setShuffleOutputBytesSpilled()

public setShuffleOutputBytesSpilled(mixed $shuffleOutputBytesSpilled) : mixed
Parameters
$shuffleOutputBytesSpilled : mixed
Return values
mixed

setSlotMs()

public setSlotMs(mixed $slotMs) : mixed
Parameters
$slotMs : mixed
Return values
mixed

setStartMs()

public setStartMs(mixed $startMs) : mixed
Parameters
$startMs : mixed
Return values
mixed

setStatus()

public setStatus(mixed $status) : mixed
Parameters
$status : mixed
Return values
mixed

setSteps()

public setSteps(mixed $steps) : mixed
Parameters
$steps : mixed
Return values
mixed

setWaitMsAvg()

public setWaitMsAvg(mixed $waitMsAvg) : mixed
Parameters
$waitMsAvg : mixed
Return values
mixed

setWaitMsMax()

public setWaitMsMax(mixed $waitMsMax) : mixed
Parameters
$waitMsMax : mixed
Return values
mixed

setWaitRatioAvg()

public setWaitRatioAvg(mixed $waitRatioAvg) : mixed
Parameters
$waitRatioAvg : mixed
Return values
mixed

setWaitRatioMax()

public setWaitRatioMax(mixed $waitRatioMax) : mixed
Parameters
$waitRatioMax : mixed
Return values
mixed

setWriteMsAvg()

public setWriteMsAvg(mixed $writeMsAvg) : mixed
Parameters
$writeMsAvg : mixed
Return values
mixed

setWriteMsMax()

public setWriteMsMax(mixed $writeMsMax) : mixed
Parameters
$writeMsMax : mixed
Return values
mixed

setWriteRatioAvg()

public setWriteRatioAvg(mixed $writeRatioAvg) : mixed
Parameters
$writeRatioAvg : mixed
Return values
mixed

setWriteRatioMax()

public setWriteRatioMax(mixed $writeRatioMax) : mixed
Parameters
$writeRatioMax : mixed
Return values
mixed

toSimpleObject()

Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.

public toSimpleObject() : mixed
Return values
mixed

valid()

public valid() : mixed
Return values
mixed

dataType()

protected dataType(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed

gapiInit()

Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.

protected gapiInit() : mixed
Return values
mixed

isAssociativeArray()

Returns true only if the array is associative.

protected isAssociativeArray(array<string|int, mixed> $array) : bool
Parameters
$array : array<string|int, mixed>
Return values
bool

True if the array is associative.

keyType()

protected keyType(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed

mapTypes()

Initialize this object's properties from an array.

protected mapTypes(array<string|int, mixed> $array) : void
Parameters
$array : array<string|int, mixed>

Used to seed this object's properties.

Return values
void

camelCase()

Convert a string to camelCase

private camelCase(string $value) : string
Parameters
$value : string
Return values
string

coerceType()

private coerceType(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

getMappedName()

If there is an internal name mapping, use that.

private getMappedName(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed

getSimpleValue()

Handle different types of values, primarily other objects and map and array data types.

private getSimpleValue(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

nullPlaceholderCheck()

Check whether the value is the null placeholder and return true null.

private nullPlaceholderCheck(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

Search results