Reference documentation and code samples for the Google Cloud Container V1 Client class Metric.
Progress metric is (string, int|float|string) pair.
Generated from protobuf message google.container.v1.OperationProgress.Metric
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Metric name, e.g., "nodes total", "percent done". |
↳ int_value |
int|string
For metrics with integer value. |
↳ double_value |
float
For metrics with floating point value. |
↳ string_value |
string
For metrics with custom values (ratios, visual progress, etc.). |
getName
Required. Metric name, e.g., "nodes total", "percent done".
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. Metric name, e.g., "nodes total", "percent done".
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIntValue
For metrics with integer value.
Generated from protobuf field int64 int_value = 2;
| Returns | |
|---|---|
| Type | Description |
int|string | |
hasIntValue
setIntValue
For metrics with integer value.
Generated from protobuf field int64 int_value = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDoubleValue
For metrics with floating point value.
Generated from protobuf field double double_value = 3;
| Returns | |
|---|---|
| Type | Description |
float | |
hasDoubleValue
setDoubleValue
For metrics with floating point value.
Generated from protobuf field double double_value = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStringValue
For metrics with custom values (ratios, visual progress, etc.).
Generated from protobuf field string string_value = 4;
| Returns | |
|---|---|
| Type | Description |
string | |
hasStringValue
setStringValue
For metrics with custom values (ratios, visual progress, etc.).
Generated from protobuf field string string_value = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getValue
| Returns | |
|---|---|
| Type | Description |
string | |