Google Cloud Container V1 Client - Class OperationProgress (1.16.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
NameDescription
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
TypeDescription
string

setName

A non-parameterized string describing an operation stage.

Unset for single-stage operations.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStatus

Status of an operation stage.

Unset for single-stage operations.

Returns
TypeDescription
int

setStatus

Status of an operation stage.

Unset for single-stage operations.

Parameter
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array<Google\Cloud\Container\V1\OperationProgress\Metric>
Returns
TypeDescription
$this

getStages

Substages of an operation or a stage.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setStages

Substages of an operation or a stage.

Parameter
NameDescription
var array<Google\Cloud\Container\V1\OperationProgress>
Returns
TypeDescription
$this