Documentation

Google_Service_Dataflow_WorkItemStatus 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.
$completed  : mixed
$reportIndex  : mixed
$requestedLeaseDuration  : mixed
$totalThrottlerWaitTimeSeconds  : mixed
$workItemId  : mixed
$collection_key  : mixed
$counterUpdatesDataType  : mixed
$counterUpdatesType  : mixed
$dynamicSourceSplitDataType  : mixed
$dynamicSourceSplitType  : mixed
$errorsDataType  : mixed
$errorsType  : mixed
$internal_gapi_mappings  : mixed
$metricUpdatesDataType  : mixed
$metricUpdatesType  : mixed
$modelData  : mixed
$processed  : mixed
$progressDataType  : mixed
$progressType  : mixed
$reportedProgressDataType  : mixed
$reportedProgressType  : mixed
$sourceForkDataType  : mixed
$sourceForkType  : mixed
$sourceOperationResponseDataType  : mixed
$sourceOperationResponseType  : mixed
$stopPositionDataType  : mixed
$stopPositionType  : 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
getCompleted()  : mixed
getCounterUpdates()  : Google_Service_Dataflow_CounterUpdate
getDynamicSourceSplit()  : Google_Service_Dataflow_DynamicSourceSplit
getErrors()  : Google_Service_Dataflow_Status
getMetricUpdates()  : Google_Service_Dataflow_MetricUpdate
getProgress()  : Google_Service_Dataflow_ApproximateProgress
getReportedProgress()  : Google_Service_Dataflow_ApproximateReportedProgress
getReportIndex()  : mixed
getRequestedLeaseDuration()  : mixed
getSourceFork()  : Google_Service_Dataflow_SourceFork
getSourceOperationResponse()  : Google_Service_Dataflow_SourceOperationResponse
getStopPosition()  : Google_Service_Dataflow_Position
getTotalThrottlerWaitTimeSeconds()  : mixed
getWorkItemId()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setCompleted()  : mixed
setCounterUpdates()  : mixed
setDynamicSourceSplit()  : mixed
setErrors()  : mixed
setMetricUpdates()  : mixed
setProgress()  : mixed
setReportedProgress()  : mixed
setReportIndex()  : mixed
setRequestedLeaseDuration()  : mixed
setSourceFork()  : mixed
setSourceOperationResponse()  : mixed
setStopPosition()  : mixed
setTotalThrottlerWaitTimeSeconds()  : mixed
setWorkItemId()  : 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

$totalThrottlerWaitTimeSeconds

public mixed $totalThrottlerWaitTimeSeconds

$collection_key

protected mixed $collection_key = 'metricUpdates'

$counterUpdatesDataType

protected mixed $counterUpdatesDataType = 'array'

$counterUpdatesType

protected mixed $counterUpdatesType = 'Google_Service_Dataflow_CounterUpdate'

$dynamicSourceSplitDataType

protected mixed $dynamicSourceSplitDataType = ''

$dynamicSourceSplitType

protected mixed $dynamicSourceSplitType = 'Google_Service_Dataflow_DynamicSourceSplit'

$errorsType

protected mixed $errorsType = 'Google_Service_Dataflow_Status'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$metricUpdatesDataType

protected mixed $metricUpdatesDataType = 'array'

$metricUpdatesType

protected mixed $metricUpdatesType = 'Google_Service_Dataflow_MetricUpdate'

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

$progressType

protected mixed $progressType = 'Google_Service_Dataflow_ApproximateProgress'

$reportedProgressDataType

protected mixed $reportedProgressDataType = ''

$reportedProgressType

protected mixed $reportedProgressType = 'Google_Service_Dataflow_ApproximateReportedProgress'

$sourceForkType

protected mixed $sourceForkType = 'Google_Service_Dataflow_SourceFork'

$sourceOperationResponseDataType

protected mixed $sourceOperationResponseDataType = ''

$sourceOperationResponseType

protected mixed $sourceOperationResponseType = 'Google_Service_Dataflow_SourceOperationResponse'

$stopPositionDataType

protected mixed $stopPositionDataType = ''

$stopPositionType

protected mixed $stopPositionType = 'Google_Service_Dataflow_Position'

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 —

getCompleted()

public getCompleted() : mixed
Return values
mixed —

getReportIndex()

public getReportIndex() : mixed
Return values
mixed —

getRequestedLeaseDuration()

public getRequestedLeaseDuration() : mixed
Return values
mixed —

getTotalThrottlerWaitTimeSeconds()

public getTotalThrottlerWaitTimeSeconds() : mixed
Return values
mixed —

getWorkItemId()

public getWorkItemId() : 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 —

setCompleted()

public setCompleted(mixed $completed) : mixed
Parameters
$completed : mixed
Return values
mixed —

setCounterUpdates()

public setCounterUpdates(mixed $counterUpdates) : mixed
Parameters
$counterUpdates : mixed
Return values
mixed —

setErrors()

public setErrors(mixed $errors) : mixed
Parameters
$errors : mixed
Return values
mixed —

setMetricUpdates()

public setMetricUpdates(mixed $metricUpdates) : mixed
Parameters
$metricUpdates : mixed
Return values
mixed —

setReportIndex()

public setReportIndex(mixed $reportIndex) : mixed
Parameters
$reportIndex : mixed
Return values
mixed —

setRequestedLeaseDuration()

public setRequestedLeaseDuration(mixed $requestedLeaseDuration) : mixed
Parameters
$requestedLeaseDuration : mixed
Return values
mixed —

setTotalThrottlerWaitTimeSeconds()

public setTotalThrottlerWaitTimeSeconds(mixed $totalThrottlerWaitTimeSeconds) : mixed
Parameters
$totalThrottlerWaitTimeSeconds : mixed
Return values
mixed —

setWorkItemId()

public setWorkItemId(mixed $workItemId) : mixed
Parameters
$workItemId : 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