Struct google_drive3::api::FileCreateCall
source · pub struct FileCreateCall<'a, S>where
S: 'a,{ /* private fields */ }
Expand description
Creates a new file. 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. Apps creating shortcuts with files.create
must specify the MIME type application/vnd.google-apps.shortcut
. Apps should specify a file extension in the name
property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like "name": "cat.jpg"
in the metadata. Subsequent GET
requests include the read-only fileExtension
property populated with the extension originally specified in the title
property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file’s MIME type.
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::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().create(req)
.use_content_as_indexable_text(true)
.supports_team_drives(true)
.supports_all_drives(true)
.ocr_language("sed")
.keep_revision_forever(false)
.include_permissions_for_view("Lorem")
.include_labels("ea")
.ignore_default_visibility(true)
.enforce_single_parent(false)
.upload(fs::File::open("file.ext").unwrap(), "application/octet-stream".parse().unwrap()).await;
Implementations§
source§impl<'a, S> FileCreateCall<'a, S>
impl<'a, S> FileCreateCall<'a, S>
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) -> FileCreateCall<'a, S>
pub fn request(self, new_value: File) -> FileCreateCall<'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 use_content_as_indexable_text(
self,
new_value: bool
) -> FileCreateCall<'a, S>
pub fn use_content_as_indexable_text( self, new_value: bool ) -> FileCreateCall<'a, S>
Whether to use the uploaded content as indexable text.
Sets the use content as indexable text query property to the given value.
sourcepub fn supports_team_drives(self, new_value: bool) -> FileCreateCall<'a, S>
pub fn supports_team_drives(self, new_value: bool) -> FileCreateCall<'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) -> FileCreateCall<'a, S>
pub fn supports_all_drives(self, new_value: bool) -> FileCreateCall<'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 ocr_language(self, new_value: &str) -> FileCreateCall<'a, S>
pub fn ocr_language(self, new_value: &str) -> FileCreateCall<'a, S>
A language hint for OCR processing during image import (ISO 639-1 code).
Sets the ocr language query property to the given value.
sourcepub fn keep_revision_forever(self, new_value: bool) -> FileCreateCall<'a, S>
pub fn keep_revision_forever(self, new_value: bool) -> FileCreateCall<'a, S>
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.
sourcepub fn include_permissions_for_view(
self,
new_value: &str
) -> FileCreateCall<'a, S>
pub fn include_permissions_for_view( self, new_value: &str ) -> FileCreateCall<'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) -> FileCreateCall<'a, S>
pub fn include_labels(self, new_value: &str) -> FileCreateCall<'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 ignore_default_visibility(self, new_value: bool) -> FileCreateCall<'a, S>
pub fn ignore_default_visibility(self, new_value: bool) -> FileCreateCall<'a, S>
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.
sourcepub fn enforce_single_parent(self, new_value: bool) -> FileCreateCall<'a, S>
pub fn enforce_single_parent(self, new_value: bool) -> FileCreateCall<'a, S>
Deprecated. Creating files in multiple folders is no longer supported.
Sets the enforce single parent query property to the given value.
sourcepub fn delegate(self, new_value: &'a mut dyn Delegate) -> FileCreateCall<'a, S>
pub fn delegate(self, new_value: &'a mut dyn Delegate) -> FileCreateCall<'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) -> FileCreateCall<'a, S>
pub fn param<T>(self, name: T, value: T) -> FileCreateCall<'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) -> FileCreateCall<'a, S>
pub fn add_scope<St>(self, scope: St) -> FileCreateCall<'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) -> FileCreateCall<'a, S>
pub fn add_scopes<I, St>(self, scopes: I) -> FileCreateCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope()
for details.
sourcepub fn clear_scopes(self) -> FileCreateCall<'a, S>
pub fn clear_scopes(self) -> FileCreateCall<'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).