Reference documentation and code samples for the Google Cloud Container V1 Client class Operation.
This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Generated from protobuf message google.container.v1.Operation
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The server-assigned ID for the operation. |
↳ zone |
string
The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead. |
↳ operation_type |
int
The operation type. |
↳ status |
int
The current status of the operation. |
↳ detail |
string
Detailed operation progress, if available. |
↳ status_message |
string
Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. |
↳ self_link |
string
Server-defined URL for the resource. |
↳ target_link |
string
Server-defined URL for the target of the operation. |
↳ location |
string
[Output only] The name of the Google Compute Engine zone or region in which the cluster resides. |
↳ start_time |
string
[Output only] The time the operation started, in RFC3339 text format. |
↳ end_time |
string
[Output only] The time the operation completed, in RFC3339 text format. |
↳ progress |
Google\Cloud\Container\V1\OperationProgress
Output only. [Output only] Progress information for an operation. |
↳ cluster_conditions |
array<Google\Cloud\Container\V1\StatusCondition>
Which conditions caused the current cluster state. Deprecated. Use field error instead. |
↳ nodepool_conditions |
array<Google\Cloud\Container\V1\StatusCondition>
Which conditions caused the current node pool state. Deprecated. Use field error instead. |
↳ error |
Google\Rpc\Status
The error result of the operation in case of failure. |
getName
The server-assigned ID for the operation.
Generated from protobuf field string name = 1;
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The server-assigned ID for the operation.
Generated from protobuf field string name = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getZone
The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.
Generated from protobuf field string zone = 2 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
string | |
setZone
The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.
Generated from protobuf field string zone = 2 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOperationType
The operation type.
Generated from protobuf field .google.container.v1.Operation.Type operation_type = 3;
| Returns | |
|---|---|
| Type | Description |
int | |
setOperationType
The operation type.
Generated from protobuf field .google.container.v1.Operation.Type operation_type = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatus
The current status of the operation.
Generated from protobuf field .google.container.v1.Operation.Status status = 4;
| Returns | |
|---|---|
| Type | Description |
int | |
setStatus
The current status of the operation.
Generated from protobuf field .google.container.v1.Operation.Status status = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDetail
Detailed operation progress, if available.
Generated from protobuf field string detail = 8;
| Returns | |
|---|---|
| Type | Description |
string | |
setDetail
Detailed operation progress, if available.
Generated from protobuf field string detail = 8;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatusMessage
Output only. If an error has occurred, a textual description of the error.
Deprecated. Use the field error instead.
Generated from protobuf field string status_message = 5 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setStatusMessage
Output only. If an error has occurred, a textual description of the error.
Deprecated. Use the field error instead.
Generated from protobuf field string status_message = 5 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSelfLink
Server-defined URL for the resource.
Generated from protobuf field string self_link = 6;
| Returns | |
|---|---|
| Type | Description |
string | |
setSelfLink
Server-defined URL for the resource.
Generated from protobuf field string self_link = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTargetLink
Server-defined URL for the target of the operation.
Generated from protobuf field string target_link = 7;
| Returns | |
|---|---|
| Type | Description |
string | |
setTargetLink
Server-defined URL for the target of the operation.
Generated from protobuf field string target_link = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLocation
[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.
Generated from protobuf field string location = 9;
| Returns | |
|---|---|
| Type | Description |
string | |
setLocation
[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.
Generated from protobuf field string location = 9;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStartTime
[Output only] The time the operation started, in RFC3339 text format.
Generated from protobuf field string start_time = 10;
| Returns | |
|---|---|
| Type | Description |
string | |
setStartTime
[Output only] The time the operation started, in RFC3339 text format.
Generated from protobuf field string start_time = 10;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndTime
[Output only] The time the operation completed, in RFC3339 text format.
Generated from protobuf field string end_time = 11;
| Returns | |
|---|---|
| Type | Description |
string | |
setEndTime
[Output only] The time the operation completed, in RFC3339 text format.
Generated from protobuf field string end_time = 11;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProgress
Output only. [Output only] Progress information for an operation.
Generated from protobuf field .google.container.v1.OperationProgress progress = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Container\V1\OperationProgress|null | |
hasProgress
clearProgress
setProgress
Output only. [Output only] Progress information for an operation.
Generated from protobuf field .google.container.v1.OperationProgress progress = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Container\V1\OperationProgress
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getClusterConditions
Which conditions caused the current cluster state.
Deprecated. Use field error instead.
Generated from protobuf field repeated .google.container.v1.StatusCondition cluster_conditions = 13 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setClusterConditions
Which conditions caused the current cluster state.
Deprecated. Use field error instead.
Generated from protobuf field repeated .google.container.v1.StatusCondition cluster_conditions = 13 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Container\V1\StatusCondition>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNodepoolConditions
Which conditions caused the current node pool state.
Deprecated. Use field error instead.
Generated from protobuf field repeated .google.container.v1.StatusCondition nodepool_conditions = 14 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setNodepoolConditions
Which conditions caused the current node pool state.
Deprecated. Use field error instead.
Generated from protobuf field repeated .google.container.v1.StatusCondition nodepool_conditions = 14 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Container\V1\StatusCondition>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getError
The error result of the operation in case of failure.
Generated from protobuf field .google.rpc.Status error = 15;
| Returns | |
|---|---|
| Type | Description |
Google\Rpc\Status|null | |
hasError
clearError
setError
The error result of the operation in case of failure.
Generated from protobuf field .google.rpc.Status error = 15;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Rpc\Status
|
| Returns | |
|---|---|
| Type | Description |
$this | |