Google Cloud Dataflow V1beta3 Client - Class StageSummary (0.5.1)

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

Information about a particular execution stage of a job.

Generated from protobuf message google.dataflow.v1beta3.StageSummary

Namespace

Google \ Cloud \ Dataflow \ V1beta3

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ stage_id string

ID of this stage

↳ state int

State of this stage.

↳ start_time Google\Protobuf\Timestamp

Start time of this stage.

↳ end_time Google\Protobuf\Timestamp

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

↳ progress Google\Cloud\Dataflow\V1beta3\ProgressTimeseries

Progress for this stage. Only applicable to Batch jobs.

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

Metrics for this stage.

getStageId

ID of this stage

Returns
TypeDescription
string

setStageId

ID of this stage

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

State of this stage.

Returns
TypeDescription
int

setState

State of this stage.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getStartTime

Start time of this stage.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Start time of this stage.

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

getEndTime

End time of this stage.

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

End time of this stage.

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

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

getProgress

Progress for this stage.

Only applicable to Batch jobs.

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

hasProgress

clearProgress

setProgress

Progress for this stage.

Only applicable to Batch jobs.

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

getMetrics

Metrics for this stage.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMetrics

Metrics for this stage.

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