Struct google_drive3::FileCreateCall

pub struct FileCreateCall<'a, C, A> where
    C: 'a,
    A: 'a,  { /* fields omitted */ }

Creates a new file.

A builder for the create method supported by a file resource. It is not used directly, but through a FileMethods instance.

Example

Instantiate a resource method builder

use drive3::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_resumable(...)`.
// Values shown here are possibly random and not representative !
let result = hub.files().create(req)
             .use_content_as_indexable_text(true)
             .supports_team_drives(false)
             .supports_all_drives(true)
             .ocr_language("diam")
             .keep_revision_forever(false)
             .ignore_default_visibility(true)
             .enforce_single_parent(true)
             .upload_resumable(fs::File::open("file.ext").unwrap(), "application/octet-stream".parse().unwrap());

Implementations

impl<'a, C, A> FileCreateCall<'a, C, A> where
    C: BorrowMut<Client>,
    A: GetToken, 

pub fn upload<RS>(self, stream: RS, mime_type: Mime) -> Result<(Response, File)> where
    RS: ReadSeek, 

Upload media all at once. If the upload fails for whichever reason, all progress is lost.

• max size: 5120GB
• multipart: yes
• valid mime types: '/'

pub fn upload_resumable<RS>(
    self,
    resumeable_stream: RS,
    mime_type: Mime
) -> Result<(Response, 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(...).

• max size: 5120GB
• multipart: yes
• valid mime types: '/'

pub fn request(self, new_value: File) -> FileCreateCall<'a, C, A>

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.

pub fn use_content_as_indexable_text(
    self,
    new_value: bool
) -> FileCreateCall<'a, C, A>

Whether to use the uploaded content as indexable text.

Sets the use content as indexable text query property to the given value.

pub fn supports_team_drives(self, new_value: bool) -> FileCreateCall<'a, C, A>

Deprecated use supportsAllDrives instead.

Sets the supports team drives query property to the given value.

pub fn supports_all_drives(self, new_value: bool) -> FileCreateCall<'a, C, A>

Whether the requesting application supports both My Drives and shared drives.

Sets the supports all drives query property to the given value.

pub fn ocr_language(self, new_value: &str) -> FileCreateCall<'a, C, A>

A language hint for OCR processing during image import (ISO 639-1 code).

Sets the ocr language query property to the given value.

pub fn keep_revision_forever(self, new_value: bool) -> FileCreateCall<'a, C, A>

Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.

Sets the keep revision forever query property to the given value.

pub fn ignore_default_visibility(
    self,
    new_value: bool
) -> FileCreateCall<'a, C, A>

Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.

Sets the ignore default visibility query property to the given value.

pub fn enforce_single_parent(self, new_value: bool) -> FileCreateCall<'a, C, A>

Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail.

Sets the enforce single parent query property to the given value.

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> FileCreateCall<'a, C, A>

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.

pub fn param<T>(self, name: T, value: T) -> FileCreateCall<'a, C, A> where
    T: AsRef<str>, 

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

• quotaUser (query-string) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• oauth_token (query-string) - OAuth 2.0 token for the current user.
• 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.
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• userIp (query-string) - Deprecated. Please use quotaUser instead.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• alt (query-string) - Data format for the response.

pub fn add_scope<T, S>(self, scope: T) -> FileCreateCall<'a, C, A> where
    T: Into<Option<S>>,
    S: AsRef<str>, 

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead 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. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

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.

Trait Implementations

impl<'a, C, A> CallBuilder for FileCreateCall<'a, C, A>