Struct opendal::services::Oss

pub struct Oss { /* private fields */ }

Aliyun Object Storage Service (OSS) support

Capabilities

This service can be used to:

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

Configuration

• root: Set the work dir for backend.
• bucket: Set the container name for backend.
• endpoint: Set the endpoint for backend.
• presign_endpoint: Set the endpoint for presign.
• access_key_id: Set the access_key_id for backend.
• access_key_secret: Set the access_key_secret for backend.
• role_arn: Set the role of backend.
• oidc_token: Set the oidc_token for backend.
• allow_anonymous: Set the backend access OSS in anonymous way.

Refer to OssBuilder’s public API docs for more information.

Example

Via Builder

use std::sync::Arc;

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

#[tokio::main]
async fn main() -> Result<()> {
    // Create OSS backend builder.
    let mut builder = Oss::default();
    // Set the root for oss, all operations will happen under this root.
    //
    // NOTE: the root must be absolute path.
    builder.root("/path/to/dir");
    // Set the bucket name, this is required.
    builder.bucket("test");
    // Set the endpoint.
    //
    // For example:
    // - "https://oss-ap-northeast-1.aliyuncs.com"
    // - "https://oss-hangzhou.aliyuncs.com"
    builder.endpoint("https://oss-cn-beijing.aliyuncs.com");
    // Set the access_key_id and access_key_secret.
    //
    // OpenDAL will try load credential from the env.
    // If credential not set and no valid credential in env, OpenDAL will
    // send request without signing like anonymous user.
    builder.access_key_id("access_key_id");
    builder.access_key_secret("access_key_secret");

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

    Ok(())
}

Implementations

impl OssBuilder

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

Set root of this backend.

All operations will happen under this root.

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

Set bucket name of this backend.

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

Set endpoint of this backend.

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

Set a endpoint for generating presigned urls.

You can offer a public endpoint like https://oss-cn-beijing.aliyuncs.com to return a presinged url for public accessors, along with an internal endpoint like https://oss-cn-beijing-internal.aliyuncs.com to access objects in a faster path.

• If presign_endpoint is set, we will use presign_endpoint on generating presigned urls.
• if not, we will use endpoint as default.

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

Set access_key_id of this backend.

• If access_key_id is set, we will take user’s input first.
• If not, we will try to load it from environment.

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

Set access_key_secret of this backend.

• If access_key_secret is set, we will take user’s input first.
• If not, we will try to load it from environment.

pub fn allow_anonymous(&mut self) -> &mut Self

Anonymously access the bucket.

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.

Trait Implementations

impl Builder for OssBuilder

const SCHEME: Scheme = Scheme::Oss

Associated scheme for this builder.

type Accessor = OssBackend

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 OssBuilder

fn clone(&self) -> OssBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OssBuilder

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

Formats the value using the given formatter.

impl Default for OssBuilder

fn default() -> OssBuilder

Returns the “default value” for a type.