Struct opendal::services::Gdrive

pub struct Gdrive { /* private fields */ }

Available on crate feature services-gdrive only.

GoogleDrive backend support.

Capabilities

This service can be used to:

• stat
• read
• write
• delete
• create_dir
• list
• copy
• rename
• batch

Configuration

• root: Set the work directory for backend

Credentials related

Just provide Access Token (Temporary)

• access_token: set the access_token for google drive api Please notice its expiration.

Or provide Client ID and Client Secret and refresh token (Long Term)

If you want to let OpenDAL to refresh the access token automatically, please provide the following fields:

• refresh_token: set the refresh_token for google drive api
• client_id: set the client_id for google drive api
• client_secret: set the client_secret for google drive api

OpenDAL is a library, it cannot do the first step of OAuth2 for you. You need to get authorization code from user by calling GoogleDrive’s authorize url and exchange it for refresh token.

Make sure you have enabled Google Drive API in your Google Cloud Console. And your OAuth scope contains https://www.googleapis.com/auth/drive.

Please refer to GoogleDrive OAuth2 Flow for more information.

You can refer to GdriveBuilder’s docs for more information

Example

Via Builder

use anyhow::Result;
use opendal::services::Gdrive;
use opendal::Operator;

#[tokio::main]
async fn main() -> Result<()> {
    let mut builder = Gdrive::default()
        .root("/test")
        .access_token("<token>");

    Ok(())
}

Implementations

impl GdriveBuilder

pub fn root(self, root: &str) -> Self

Set root path of GoogleDrive folder.

pub fn access_token(self, access_token: &str) -> Self

Access token is used for temporary access to the GoogleDrive API.

You can get the access token from GoogleDrive App Console or GoogleDrive OAuth2 Playground

Note

• An access token is valid for 1 hour.
• If you want to use the access token for a long time, you can use the refresh token to get a new access token.

pub fn refresh_token(self, refresh_token: &str) -> Self

Refresh token is used for long term access to the GoogleDrive API.

You can get the refresh token via OAuth 2.0 Flow of GoogleDrive API.

OpenDAL will use this refresh token to get a new access token when the old one is expired.

pub fn client_id(self, client_id: &str) -> Self

Set the client id for GoogleDrive.

This is required for OAuth 2.0 Flow to refresh the access token.

pub fn client_secret(self, client_secret: &str) -> Self

Set the client secret for GoogleDrive.

This is required for OAuth 2.0 Flow with refresh the access token.

pub fn http_client(self, http_client: HttpClient) -> Self

Specify the http client that used by this service.

Notes

This API is part of OpenDAL’s Raw API. HttpClient could be changed during minor updates.

Trait Implementations

impl Builder for GdriveBuilder

const SCHEME: Scheme = Scheme::Gdrive

Associated scheme for this builder. It indicates what underlying service is.

type Config = GdriveConfig

Associated configuration for this builder.

fn build(self) -> Result<impl Access>

Consume the accessor builder to build a service.

impl Debug for GdriveBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GdriveBuilder

fn default() -> GdriveBuilder

Returns the “default value” for a type.