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
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.
Generated from protobuf field string name = 1;
| Returns | |
|---|---|
| Type | Description |
string | |
setName
A non-parameterized string describing an operation stage.
Unset for single-stage operations.
Generated from protobuf field string name = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatus
Status of an operation stage.
Unset for single-stage operations.
Generated from protobuf field .google.container.v1.Operation.Status status = 2;
| Returns | |
|---|---|
| Type | Description |
int | |
setStatus
Status of an operation stage.
Unset for single-stage operations.
Generated from protobuf field .google.container.v1.Operation.Status status = 2;
| 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}]
Generated from protobuf field repeated .google.container.v1.OperationProgress.Metric metrics = 3;
| 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}]
Generated from protobuf field repeated .google.container.v1.OperationProgress.Metric metrics = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Container\V1\OperationProgress\Metric>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStages
Substages of an operation or a stage.
Generated from protobuf field repeated .google.container.v1.OperationProgress stages = 4;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setStages
Substages of an operation or a stage.
Generated from protobuf field repeated .google.container.v1.OperationProgress stages = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Container\V1\OperationProgress>
|
| Returns | |
|---|---|
| Type | Description |
$this | |