Operation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents an Operation resource. Google Compute Engine has three
Operation resources: *
Global </compute/docs/reference/rest/v1/globalOperations>
*
Regional </compute/docs/reference/rest/v1/regionOperations>
*
Zonal </compute/docs/reference/rest/v1/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
zoneOperations
resource. For more information, read Global,
Regional, and Zonal Resources. Note that completed Operation
resources have a limited retention period.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes | |
---|---|
Name | Description |
client_operation_id |
str
[Output Only] The value of requestId if you provided it
in the request. Not present otherwise.
This field is a member of oneof _ _client_operation_id .
|
creation_timestamp |
str
[Deprecated] This field is deprecated. This field is a member of oneof _ _creation_timestamp .
|
description |
str
[Output Only] A textual description of the operation, which is set when the operation is created. This field is a member of oneof _ _description .
|
end_time |
str
[Output Only] The time that this operation was completed. This value is in RFC3339 text format. This field is a member of oneof _ _end_time .
|
error |
google.cloud.compute_v1.types.Error
[Output Only] If errors are generated during processing of the operation, this field will be populated. This field is a member of oneof _ _error .
|
http_error_message |
str
[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND .
This field is a member of oneof _ _http_error_message .
|
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.
This field is a member of oneof _ _http_error_status_code .
|
id |
int
[Output Only] The unique identifier for the operation. This identifier is defined by the server. This field is a member of oneof _ _id .
|
insert_time |
str
[Output Only] The time that this operation was requested. This value is in RFC3339 text format. This field is a member of oneof _ _insert_time .
|
instances_bulk_insert_operation_metadata |
google.cloud.compute_v1.types.InstancesBulkInsertOperationMetadata
This field is a member of oneof _ _instances_bulk_insert_operation_metadata .
|
kind |
str
[Output Only] Type of the resource. Always compute#operation for Operation resources.
This field is a member of oneof _ _kind .
|
name |
str
[Output Only] Name of the operation. This field is a member of oneof _ _name .
|
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.
This field is a member of oneof _ _operation_group_id .
|
operation_type |
str
[Output Only] The type of operation, such as insert ,
update , or delete , and so on.
This field is a member of oneof _ _operation_type .
|
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. This field is a member of oneof _ _progress .
|
region |
str
[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. This field is a member of oneof _ _region .
|
self_link |
str
[Output Only] Server-defined URL for the resource. This field is a member of oneof _ _self_link .
|
set_common_instance_metadata_operation_metadata |
google.cloud.compute_v1.types.SetCommonInstanceMetadataOperationMetadata
[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state. This field is a member of oneof _ _set_common_instance_metadata_operation_metadata .
|
start_time |
str
[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. This field is a member of oneof _ _start_time .
|
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 .
This field is a member of oneof _ _status .
|
status_message |
str
[Output Only] An optional textual description of the current status of the operation. This field is a member of oneof _ _status_message .
|
target_id |
int
[Output Only] The unique target ID, which identifies a specific incarnation of the target resource. This field is a member of oneof _ _target_id .
|
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. This field is a member of oneof _ _target_link .
|
user |
str
[Output Only] User who requested the operation, for example: user@example.com or
alice_smith_identifier (global/workforcePools/example-com-us-employees) .
This field is a member of oneof _ _user .
|
warnings |
MutableSequence[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. This field is a member of oneof _ _zone .
|
Classes
Status
Status(value)
[Output Only] The status of the operation, which can be one of the
following: PENDING
, RUNNING
, or DONE
.
Values: UNDEFINED_STATUS (0): A value indicating that the enum field is not set. DONE (2104194): No description available. PENDING (35394935): No description available. RUNNING (121282975): No description available.