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< metadata, required Input<String, String> >String> name, required Input<Map< response})String, String> > -
Creates a new OperationResponse.
doneIf the value isfalse, it means the operation is still in progress. Iftrue, the operation is completed, and eithererrororresponseis available.errorThe error result of the operation in case of failure or cancellation.metadataService-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.nameThe server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, thenameshould be a resource name ending withoperations/{unique_id}.responseThe normal, successful response of the operation. If the original method returns no data on success, such asDelete, the response isgoogle.protobuf.Empty. If the original method is standardGet/Create/Update, the response should be the resource. For other methods, the response should have the typeXxxResponse, whereXxxis the original method name. For example, if the original method name isTakeSnapshot(), the inferred response type isTakeSnapshotResponse.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. Iftrue, the operation is completed, and eithererrororresponseis 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
nameshould be a resource name ending withoperations/{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 isgoogle.protobuf.Empty. If the original method is standardGet/Create/Update, the response should be the resource. For other methods, the response should have the typeXxxResponse, whereXxxis the original method name. For example, if the original method name isTakeSnapshot(), the inferred response type isTakeSnapshotResponse.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