Google Cloud Dataflow V1beta3 Client - Class WorkItemDetails (0.4.1)

Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class WorkItemDetails.

Information about an individual work item execution.

Generated from protobuf message google.dataflow.v1beta3.WorkItemDetails

Namespace

Google \ Cloud \ Dataflow \ V1beta3

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ task_id string

Name of this work item.

↳ attempt_id string

Attempt ID of this work item

↳ start_time Google\Protobuf\Timestamp

Start time of this work item attempt.

↳ end_time Google\Protobuf\Timestamp

End time of this work item attempt. If the work item is completed, this is the actual end time of the work item. Otherwise, it is the predicted end time.

↳ state int

State of this work item.

↳ progress Google\Cloud\Dataflow\V1beta3\ProgressTimeseries

Progress of this work item.

↳ metrics array<Google\Cloud\Dataflow\V1beta3\MetricUpdate>

Metrics for this work item.

getTaskId

Name of this work item.

Returns
TypeDescription
string

setTaskId

Name of this work item.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAttemptId

Attempt ID of this work item

Returns
TypeDescription
string

setAttemptId

Attempt ID of this work item

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStartTime

Start time of this work item attempt.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Start time of this work item attempt.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEndTime

End time of this work item attempt.

If the work item is completed, this is the actual end time of the work item. Otherwise, it is the predicted end time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

End time of this work item attempt.

If the work item is completed, this is the actual end time of the work item. Otherwise, it is the predicted end time.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getState

State of this work item.

Returns
TypeDescription
int

setState

State of this work item.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getProgress

Progress of this work item.

Returns
TypeDescription
Google\Cloud\Dataflow\V1beta3\ProgressTimeseries|null

hasProgress

clearProgress

setProgress

Progress of this work item.

Parameter
NameDescription
var Google\Cloud\Dataflow\V1beta3\ProgressTimeseries
Returns
TypeDescription
$this

getMetrics

Metrics for this work item.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMetrics

Metrics for this work item.

Parameter
NameDescription
var array<Google\Cloud\Dataflow\V1beta3\MetricUpdate>
Returns
TypeDescription
$this