Google Cloud Container V1 Client - Class Operation (1.31.0)

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

Namespace

Google \ Cloud \ Container \ V1

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 URI for the operation. Example: https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123.
↳ target_link string

Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster ## https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node
↳ 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.

Returns
Type Description
string

setName

The server-assigned ID for the operation.

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.

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getOperationType

The operation type.

Returns
Type Description
int

setOperationType

The operation type.

Parameter
Name Description
var int
Returns
Type Description
$this

getStatus

The current status of the operation.

Returns
Type Description
int

setStatus

The current status of the operation.

Parameter
Name Description
var int
Returns
Type Description
$this

getDetail

Detailed operation progress, if available.

Returns
Type Description
string

setDetail

Detailed operation progress, if available.

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.

Returns
Type Description
string

setStatusMessage

Output only. If an error has occurred, a textual description of the error.

Deprecated. Use the field error instead.

Parameter
Name Description
var string
Returns
Type Description
$this

getSelfLink

Server-defined URI for the operation. Example: https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123.

Returns
Type Description
string

setSelfLink

Server-defined URI for the operation. Example: https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123.

Parameter
Name Description
var string
Returns
Type Description
$this

getTargetLink

Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node).

For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: -

#

https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster

#

https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node

Returns
Type Description
string

setTargetLink

Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node).

For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: -

#

https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster

#

https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node

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.

Returns
Type Description
string

setLocation

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.

Parameter
Name Description
var string
Returns
Type Description
$this

getStartTime

[Output only] The time the operation started, in RFC3339 text format.

Returns
Type Description
string

setStartTime

[Output only] The time the operation started, in RFC3339 text format.

Parameter
Name Description
var string
Returns
Type Description
$this

getEndTime

[Output only] The time the operation completed, in RFC3339 text format.

Returns
Type Description
string

setEndTime

[Output only] The time the operation completed, in RFC3339 text format.

Parameter
Name Description
var string
Returns
Type Description
$this

getProgress

Output only. [Output only] Progress information for an operation.

Returns
Type Description
Google\Cloud\Container\V1\OperationProgress|null

hasProgress

clearProgress

setProgress

Output only. [Output only] Progress information for an operation.

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setClusterConditions

Which conditions caused the current cluster state.

Deprecated. Use field error instead.

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setNodepoolConditions

Which conditions caused the current node pool state.

Deprecated. Use field error instead.

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.

Returns
Type Description
Google\Rpc\Status|null

hasError

clearError

setError

The error result of the operation in case of failure.

Parameter
Name Description
var Google\Rpc\Status
Returns
Type Description
$this