Struct google_drive2::api::FileCopyCall
source · pub struct FileCopyCall<'a, S>where
S: 'a,{ /* private fields */ }
Expand description
Creates a copy of the specified file.
A builder for the copy 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;
// 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 `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.files().copy(req, "fileId")
.visibility("gubergren")
.timed_text_track_name("sadipscing")
.timed_text_language("At")
.supports_team_drives(true)
.supports_all_drives(true)
.pinned(false)
.ocr_language("et")
.ocr(true)
.include_permissions_for_view("dolor")
.include_labels("Lorem")
.enforce_single_parent(false)
.convert(true)
.doit().await;
Implementations§
source§impl<'a, S> FileCopyCall<'a, S>
impl<'a, S> FileCopyCall<'a, S>
sourcepub async fn doit(self) -> Result<(Response<Body>, File)>
pub async fn doit(self) -> Result<(Response<Body>, File)>
Perform the operation you have build so far.
sourcepub fn request(self, new_value: File) -> FileCopyCall<'a, S>
pub fn request(self, new_value: File) -> FileCopyCall<'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) -> FileCopyCall<'a, S>
pub fn file_id(self, new_value: &str) -> FileCopyCall<'a, S>
The ID of the file to copy.
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 visibility(self, new_value: &str) -> FileCopyCall<'a, S>
pub fn visibility(self, new_value: &str) -> FileCopyCall<'a, S>
The visibility of the new file. This parameter is only relevant when the source is not a native Google Doc and convert=false.
Sets the visibility query property to the given value.
sourcepub fn timed_text_track_name(self, new_value: &str) -> FileCopyCall<'a, S>
pub fn timed_text_track_name(self, new_value: &str) -> FileCopyCall<'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) -> FileCopyCall<'a, S>
pub fn timed_text_language(self, new_value: &str) -> FileCopyCall<'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) -> FileCopyCall<'a, S>
pub fn supports_team_drives(self, new_value: bool) -> FileCopyCall<'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) -> FileCopyCall<'a, S>
pub fn supports_all_drives(self, new_value: bool) -> FileCopyCall<'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 pinned(self, new_value: bool) -> FileCopyCall<'a, S>
pub fn pinned(self, new_value: bool) -> FileCopyCall<'a, S>
Whether to pin the head revision of the new copy. 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) -> FileCopyCall<'a, S>
pub fn ocr_language(self, new_value: &str) -> FileCopyCall<'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) -> FileCopyCall<'a, S>
pub fn ocr(self, new_value: bool) -> FileCopyCall<'a, S>
Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
Sets the ocr query property to the given value.
sourcepub fn include_permissions_for_view(
self,
new_value: &str
) -> FileCopyCall<'a, S>
pub fn include_permissions_for_view( self, new_value: &str ) -> FileCopyCall<'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) -> FileCopyCall<'a, S>
pub fn include_labels(self, new_value: &str) -> FileCopyCall<'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) -> FileCopyCall<'a, S>
pub fn enforce_single_parent(self, new_value: bool) -> FileCopyCall<'a, S>
Deprecated: Copying files into 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) -> FileCopyCall<'a, S>
pub fn convert(self, new_value: bool) -> FileCopyCall<'a, S>
Whether to convert this file to the corresponding Docs Editors format.
Sets the convert query property to the given value.
sourcepub fn delegate(self, new_value: &'a mut dyn Delegate) -> FileCopyCall<'a, S>
pub fn delegate(self, new_value: &'a mut dyn Delegate) -> FileCopyCall<'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) -> FileCopyCall<'a, S>
pub fn param<T>(self, name: T, value: T) -> FileCopyCall<'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) -> FileCopyCall<'a, S>
pub fn add_scope<St>(self, scope: St) -> FileCopyCall<'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) -> FileCopyCall<'a, S>
pub fn add_scopes<I, St>(self, scopes: I) -> FileCopyCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope()
for details.
sourcepub fn clear_scopes(self) -> FileCopyCall<'a, S>
pub fn clear_scopes(self) -> FileCopyCall<'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).