Struct FileMethods

Source

pub struct FileMethods<'a, C>where
    C: '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_drive3 as drive3;

use drive3::{DriveHub, FieldMask, hyper_rustls, hyper_util, yup_oauth2};

let secret: yup_oauth2::ApplicationSecret = Default::default();
let connector = hyper_rustls::HttpsConnectorBuilder::new()
    .with_native_roots()
    .unwrap()
    .https_only()
    .enable_http2()
    .build();

let executor = hyper_util::rt::TokioExecutor::new();
let auth = yup_oauth2::InstalledFlowAuthenticator::with_client(
    secret,
    yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    yup_oauth2::client::CustomHyperClientBuilder::from(
        hyper_util::client::legacy::Client::builder(executor).build(connector),
    ),
).build().await.unwrap();

let client = hyper_util::client::legacy::Client::builder(
    hyper_util::rt::TokioExecutor::new()
)
.build(
    hyper_rustls::HttpsConnectorBuilder::new()
        .with_native_roots()
        .unwrap()
        .https_or_http()
        .enable_http2()
        .build()
);
let mut hub = DriveHub::new(client, auth);
// Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
// like `copy(...)`, `create(...)`, `delete(...)`, `download(...)`, `empty_trash(...)`, `export(...)`, `generate_ids(...)`, `get(...)`, `list(...)`, `list_labels(...)`, `modify_labels(...)`, `update(...)` and `watch(...)`
// to build up your call.
let rb = hub.files();

Implementations§

Source §

impl<'a, C> FileMethods<'a, C>

Source

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

Create a builder to help you perform the following task:

Creates a copy of a file and applies any requested updates with patch semantics. For more information, see Create and manage files.

§Arguments

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

Source

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

Create a builder to help you perform the following task:

Creates a file. For more information, see Create and manage files. This method supports an /upload URI and accepts uploaded media with the following characteristics: - Maximum file size: 5,120 GB - Accepted Media MIME types: */* (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, see Google Workspace and Google Drive supported MIME types.) For more information on uploading files, see Upload file data. Apps creating shortcuts with the create method 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 name 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 name. 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 delete(&self, file_id: &str) -> FileDeleteCall<'a, C>

Create a builder to help you perform the following task:

Permanently deletes a file owned by the user without moving it to the trash. For more information, see Trash or delete files and folders. 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.

Source

pub fn download(&self, file_id: &str) -> FileDownloadCall<'a, C>

Create a builder to help you perform the following task:

Downloads the content of a file. For more information, see Download and export files. Operations are valid for 24 hours from the time of creation.

§Arguments

fileId - Required. The ID of the file to download.

Source

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

Create a builder to help you perform the following task:

Permanently deletes all of the user’s trashed files. For more information, see Trash or delete files and folders.

Source

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

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. For more information, see Download and export files. Note that the exported content is limited to 10 MB.

§Arguments

fileId - The ID of the file.
mimeType - Required. The MIME type of the format requested for this export. For a list of supported MIME types, see Export MIME types for Google Workspace documents.

Source

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

Create a builder to help you perform the following task:

Generates a set of file IDs which can be provided in create or copy requests. For more information, see Create and manage files.

Source

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

Create a builder to help you perform the following task:

Gets a file’s metadata or content by ID. For more information, see Search for files and folders. 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 and export files.

§Arguments

fileId - The ID of the file.

Source

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

Create a builder to help you perform the following task:

Lists the user’s files. For more information, see Search for files and folders. This method accepts the q parameter, which is a search query combining one or more search terms. 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, C>

Create a builder to help you perform the following task:

Lists the labels on a file. For more information, see List labels on a file.

§Arguments

fileId - The ID for the file.

Source

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

Create a builder to help you perform the following task:

Modifies the set of labels applied to a file. For more information, see Set a label field on 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 update(&self, request: File, file_id: &str) -> FileUpdateCall<'a, C>

Create a builder to help you perform the following task:

Updates a file’s metadata, content, or both. 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: */* (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, see Google Workspace and Google Drive supported MIME types.) For more information on uploading files, see Upload file data.