Compute V1 Client - Class Operation (1.5.0)

Reference documentation and code samples for the Compute V1 Client class Operation.

Represents an Operation resource. Google Compute Engine has three Operation resources: * Global * Regional * Zonal You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources.

Generated from protobuf message google.cloud.compute.v1.Operation

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ client_operation_id string

[Output Only] The value of requestId if you provided it in the request. Not present otherwise.

↳ creation_timestamp string

[Deprecated] This field is deprecated.

↳ description string

[Output Only] A textual description of the operation, which is set when the operation is created.

↳ end_time string

[Output Only] The time that this operation was completed. This value is in RFC3339 text format.

↳ error Google\Cloud\Compute\V1\Error

[Output Only] If errors are generated during processing of the operation, this field will be populated.

↳ http_error_message string

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

↳ http_error_status_code int

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.

↳ id int|string

[Output Only] The unique identifier for the operation. This identifier is defined by the server.

↳ insert_time string

[Output Only] The time that this operation was requested. This value is in RFC3339 text format.

↳ kind string

[Output Only] Type of the resource. Always compute#operation for Operation resources.

↳ name string

[Output Only] Name of the operation.

↳ operation_group_id string

[Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.

↳ operation_type string

[Output Only] The type of operation, such as insert, update, or delete, and so on.

↳ progress int

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

↳ region string

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

↳ self_link string

[Output Only] Server-defined URL for the resource.

↳ start_time string

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

↳ status int

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

↳ status_message string

[Output Only] An optional textual description of the current status of the operation.

↳ target_id int|string

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

↳ target_link string

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

↳ user string

[Output Only] User who requested the operation, for example: user@example.com.

↳ warnings array<Google\Cloud\Compute\V1\Warnings>

[Output Only] If warning messages are generated during processing of the operation, this field will be populated.

↳ zone string

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

getClientOperationId

[Output Only] The value of requestId if you provided it in the request. Not present otherwise.

Generated from protobuf field optional string client_operation_id = 297240295;

Returns
TypeDescription
string

hasClientOperationId

clearClientOperationId

setClientOperationId

[Output Only] The value of requestId if you provided it in the request. Not present otherwise.

Generated from protobuf field optional string client_operation_id = 297240295;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreationTimestamp

[Deprecated] This field is deprecated.

Generated from protobuf field optional string creation_timestamp = 30525366;

Returns
TypeDescription
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Deprecated] This field is deprecated.

Generated from protobuf field optional string creation_timestamp = 30525366;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

[Output Only] A textual description of the operation, which is set when the operation is created.

Generated from protobuf field optional string description = 422937596;

Returns
TypeDescription
string

hasDescription

clearDescription

setDescription

[Output Only] A textual description of the operation, which is set when the operation is created.

Generated from protobuf field optional string description = 422937596;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEndTime

[Output Only] The time that this operation was completed. This value is in RFC3339 text format.

Generated from protobuf field optional string end_time = 114938801;

Returns
TypeDescription
string

hasEndTime

clearEndTime

setEndTime

[Output Only] The time that this operation was completed. This value is in RFC3339 text format.

Generated from protobuf field optional string end_time = 114938801;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getError

[Output Only] If errors are generated during processing of the operation, this field will be populated.

Generated from protobuf field optional .google.cloud.compute.v1.Error error = 96784904;

Returns
TypeDescription
Google\Cloud\Compute\V1\Error|null

hasError

clearError

setError

[Output Only] If errors are generated during processing of the operation, this field will be populated.

Generated from protobuf field optional .google.cloud.compute.v1.Error error = 96784904;

Parameter
NameDescription
var Google\Cloud\Compute\V1\Error
Returns
TypeDescription
$this

getHttpErrorMessage

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

Generated from protobuf field optional string http_error_message = 202521945 [(.google.cloud.operation_field) = ERROR_MESSAGE];

Returns
TypeDescription
string

hasHttpErrorMessage

clearHttpErrorMessage

setHttpErrorMessage

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

Generated from protobuf field optional string http_error_message = 202521945 [(.google.cloud.operation_field) = ERROR_MESSAGE];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getHttpErrorStatusCode

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.

Generated from protobuf field optional int32 http_error_status_code = 312345196 [(.google.cloud.operation_field) = ERROR_CODE];

Returns
TypeDescription
int

hasHttpErrorStatusCode

clearHttpErrorStatusCode

setHttpErrorStatusCode

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.

Generated from protobuf field optional int32 http_error_status_code = 312345196 [(.google.cloud.operation_field) = ERROR_CODE];

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getId

[Output Only] The unique identifier for the operation. This identifier is defined by the server.

Generated from protobuf field optional uint64 id = 3355;

Returns
TypeDescription
int|string

hasId

clearId

setId

[Output Only] The unique identifier for the operation. This identifier is defined by the server.

Generated from protobuf field optional uint64 id = 3355;

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getInsertTime

[Output Only] The time that this operation was requested. This value is in RFC3339 text format.

Generated from protobuf field optional string insert_time = 433722515;

Returns
TypeDescription
string

hasInsertTime

clearInsertTime

setInsertTime

[Output Only] The time that this operation was requested. This value is in RFC3339 text format.

Generated from protobuf field optional string insert_time = 433722515;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getKind

[Output Only] Type of the resource. Always compute#operation for Operation resources.

Generated from protobuf field optional string kind = 3292052;

Returns
TypeDescription
string

hasKind

clearKind

setKind

[Output Only] Type of the resource. Always compute#operation for Operation resources.

Generated from protobuf field optional string kind = 3292052;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getName

[Output Only] Name of the operation.

Generated from protobuf field optional string name = 3373707 [(.google.cloud.operation_field) = NAME];

Returns
TypeDescription
string

hasName

clearName

setName

[Output Only] Name of the operation.

Generated from protobuf field optional string name = 3373707 [(.google.cloud.operation_field) = NAME];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOperationGroupId

[Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.

Generated from protobuf field optional string operation_group_id = 40171187;

Returns
TypeDescription
string

hasOperationGroupId

clearOperationGroupId

setOperationGroupId

[Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.

Generated from protobuf field optional string operation_group_id = 40171187;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOperationType

[Output Only] The type of operation, such as insert, update, or delete, and so on.

Generated from protobuf field optional string operation_type = 177650450;

Returns
TypeDescription
string

hasOperationType

clearOperationType

setOperationType

[Output Only] The type of operation, such as insert, update, or delete, and so on.

Generated from protobuf field optional string operation_type = 177650450;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getProgress

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

Generated from protobuf field optional int32 progress = 72663597;

Returns
TypeDescription
int

hasProgress

clearProgress

setProgress

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

Generated from protobuf field optional int32 progress = 72663597;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getRegion

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

Generated from protobuf field optional string region = 138946292;

Returns
TypeDescription
string

hasRegion

clearRegion

setRegion

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

Generated from protobuf field optional string region = 138946292;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSelfLink

[Output Only] Server-defined URL for the resource.

Generated from protobuf field optional string self_link = 456214797;

Returns
TypeDescription
string

hasSelfLink

clearSelfLink

setSelfLink

[Output Only] Server-defined URL for the resource.

Generated from protobuf field optional string self_link = 456214797;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStartTime

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

Generated from protobuf field optional string start_time = 37467274;

Returns
TypeDescription
string

hasStartTime

clearStartTime

setStartTime

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

Generated from protobuf field optional string start_time = 37467274;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStatus

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

Generated from protobuf field optional .google.cloud.compute.v1.Operation.Status status = 181260274 [(.google.cloud.operation_field) = STATUS];

Returns
TypeDescription
int

hasStatus

clearStatus

setStatus

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

Generated from protobuf field optional .google.cloud.compute.v1.Operation.Status status = 181260274 [(.google.cloud.operation_field) = STATUS];

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getStatusMessage

[Output Only] An optional textual description of the current status of the operation.

Generated from protobuf field optional string status_message = 297428154;

Returns
TypeDescription
string

hasStatusMessage

clearStatusMessage

setStatusMessage

[Output Only] An optional textual description of the current status of the operation.

Generated from protobuf field optional string status_message = 297428154;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTargetId

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

Generated from protobuf field optional uint64 target_id = 258165385;

Returns
TypeDescription
int|string

hasTargetId

clearTargetId

setTargetId

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

Generated from protobuf field optional uint64 target_id = 258165385;

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getTargetLink

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

Generated from protobuf field optional string target_link = 62671336;

Returns
TypeDescription
string

hasTargetLink

clearTargetLink

setTargetLink

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

Generated from protobuf field optional string target_link = 62671336;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUser

[Output Only] User who requested the operation, for example: user&#64;example.com.

Generated from protobuf field optional string user = 3599307;

Returns
TypeDescription
string

hasUser

clearUser

setUser

[Output Only] User who requested the operation, for example: user&#64;example.com.

Generated from protobuf field optional string user = 3599307;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getWarnings

[Output Only] If warning messages are generated during processing of the operation, this field will be populated.

Generated from protobuf field repeated .google.cloud.compute.v1.Warnings warnings = 498091095;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setWarnings

[Output Only] If warning messages are generated during processing of the operation, this field will be populated.

Generated from protobuf field repeated .google.cloud.compute.v1.Warnings warnings = 498091095;

Parameter
NameDescription
var array<Google\Cloud\Compute\V1\Warnings>
Returns
TypeDescription
$this

getZone

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Generated from protobuf field optional string zone = 3744684;

Returns
TypeDescription
string

hasZone

clearZone

setZone

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Generated from protobuf field optional string zone = 3744684;

Parameter
NameDescription
var string
Returns
TypeDescription
$this