pub struct Obs { /* private fields */ }
Expand description
Huawei Cloud OBS services support.
Capabilities
This service can be used to:
- read
- write
- list
- scan
- presign
- blocking
Configuration
root
: Set the work directory for backendbucket
: Set the container name for backendendpoint
: Customizable endpoint settingaccess_key_id
: Set the access_key_id for backend.secret_access_key
: Set the secret_access_key for backend.
You can refer to ObsBuilder
’s docs for more information
Example
Via Builder
use anyhow::Result;
use opendal::services::Obs;
use opendal::Operator;
#[tokio::main]
async fn main() -> Result<()> {
// create backend builder
let mut builder = Obs::default();
// set the storage bucket for OpenDAL
builder.bucket("test");
// Set the access_key_id and secret_access_key.
//
// 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.secret_access_key("secret_access_key");
let op: Operator = Operator::new(builder)?.finish();
Ok(())
}
Implementations§
source§impl ObsBuilder
impl ObsBuilder
sourcepub fn root(&mut self, root: &str) -> &mut Self
pub fn root(&mut self, root: &str) -> &mut Self
Set root of this backend.
All operations will happen under this root.
sourcepub fn endpoint(&mut self, endpoint: &str) -> &mut Self
pub fn endpoint(&mut self, endpoint: &str) -> &mut Self
Set endpoint of this backend.
Both huaweicloud default domain and user domain endpoints are allowed. Please DO NOT add the bucket name to the endpoint.
https://obs.cn-north-4.myhuaweicloud.com
obs.cn-north-4.myhuaweicloud.com
(https by default)https://custom.obs.com
(port should not be set)
sourcepub fn access_key_id(&mut self, access_key_id: &str) -> &mut Self
pub fn access_key_id(&mut self, access_key_id: &str) -> &mut Self
Set access_key_id of this backend.
- If it is set, we will take user’s input first.
- If not, we will try to load it from environment.
sourcepub fn secret_access_key(&mut self, secret_access_key: &str) -> &mut Self
pub fn secret_access_key(&mut self, secret_access_key: &str) -> &mut Self
Set secret_access_key of this backend.
- If it is set, we will take user’s input first.
- If not, we will try to load it from environment.
sourcepub fn bucket(&mut self, bucket: &str) -> &mut Self
pub fn bucket(&mut self, bucket: &str) -> &mut Self
Set bucket of this backend. The param is required.
sourcepub fn http_client(&mut self, client: HttpClient) -> &mut Self
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§
source§impl Builder for ObsBuilder
impl Builder for ObsBuilder
source§impl Clone for ObsBuilder
impl Clone for ObsBuilder
source§fn clone(&self) -> ObsBuilder
fn clone(&self) -> ObsBuilder
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for ObsBuilder
impl Debug for ObsBuilder
source§impl Default for ObsBuilder
impl Default for ObsBuilder
source§fn default() -> ObsBuilder
fn default() -> ObsBuilder
Returns the “default value” for a type. Read more