Documentation

Google_Service_Dataflow_Job 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.
$clientRequestId  : mixed
$createdFromSnapshotId  : mixed
$createTime  : mixed
$currentState  : mixed
$currentStateTime  : mixed
$id  : mixed
$labels  : mixed
$location  : mixed
$name  : mixed
$projectId  : mixed
$replacedByJobId  : mixed
$replaceJobId  : mixed
$requestedState  : mixed
$startTime  : mixed
$stepsLocation  : mixed
$tempFiles  : mixed
$transformNameMapping  : mixed
$type  : mixed
$collection_key  : mixed
$environmentDataType  : mixed
$environmentType  : mixed
$executionInfoDataType  : mixed
$executionInfoType  : mixed
$internal_gapi_mappings  : mixed
$jobMetadataDataType  : mixed
$jobMetadataType  : mixed
$modelData  : mixed
$pipelineDescriptionDataType  : mixed
$pipelineDescriptionType  : mixed
$processed  : mixed
$stageStatesDataType  : mixed
$stageStatesType  : 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
getClientRequestId()  : mixed
getCreatedFromSnapshotId()  : mixed
getCreateTime()  : mixed
getCurrentState()  : mixed
getCurrentStateTime()  : mixed
getEnvironment()  : Google_Service_Dataflow_Environment
getExecutionInfo()  : Google_Service_Dataflow_JobExecutionInfo
getId()  : mixed
getJobMetadata()  : Google_Service_Dataflow_JobMetadata
getLabels()  : mixed
getLocation()  : mixed
getName()  : mixed
getPipelineDescription()  : Google_Service_Dataflow_PipelineDescription
getProjectId()  : mixed
getReplacedByJobId()  : mixed
getReplaceJobId()  : mixed
getRequestedState()  : mixed
getStageStates()  : Google_Service_Dataflow_ExecutionStageState
getStartTime()  : mixed
getSteps()  : Google_Service_Dataflow_Step
getStepsLocation()  : mixed
getTempFiles()  : mixed
getTransformNameMapping()  : mixed
getType()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setClientRequestId()  : mixed
setCreatedFromSnapshotId()  : mixed
setCreateTime()  : mixed
setCurrentState()  : mixed
setCurrentStateTime()  : mixed
setEnvironment()  : mixed
setExecutionInfo()  : mixed
setId()  : mixed
setJobMetadata()  : mixed
setLabels()  : mixed
setLocation()  : mixed
setName()  : mixed
setPipelineDescription()  : mixed
setProjectId()  : mixed
setReplacedByJobId()  : mixed
setReplaceJobId()  : mixed
setRequestedState()  : mixed
setStageStates()  : mixed
setStartTime()  : mixed
setSteps()  : mixed
setStepsLocation()  : mixed
setTempFiles()  : mixed
setTransformNameMapping()  : mixed
setType()  : 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

$clientRequestId

public mixed $clientRequestId

$createdFromSnapshotId

public mixed $createdFromSnapshotId

$createTime

public mixed $createTime

$currentState

public mixed $currentState

$currentStateTime

public mixed $currentStateTime

$id

public mixed $id

$labels

public mixed $labels

$location

public mixed $location

$name

public mixed $name

$projectId

public mixed $projectId

$replacedByJobId

public mixed $replacedByJobId

$replaceJobId

public mixed $replaceJobId

$requestedState

public mixed $requestedState

$startTime

public mixed $startTime

$stepsLocation

public mixed $stepsLocation

$tempFiles

public mixed $tempFiles

$transformNameMapping

public mixed $transformNameMapping

$type

public mixed $type

$collection_key

protected mixed $collection_key = 'tempFiles'

$environmentDataType

protected mixed $environmentDataType = ''

$environmentType

protected mixed $environmentType = 'Google_Service_Dataflow_Environment'

$executionInfoDataType

protected mixed $executionInfoDataType = ''

$executionInfoType

protected mixed $executionInfoType = 'Google_Service_Dataflow_JobExecutionInfo'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$jobMetadataDataType

protected mixed $jobMetadataDataType = ''

$jobMetadataType

protected mixed $jobMetadataType = 'Google_Service_Dataflow_JobMetadata'

$modelData

protected mixed $modelData = array()

$pipelineDescriptionDataType

protected mixed $pipelineDescriptionDataType = ''

$pipelineDescriptionType

protected mixed $pipelineDescriptionType = 'Google_Service_Dataflow_PipelineDescription'

$processed

protected mixed $processed = array()

$stageStatesDataType

protected mixed $stageStatesDataType = 'array'

$stageStatesType

protected mixed $stageStatesType = 'Google_Service_Dataflow_ExecutionStageState'

$stepsDataType

protected mixed $stepsDataType = 'array'

$stepsType

protected mixed $stepsType = 'Google_Service_Dataflow_Step'

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

getClientRequestId()

public getClientRequestId() : mixed
Return values
mixed

getCreatedFromSnapshotId()

public getCreatedFromSnapshotId() : mixed
Return values
mixed

getCreateTime()

public getCreateTime() : mixed
Return values
mixed

getCurrentState()

public getCurrentState() : mixed
Return values
mixed

getCurrentStateTime()

public getCurrentStateTime() : mixed
Return values
mixed

getId()

public getId() : mixed
Return values
mixed

getLabels()

public getLabels() : mixed
Return values
mixed

getLocation()

public getLocation() : mixed
Return values
mixed

getName()

public getName() : mixed
Return values
mixed

getProjectId()

public getProjectId() : mixed
Return values
mixed

getReplacedByJobId()

public getReplacedByJobId() : mixed
Return values
mixed

getReplaceJobId()

public getReplaceJobId() : mixed
Return values
mixed

getRequestedState()

public getRequestedState() : mixed
Return values
mixed

getStartTime()

public getStartTime() : mixed
Return values
mixed

getStepsLocation()

public getStepsLocation() : mixed
Return values
mixed

getTempFiles()

public getTempFiles() : mixed
Return values
mixed

getTransformNameMapping()

public getTransformNameMapping() : mixed
Return values
mixed

getType()

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

setClientRequestId()

public setClientRequestId(mixed $clientRequestId) : mixed
Parameters
$clientRequestId : mixed
Return values
mixed

setCreatedFromSnapshotId()

public setCreatedFromSnapshotId(mixed $createdFromSnapshotId) : mixed
Parameters
$createdFromSnapshotId : mixed
Return values
mixed

setCreateTime()

public setCreateTime(mixed $createTime) : mixed
Parameters
$createTime : mixed
Return values
mixed

setCurrentState()

public setCurrentState(mixed $currentState) : mixed
Parameters
$currentState : mixed
Return values
mixed

setCurrentStateTime()

public setCurrentStateTime(mixed $currentStateTime) : mixed
Parameters
$currentStateTime : mixed
Return values
mixed

setId()

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

setLabels()

public setLabels(mixed $labels) : mixed
Parameters
$labels : mixed
Return values
mixed

setLocation()

public setLocation(mixed $location) : mixed
Parameters
$location : mixed
Return values
mixed

setName()

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

setProjectId()

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

setReplacedByJobId()

public setReplacedByJobId(mixed $replacedByJobId) : mixed
Parameters
$replacedByJobId : mixed
Return values
mixed

setReplaceJobId()

public setReplaceJobId(mixed $replaceJobId) : mixed
Parameters
$replaceJobId : mixed
Return values
mixed

setRequestedState()

public setRequestedState(mixed $requestedState) : mixed
Parameters
$requestedState : mixed
Return values
mixed

setStageStates()

public setStageStates(mixed $stageStates) : mixed
Parameters
$stageStates : mixed
Return values
mixed

setStartTime()

public setStartTime(mixed $startTime) : mixed
Parameters
$startTime : mixed
Return values
mixed

setSteps()

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

setStepsLocation()

public setStepsLocation(mixed $stepsLocation) : mixed
Parameters
$stepsLocation : mixed
Return values
mixed

setTempFiles()

public setTempFiles(mixed $tempFiles) : mixed
Parameters
$tempFiles : mixed
Return values
mixed

setTransformNameMapping()

public setTransformNameMapping(mixed $transformNameMapping) : mixed
Parameters
$transformNameMapping : mixed
Return values
mixed

setType()

public setType(mixed $type) : mixed
Parameters
$type : 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