Documentation

Google_Service_Dataflow_WorkItem 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.
$configuration  : mixed
$id  : mixed
$initialReportIndex  : mixed
$jobId  : mixed
$leaseExpireTime  : mixed
$projectId  : mixed
$reportStatusInterval  : mixed
$collection_key  : mixed
$internal_gapi_mappings  : mixed
$mapTaskDataType  : mixed
$mapTaskType  : mixed
$modelData  : mixed
$packagesDataType  : mixed
$packagesType  : mixed
$processed  : mixed
$seqMapTaskDataType  : mixed
$seqMapTaskType  : mixed
$shellTaskDataType  : mixed
$shellTaskType  : mixed
$sourceOperationTaskDataType  : mixed
$sourceOperationTaskType  : mixed
$streamingComputationTaskDataType  : mixed
$streamingComputationTaskType  : mixed
$streamingConfigTaskDataType  : mixed
$streamingConfigTaskType  : mixed
$streamingSetupTaskDataType  : mixed
$streamingSetupTaskType  : 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
getConfiguration()  : mixed
getId()  : mixed
getInitialReportIndex()  : mixed
getJobId()  : mixed
getLeaseExpireTime()  : mixed
getMapTask()  : Google_Service_Dataflow_MapTask
getPackages()  : Google_Service_Dataflow_Package
getProjectId()  : mixed
getReportStatusInterval()  : mixed
getSeqMapTask()  : Google_Service_Dataflow_SeqMapTask
getShellTask()  : Google_Service_Dataflow_ShellTask
getSourceOperationTask()  : Google_Service_Dataflow_SourceOperationRequest
getStreamingComputationTask()  : Google_Service_Dataflow_StreamingComputationTask
getStreamingConfigTask()  : Google_Service_Dataflow_StreamingConfigTask
getStreamingSetupTask()  : Google_Service_Dataflow_StreamingSetupTask
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setConfiguration()  : mixed
setId()  : mixed
setInitialReportIndex()  : mixed
setJobId()  : mixed
setLeaseExpireTime()  : mixed
setMapTask()  : mixed
setPackages()  : mixed
setProjectId()  : mixed
setReportStatusInterval()  : mixed
setSeqMapTask()  : mixed
setShellTask()  : mixed
setSourceOperationTask()  : mixed
setStreamingComputationTask()  : mixed
setStreamingConfigTask()  : mixed
setStreamingSetupTask()  : 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

$configuration

public mixed $configuration

$initialReportIndex

public mixed $initialReportIndex

$leaseExpireTime

public mixed $leaseExpireTime

$reportStatusInterval

public mixed $reportStatusInterval

$collection_key

protected mixed $collection_key = 'packages'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$mapTaskDataType

protected mixed $mapTaskDataType = ''

$mapTaskType

protected mixed $mapTaskType = 'Google_Service_Dataflow_MapTask'

$modelData

protected mixed $modelData = array()

$packagesDataType

protected mixed $packagesDataType = 'array'

$packagesType

protected mixed $packagesType = 'Google_Service_Dataflow_Package'

$processed

protected mixed $processed = array()

$seqMapTaskDataType

protected mixed $seqMapTaskDataType = ''

$seqMapTaskType

protected mixed $seqMapTaskType = 'Google_Service_Dataflow_SeqMapTask'

$shellTaskDataType

protected mixed $shellTaskDataType = ''

$shellTaskType

protected mixed $shellTaskType = 'Google_Service_Dataflow_ShellTask'

$sourceOperationTaskDataType

protected mixed $sourceOperationTaskDataType = ''

$sourceOperationTaskType

protected mixed $sourceOperationTaskType = 'Google_Service_Dataflow_SourceOperationRequest'

$streamingComputationTaskDataType

protected mixed $streamingComputationTaskDataType = ''

$streamingComputationTaskType

protected mixed $streamingComputationTaskType = 'Google_Service_Dataflow_StreamingComputationTask'

$streamingConfigTaskDataType

protected mixed $streamingConfigTaskDataType = ''

$streamingConfigTaskType

protected mixed $streamingConfigTaskType = 'Google_Service_Dataflow_StreamingConfigTask'

$streamingSetupTaskDataType

protected mixed $streamingSetupTaskDataType = ''

$streamingSetupTaskType

protected mixed $streamingSetupTaskType = 'Google_Service_Dataflow_StreamingSetupTask'

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 —

getConfiguration()

public getConfiguration() : mixed
Return values
mixed —

getId()

public getId() : mixed
Return values
mixed —

getInitialReportIndex()

public getInitialReportIndex() : mixed
Return values
mixed —

getJobId()

public getJobId() : mixed
Return values
mixed —

getLeaseExpireTime()

public getLeaseExpireTime() : mixed
Return values
mixed —

getProjectId()

public getProjectId() : mixed
Return values
mixed —

getReportStatusInterval()

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

setConfiguration()

public setConfiguration(mixed $configuration) : mixed
Parameters
$configuration : mixed
Return values
mixed —

setId()

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

setInitialReportIndex()

public setInitialReportIndex(mixed $initialReportIndex) : mixed
Parameters
$initialReportIndex : mixed
Return values
mixed —

setJobId()

public setJobId(mixed $jobId) : mixed
Parameters
$jobId : mixed
Return values
mixed —

setLeaseExpireTime()

public setLeaseExpireTime(mixed $leaseExpireTime) : mixed
Parameters
$leaseExpireTime : mixed
Return values
mixed —

setPackages()

public setPackages(mixed $packages) : mixed
Parameters
$packages : mixed
Return values
mixed —

setProjectId()

public setProjectId(mixed $projectId) : mixed
Parameters
$projectId : mixed
Return values
mixed —

setReportStatusInterval()

public setReportStatusInterval(mixed $reportStatusInterval) : mixed
Parameters
$reportStatusInterval : 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