Struct google_drive2::api::FileMethods

source ·

pub struct FileMethods<'a, S>where
    S: 'a,
{ /* private fields */ }

Expand description

A builder providing access to all methods supported on file resources. It is not used directly, but through the DriveHub hub.

§Example

Instantiate a resource builder

extern crate hyper;
extern crate hyper_rustls;
extern crate google_drive2 as drive2;
 
use std::default::Default;
use drive2::{DriveHub, oauth2, hyper, hyper_rustls, chrono, FieldMask};
 
let secret: oauth2::ApplicationSecret = Default::default();
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = DriveHub::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
// Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
// like `copy(...)`, `delete(...)`, `empty_trash(...)`, `export(...)`, `generate_ids(...)`, `get(...)`, `insert(...)`, `list(...)`, `list_labels(...)`, `modify_labels(...)`, `patch(...)`, `touch(...)`, `trash(...)`, `untrash(...)`, `update(...)` and `watch(...)`
// to build up your call.
let rb = hub.files();

Implementations§

source §

impl<'a, S> FileMethods<'a, S>

source

pub fn copy(&self, request: File, file_id: &str) -> FileCopyCall<'a, S>

Create a builder to help you perform the following task:

Creates a copy of the specified file.

§Arguments

request - No description provided.
fileId - The ID of the file to copy.

source

pub fn delete(&self, file_id: &str) -> FileDeleteCall<'a, S>

Create a builder to help you perform the following task:

Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive, the user must be an organizer on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.

§Arguments

fileId - The ID of the file to delete.

source

pub fn empty_trash(&self) -> FileEmptyTrashCall<'a, S>

Create a builder to help you perform the following task:

Permanently deletes all of the user’s trashed files.

source

pub fn export(&self, file_id: &str, mime_type: &str) -> FileExportCall<'a, S>

Create a builder to help you perform the following task:

Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.

§Arguments

fileId - The ID of the file.
mimeType - Required. The MIME type of the format requested for this export.

source

pub fn generate_ids(&self) -> FileGenerateIdCall<'a, S>

Create a builder to help you perform the following task:

Generates a set of file IDs which can be provided in insert or copy requests.

source

pub fn get(&self, file_id: &str) -> FileGetCall<'a, S>

Create a builder to help you perform the following task:

Gets a file’s metadata or content by ID. If you provide the URL parameter alt=media, then the response includes the file contents in the response body. Downloading content with alt=media only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use files.export instead. For more information, see Download & export files.

§Arguments

fileId - The ID for the file in question.

source

pub fn insert(&self, request: File) -> FileInsertCall<'a, S>

Create a builder to help you perform the following task:

Inserts 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.insert must specify the MIME type application/vnd.google-apps.shortcut. Apps should specify a file extension in the title property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like "title": "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.

§Arguments

request - No description provided.

source

pub fn list(&self) -> FileListCall<'a, S>

Create a builder to help you perform the following task:

Lists the user’s files. This method accepts the q parameter, which is a search query combining one or more search terms. For more information, see the Search for files & folders guide. Note: This method returns all files by default, including trashed files. If you don’t want trashed files to appear in the list, use the trashed=false query parameter to remove trashed files from the results.

source

pub fn list_labels(&self, file_id: &str) -> FileListLabelCall<'a, S>

Create a builder to help you perform the following task:

Lists the labels on a file.

§Arguments

fileId - The ID for the file.

source

pub fn modify_labels( &self, request: ModifyLabelsRequest, file_id: &str ) -> FileModifyLabelCall<'a, S>

Create a builder to help you perform the following task:

Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.

§Arguments

request - No description provided.
fileId - The ID of the file to which the labels belong.

source

pub fn patch(&self, request: File, file_id: &str) -> FilePatchCall<'a, S>

Create a builder to help you perform the following task:

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 change automatically, such as modifiedDate. This method supports patch semantics.

§Arguments

request - No description provided.
fileId - The ID of the file to update.

source

pub fn touch(&self, file_id: &str) -> FileTouchCall<'a, S>

Create a builder to help you perform the following task:

Set the file’s updated time to the current server time.

§Arguments

fileId - The ID of the file to update.

source

pub fn trash(&self, file_id: &str) -> FileTrashCall<'a, S>

Create a builder to help you perform the following task:

Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files.

§Arguments

fileId - The ID of the file to trash.

source

pub fn untrash(&self, file_id: &str) -> FileUntrashCall<'a, S>

Create a builder to help you perform the following task:

Restores a file from the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files.

§Arguments

fileId - The ID of the file to untrash.

source

pub fn update(&self, request: File, file_id: &str) -> FileUpdateCall<'a, S>

Create a builder to help you perform the following task:

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.