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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
string | |
setTaskId
Name of this work item.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAttemptId
Attempt ID of this work item
| Returns | |
|---|---|
| Type | Description |
string | |
setAttemptId
Attempt ID of this work item
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStartTime
Start time of this work item attempt.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasStartTime
clearStartTime
setStartTime
Start time of this work item attempt.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
State of this work item.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
State of this work item.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProgress
Progress of this work item.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataflow\V1beta3\ProgressTimeseries|null | |
hasProgress
clearProgress
setProgress
Progress of this work item.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataflow\V1beta3\ProgressTimeseries
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMetrics
Metrics for this work item.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setMetrics
Metrics for this work item.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dataflow\V1beta3\MetricUpdate>
|
| Returns | |
|---|---|
| Type | Description |
$this | |