Class Operation (0.5.0)

Operation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents an Operation resource.

Google Compute Engine has three Operation resources:

  • Global </compute/docs/reference/rest/{$api_version}/globalOperations> * Regional </compute/docs/reference/rest/{$api_version}/regionOperations> * Zonal </compute/docs/reference/rest/{$api_version}/zoneOperations>__

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. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Attributes

NameDescription
client_operation_id str
[Output Only] The value of requestId if you provided it in the request. Not present otherwise.
creation_timestamp str
[Deprecated] This field is deprecated.
description str
[Output Only] A textual description of the operation, which is set when the operation is created.
end_time str
[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
error google.cloud.compute_v1.types.Error
[Output Only] If errors are generated during processing of the operation, this field will be populated.
http_error_message str
[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
[Output Only] The unique identifier for the operation. This identifier is defined by the server.
insert_time str
[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
kind str
[Output Only] Type of the resource. Always compute#operation for Operation resources.
name str
[Output Only] Name of the operation.
operation_group_id str
[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 str
[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 str
[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
self_link str
[Output Only] Server-defined URL for the resource.
start_time str
[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
status google.cloud.compute_v1.types.Operation.Status
[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
status_message str
[Output Only] An optional textual description of the current status of the operation.
target_id int
[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
target_link str
[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 str
[Output Only] User who requested the operation, for example: user@example.com.
warnings Sequence[google.cloud.compute_v1.types.Warnings]
[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
zone str
[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Classes

Status

Status(value)

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