Struct google_drive2::api::FileUpdateCall
source · pub struct FileUpdateCall<'a, S>where
S: 'a,{ /* private fields */ }Expand description
Updates a file’s metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as modifiedDate. This method supports patch semantics. This method supports an /upload URI and accepts uploaded media with the following characteristics: - Maximum file size: 5,120 GB - Accepted Media MIME types:*/* Note: Specify a valid MIME type, rather than the literal */* value. The literal */* is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see Upload file data.
A builder for the update method supported by a file resource.
It is not used directly, but through a FileMethods instance.
§Example
Instantiate a resource method builder
use drive2::api::File;
use std::fs;
// 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 = File::default();
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `upload(...)`.
// Values shown here are possibly random and not representative !
let result = hub.files().update(req, "fileId")
.use_content_as_indexable_text(false)
.update_viewed_date(false)
.timed_text_track_name("diam")
.timed_text_language("sed")
.supports_team_drives(false)
.supports_all_drives(true)
.set_modified_date(true)
.remove_parents("At")
.pinned(true)
.ocr_language("sit")
.ocr(false)
.new_revision(false)
.modified_date_behavior("elitr")
.include_permissions_for_view("aliquyam")
.include_labels("erat")
.enforce_single_parent(false)
.convert(true)
.add_parents("rebum.")
.upload(fs::File::open("file.ext").unwrap(), "application/octet-stream".parse().unwrap()).await;Implementations§
source§impl<'a, S> FileUpdateCall<'a, S>
impl<'a, S> FileUpdateCall<'a, S>
sourcepub async fn doit_without_upload(self) -> Result<(Response<Body>, File)>
pub async fn doit_without_upload(self) -> Result<(Response<Body>, File)>
Perform the operation you have build so far, but without uploading. This is used to e.g. renaming or updating the description for a file
sourcepub async fn upload_resumable<RS>(
self,
resumeable_stream: RS,
mime_type: Mime
) -> Result<(Response<Body>, File)>where
RS: ReadSeek,
pub async fn upload_resumable<RS>(
self,
resumeable_stream: RS,
mime_type: Mime
) -> Result<(Response<Body>, File)>where
RS: ReadSeek,
Upload media in a resumable fashion. Even if the upload fails or is interrupted, it can be resumed for a certain amount of time as the server maintains state temporarily.
The delegate will be asked for an upload_url(), and if not provided, will be asked to store an upload URL
that was provided by the server, using store_upload_url(...). The upload will be done in chunks, the delegate
may specify the chunk_size() and may cancel the operation before each chunk is uploaded, using
cancel_chunk_upload(...).
- multipart: yes
- max size: 5497558138880
- valid mime types: ‘/’
sourcepub async fn upload<RS>(
self,
stream: RS,
mime_type: Mime
) -> Result<(Response<Body>, File)>where
RS: ReadSeek,
pub async fn upload<RS>(
self,
stream: RS,
mime_type: Mime
) -> Result<(Response<Body>, File)>where
RS: ReadSeek,
Upload media all at once. If the upload fails for whichever reason, all progress is lost.
- multipart: yes
- max size: 5497558138880
- valid mime types: ‘/’
sourcepub fn request(self, new_value: File) -> FileUpdateCall<'a, S>
pub fn request(self, new_value: File) -> FileUpdateCall<'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 file_id(self, new_value: &str) -> FileUpdateCall<'a, S>
pub fn file_id(self, new_value: &str) -> FileUpdateCall<'a, S>
The ID of the file to update.
Sets the file 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 use_content_as_indexable_text(
self,
new_value: bool
) -> FileUpdateCall<'a, S>
pub fn use_content_as_indexable_text( self, new_value: bool ) -> FileUpdateCall<'a, S>
Whether to use the content as indexable text.
Sets the use content as indexable text query property to the given value.
sourcepub fn update_viewed_date(self, new_value: bool) -> FileUpdateCall<'a, S>
pub fn update_viewed_date(self, new_value: bool) -> FileUpdateCall<'a, S>
Whether to update the view date after successfully updating the file.
Sets the update viewed date query property to the given value.
sourcepub fn timed_text_track_name(self, new_value: &str) -> FileUpdateCall<'a, S>
pub fn timed_text_track_name(self, new_value: &str) -> FileUpdateCall<'a, S>
The timed text track name.
Sets the timed text track name query property to the given value.
sourcepub fn timed_text_language(self, new_value: &str) -> FileUpdateCall<'a, S>
pub fn timed_text_language(self, new_value: &str) -> FileUpdateCall<'a, S>
The language of the timed text.
Sets the timed text language query property to the given value.
sourcepub fn supports_team_drives(self, new_value: bool) -> FileUpdateCall<'a, S>
pub fn supports_team_drives(self, new_value: bool) -> FileUpdateCall<'a, S>
Deprecated: Use supportsAllDrives instead.
Sets the supports team drives query property to the given value.
sourcepub fn supports_all_drives(self, new_value: bool) -> FileUpdateCall<'a, S>
pub fn supports_all_drives(self, new_value: bool) -> FileUpdateCall<'a, S>
Whether the requesting application supports both My Drives and shared drives.
Sets the supports all drives query property to the given value.
sourcepub fn set_modified_date(self, new_value: bool) -> FileUpdateCall<'a, S>
pub fn set_modified_date(self, new_value: bool) -> FileUpdateCall<'a, S>
Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.
Sets the set modified date query property to the given value.
sourcepub fn remove_parents(self, new_value: &str) -> FileUpdateCall<'a, S>
pub fn remove_parents(self, new_value: &str) -> FileUpdateCall<'a, S>
Comma-separated list of parent IDs to remove.
Sets the remove parents query property to the given value.
sourcepub fn pinned(self, new_value: bool) -> FileUpdateCall<'a, S>
pub fn pinned(self, new_value: bool) -> FileUpdateCall<'a, S>
Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.
Sets the pinned query property to the given value.
sourcepub fn ocr_language(self, new_value: &str) -> FileUpdateCall<'a, S>
pub fn ocr_language(self, new_value: &str) -> FileUpdateCall<'a, S>
If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
Sets the ocr language query property to the given value.
sourcepub fn ocr(self, new_value: bool) -> FileUpdateCall<'a, S>
pub fn ocr(self, new_value: bool) -> FileUpdateCall<'a, S>
Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
Sets the ocr query property to the given value.
sourcepub fn new_revision(self, new_value: bool) -> FileUpdateCall<'a, S>
pub fn new_revision(self, new_value: bool) -> FileUpdateCall<'a, S>
Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center.
Sets the new revision query property to the given value.
sourcepub fn modified_date_behavior(self, new_value: &str) -> FileUpdateCall<'a, S>
pub fn modified_date_behavior(self, new_value: &str) -> FileUpdateCall<'a, S>
Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.
Sets the modified date behavior query property to the given value.
sourcepub fn include_permissions_for_view(
self,
new_value: &str
) -> FileUpdateCall<'a, S>
pub fn include_permissions_for_view( self, new_value: &str ) -> FileUpdateCall<'a, S>
Specifies which additional view’s permissions to include in the response. Only published is supported.
Sets the include permissions for view query property to the given value.
sourcepub fn include_labels(self, new_value: &str) -> FileUpdateCall<'a, S>
pub fn include_labels(self, new_value: &str) -> FileUpdateCall<'a, S>
A comma-separated list of IDs of labels to include in the labelInfo part of the response.
Sets the include labels query property to the given value.
sourcepub fn enforce_single_parent(self, new_value: bool) -> FileUpdateCall<'a, S>
pub fn enforce_single_parent(self, new_value: bool) -> FileUpdateCall<'a, S>
Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.
Sets the enforce single parent query property to the given value.
sourcepub fn convert(self, new_value: bool) -> FileUpdateCall<'a, S>
pub fn convert(self, new_value: bool) -> FileUpdateCall<'a, S>
Deprecated: This parameter has no function.
Sets the convert query property to the given value.
sourcepub fn add_parents(self, new_value: &str) -> FileUpdateCall<'a, S>
pub fn add_parents(self, new_value: &str) -> FileUpdateCall<'a, S>
Comma-separated list of parent IDs to add.
Sets the add parents query property to the given value.
sourcepub fn delegate(self, new_value: &'a mut dyn Delegate) -> FileUpdateCall<'a, S>
pub fn delegate(self, new_value: &'a mut dyn Delegate) -> FileUpdateCall<'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) -> FileUpdateCall<'a, S>
pub fn param<T>(self, name: T, value: T) -> FileUpdateCall<'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) -> FileUpdateCall<'a, S>
pub fn add_scope<St>(self, scope: St) -> FileUpdateCall<'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::Full.
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) -> FileUpdateCall<'a, S>
pub fn add_scopes<I, St>(self, scopes: I) -> FileUpdateCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope() for details.
sourcepub fn clear_scopes(self) -> FileUpdateCall<'a, S>
pub fn clear_scopes(self) -> FileUpdateCall<'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).