Operation class

Represents an Operation resource.

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 v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

Constructors

Operation()
Operation.fromJson(Map _json)

Properties

clientOperationId ↔ String
Output Only The value of requestId if you provided it in the request. Not present otherwise.
read / write
creationTimestamp ↔ String
Deprecated This field is deprecated.
read / write
description ↔ String
Output Only A textual description of the operation, which is set when the operation is created.
read / write
endTime ↔ String
Output Only The time that this operation was completed. This value is in RFC3339 text format.
read / write
error OperationError
Output Only If errors are generated during processing of the operation, this field will be populated.
read / write
httpErrorMessage ↔ String
Output Only If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
read / write
httpErrorStatusCode ↔ 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.
read / write
id ↔ String
Output Only The unique identifier for the resource. This identifier is defined by the server.
read / write
insertTime ↔ String
Output Only The time that this operation was requested. This value is in RFC3339 text format.
read / write
kind ↔ String
Output Only Type of the resource. Always compute#operation for Operation resources.
read / write
name ↔ String
Output Only Name of the resource.
read / write
operationType ↔ String
Output Only The type of operation, such as insert, update, or delete, and so on.
read / write
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.
read / write
region ↔ String
Output Only The URL of the region where the operation resides. Only applicable when performing regional operations.
read / write
Output Only Server-defined URL for the resource.
read / write
startTime ↔ String
Output Only The time that this operation was started by the server. This value is in RFC3339 text format.
read / write
status ↔ String
Output Only The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. Possible string values are: [...]
read / write
statusMessage ↔ String
Output Only An optional textual description of the current status of the operation.
read / write
targetId ↔ String
Output Only The unique target ID, which identifies a specific incarnation of the target resource.
read / write
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.
read / write
user ↔ String
Output Only User who requested the operation, for example: user@example.com.
read / write
warnings ↔ List<OperationWarnings>
Output Only If warning messages are generated during processing of the operation, this field will be populated.
read / write
zone ↔ String
Output Only The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
read / write
hashCode → int
The hash code for this object.
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

toJson() → Map<String, Object>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator.
inherited