OperationResponse class

This resource represents a long-running operation that is the result of a network API call.

Constructors

OperationResponse({required Input<bool> done, required Input<StatusResponse> error, required Input<Map<String, String>> metadata, required Input<String> name, required Input<Map<String, String>> response})
Creates a new OperationResponse. done If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. error The error result of the operation in case of failure or cancellation. metadata Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. name The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}. response The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
const
OperationResponse.fromMap(Map<String, dynamic> map)
factory

Properties

done → Input<bool>
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
final
error → Input<StatusResponse>
The error result of the operation in case of failure or cancellation.
final
hashCode → int
The hash code for this object.
no setterinherited
metadata → Input<Map<String, String>>
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
final
name → Input<String>
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
final
response → Input<Map<String, String>>
The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

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