Struct opendal::services::Gcs

pub struct Gcs { /* private fields */ }

Google Cloud Storage service.

Capabilities

This service can be used to:

• read
• write
• list
• scan
• presign
• blocking

Configuration

• root: Set the work directory for backend
• bucket: Set the container name for backend
• endpoint: Customizable endpoint setting
• credentials: Credential string for GCS OAuth2

You can refer to GcsBuilder’s 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 for GCS OAUTH2 authentication
    builder.credential("authentication token");

    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

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

set the credentials path of GCS.

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 signer(&mut self, signer: GoogleSigner) -> &mut Self

Specify the signer directly instead of building by OpenDAL.

If signer is specified, the following settings will not be used any more:

• scope
• service_account
• credential
• credential_path

PLEASE USE THIS API CAREFULLY.

Trait Implementations

impl Builder for GcsBuilder

const SCHEME: Scheme = Scheme::Gcs

Associated scheme for this builder.

type Accessor = GcsBackend

The accessor that built by this builder.

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

Construct a builder from given map.

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

Consume the accessor builder to build a service.

fn from_iter(iter: impl Iterator<Item = (String, String)>) -> Selfwhere
    Self: Sized,

Construct a builder from given iterator.

fn from_env() -> Selfwhere
    Self: Sized,

Construct a builder from envs.

impl Clone for GcsBuilder

fn clone(&self) -> GcsBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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.