Google Cloud Container V1 Client - Class OperationProgress (1.31.0)

Reference documentation and code samples for the Google Cloud Container V1 Client class OperationProgress.

Information about operation (or operation stage) progress.

Generated from protobuf message google.container.v1.OperationProgress

Namespace

Google \ Cloud \ Container \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

A non-parameterized string describing an operation stage. Unset for single-stage operations.

↳ status int

Status of an operation stage. Unset for single-stage operations.

↳ metrics array<Google\Cloud\Container\V1\OperationProgress\Metric>

Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

↳ stages array<Google\Cloud\Container\V1\OperationProgress>

Substages of an operation or a stage.

getName

A non-parameterized string describing an operation stage.

Unset for single-stage operations.

Returns
Type Description
string

setName

A non-parameterized string describing an operation stage.

Unset for single-stage operations.

Parameter
Name Description
var string
Returns
Type Description
$this

getStatus

Status of an operation stage.

Unset for single-stage operations.

Returns
Type Description
int

setStatus

Status of an operation stage.

Unset for single-stage operations.

Parameter
Name Description
var int
Returns
Type Description
$this

getMetrics

Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setMetrics

Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

Parameter
Name Description
var array<Google\Cloud\Container\V1\OperationProgress\Metric>
Returns
Type Description
$this

getStages

Substages of an operation or a stage.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setStages

Substages of an operation or a stage.

Parameter
Name Description
var array<Google\Cloud\Container\V1\OperationProgress>
Returns
Type Description
$this