Struct opendal::services::Gcs

pub struct Gcs { /* private fields */ }

Available on crate feature services-gcs only.

Google Cloud Storage services support.

Capabilities

This service can be used to:

• stat
• read
• write
• create_dir
• delete
• copy
• rename
• list
• scan
• presign
• blocking

Configuration

• root: Set the work directory for backend
• bucket: Set the container name for backend
• endpoint: Customizable endpoint setting
• credential: Credentials string for GCS service OAuth2 authentication
• credential_path: Local path to credentials file for GCS service OAuth2 authentication
• predefined_acl: Predefined ACL for GCS
• default_storage_class: Default storage class for GCS

Refer to public API docs for more information.

Example

Via Builder

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

#[tokio::main]
async fn main() -> Result<()> {
    // create backend builder
    let mut builder = Gcs::default();

    // set the storage bucket for OpenDAL
    builder.bucket("test");
    // set the working directory root for GCS
    // all operations will happen within it
    builder.root("/path/to/dir");
    // set the credentials string of service account
    builder.credential("service account credential");
    // set the predefined ACL for GCS
    builder.predefined_acl("publicRead");
    // set the default storage class for GCS
    builder.default_storage_class("STANDARD");

    let op: Operator = Operator::new(builder)?.finish();
    Ok(())
}

Implementations

impl GcsBuilder

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

set the working directory root of backend

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

set the container’s name

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

set the GCS service scope

If not set, we will use https://www.googleapis.com/auth/devstorage.read_write.

Valid scope examples

• read-only: https://www.googleapis.com/auth/devstorage.read_only
• read-write: https://www.googleapis.com/auth/devstorage.read_write
• full-control: https://www.googleapis.com/auth/devstorage.full_control

Reference: Cloud Storage authentication

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

Set the GCS service account.

service account will be used for fetch token from vm metadata. If not set, we will try to fetch with default service account.

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

set the endpoint GCS service uses

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

set the base64 hashed credentials string used for OAuth2 authentication.

this method allows to specify the credentials directly as a base64 hashed string. alternatively, you can use credential_path() to provide the local path to a credentials file. we will use one of credential and credential_path to complete the OAuth2 authentication.

Reference: Google Cloud Storage Authentication.

pub fn credential_path(&mut self, path: &str) -> &mut Self

set the local path to credentials file which is used for OAuth2 authentication.

credentials file contains the original credentials that have not been base64 hashed. we will use one of credential and credential_path to complete the OAuth2 authentication.

Reference: Google Cloud Storage Authentication.

pub fn http_client(&mut self, client: HttpClient) -> &mut 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.

pub fn customed_token_loader( &mut self, token_load: Box<dyn GoogleTokenLoad> ) -> &mut Self

Specify the customed token loader used by this service.

pub fn predefined_acl(&mut self, acl: &str) -> &mut Self

Set the predefined acl for GCS.

Available values are:

• authenticatedRead
• bucketOwnerFullControl
• bucketOwnerRead
• private
• projectPrivate
• publicRead

pub fn default_storage_class(&mut self, class: &str) -> &mut Self

Set the default storage class for GCS.

Available values are:

• STANDARD
• NEARLINE
• COLDLINE
• ARCHIVE

Trait Implementations

impl Builder for GcsBuilder

const SCHEME: Scheme = Scheme::Gcs

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

type Accessor = GcsBackend

The accessor that built by this builder.

fn from_map(map: HashMap<String, String>) -> Self

Construct a builder from given map which contains several parameters needed by underlying service.

fn build(&mut self) -> Result<Self::Accessor>

Consume the accessor builder to build a service.

impl Debug for GcsBuilder

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

Formats the value using the given formatter.

impl Default for GcsBuilder

fn default() -> GcsBuilder

Returns the “default value” for a type.