Struct google_firestore1::api::GoogleLongrunningOperation
source · pub struct GoogleLongrunningOperation {
pub done: Option<bool>,
pub error: Option<Status>,
pub metadata: Option<HashMap<String, Value>>,
pub name: Option<String>,
pub response: Option<HashMap<String, Value>>,
}
Expand description
This resource represents a long-running operation that is the result of a network API call.
§Activities
This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).
- databases collection groups fields patch projects (response)
- databases collection groups indexes create projects (response)
- databases operations get projects (response)
- databases create projects (response)
- databases delete projects (response)
- databases export documents projects (response)
- databases import documents projects (response)
- databases patch projects (response)
- databases restore projects (response)
Fields§
§done: Option<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.
error: Option<Status>
The error result of the operation in case of failure or cancellation.
metadata: Option<HashMap<String, Value>>
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: Option<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}
.
response: Option<HashMap<String, Value>>
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
.
Trait Implementations§
source§impl Clone for GoogleLongrunningOperation
impl Clone for GoogleLongrunningOperation
source§fn clone(&self) -> GoogleLongrunningOperation
fn clone(&self) -> GoogleLongrunningOperation
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more