Struct google_docs1::api::DocumentBatchUpdateCall
source · pub struct DocumentBatchUpdateCall<'a, S>where
S: 'a,{ /* private fields */ }Expand description
Applies one or more updates to the document. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies, the reply to the third request, and another empty reply, in that order. Because other users may be editing the document, the document might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the document should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically.
A builder for the batchUpdate method supported by a document resource.
It is not used directly, but through a DocumentMethods instance.
§Example
Instantiate a resource method builder
use docs1::api::BatchUpdateDocumentRequest;
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = BatchUpdateDocumentRequest::default();
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.documents().batch_update(req, "documentId")
.doit().await;Implementations§
source§impl<'a, S> DocumentBatchUpdateCall<'a, S>
impl<'a, S> DocumentBatchUpdateCall<'a, S>
sourcepub async fn doit(self) -> Result<(Response<Body>, BatchUpdateDocumentResponse)>
pub async fn doit(self) -> Result<(Response<Body>, BatchUpdateDocumentResponse)>
Perform the operation you have build so far.
sourcepub fn request(
self,
new_value: BatchUpdateDocumentRequest
) -> DocumentBatchUpdateCall<'a, S>
pub fn request( self, new_value: BatchUpdateDocumentRequest ) -> DocumentBatchUpdateCall<'a, S>
Sets the request property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn document_id(self, new_value: &str) -> DocumentBatchUpdateCall<'a, S>
pub fn document_id(self, new_value: &str) -> DocumentBatchUpdateCall<'a, S>
The ID of the document to update.
Sets the document id path property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> DocumentBatchUpdateCall<'a, S>
pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> DocumentBatchUpdateCall<'a, S>
The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.
It should be used to handle progress information, and to implement a certain level of resilience.
Sets the delegate property to the given value.
sourcepub fn param<T>(self, name: T, value: T) -> DocumentBatchUpdateCall<'a, S>
pub fn param<T>(self, name: T, value: T) -> DocumentBatchUpdateCall<'a, S>
Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.
Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.
§Additional Parameters
- $.xgafv (query-string) - V1 error format.
- access_token (query-string) - OAuth access token.
- alt (query-string) - Data format for response.
- callback (query-string) - JSONP
- fields (query-string) - Selector specifying which fields to include in a partial response.
- key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- oauth_token (query-string) - OAuth 2.0 token for the current user.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
- upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).
sourcepub fn add_scope<St>(self, scope: St) -> DocumentBatchUpdateCall<'a, S>
pub fn add_scope<St>(self, scope: St) -> DocumentBatchUpdateCall<'a, S>
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead of the default Scope variant
Scope::Document.
The scope will be added to a set of scopes. This is important as one can maintain access
tokens for more than one scope.
Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.
sourcepub fn add_scopes<I, St>(self, scopes: I) -> DocumentBatchUpdateCall<'a, S>
pub fn add_scopes<I, St>(self, scopes: I) -> DocumentBatchUpdateCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope() for details.
sourcepub fn clear_scopes(self) -> DocumentBatchUpdateCall<'a, S>
pub fn clear_scopes(self) -> DocumentBatchUpdateCall<'a, S>
Removes all scopes, and no default scope will be used either.
In this case, you have to specify your API-key using the key parameter (see Self::param()
for details).