Class ServiceConfig.Tos

java.lang.Object

org.apache.opendal.ServiceConfig.Tos

All Implemented Interfaces:

ServiceConfig

Enclosing interface:

ServiceConfig

public static class ServiceConfig.Tos
extends Object
implements ServiceConfig

Configuration for service tos.

Nested Class Summary

Nested classes/interfaces inherited from interface ServiceConfig

ServiceConfig.AliyunDrive, ServiceConfig.Alluxio, ServiceConfig.Azblob, ServiceConfig.Azdls, ServiceConfig.Azfile, ServiceConfig.B2, ServiceConfig.Cacache, ServiceConfig.CloudflareKv, ServiceConfig.Compfs, ServiceConfig.Cos, ServiceConfig.D1, ServiceConfig.Dashmap, ServiceConfig.Dbfs, ServiceConfig.Dropbox, ServiceConfig.Etcd, ServiceConfig.Foyer, ServiceConfig.Fs, ServiceConfig.Gcs, ServiceConfig.Gdrive, ServiceConfig.Ghac, ServiceConfig.Github, ServiceConfig.Goosefs, ServiceConfig.Gridfs, ServiceConfig.HdfsNative, ServiceConfig.Hf, ServiceConfig.Http, ServiceConfig.Ipfs, ServiceConfig.Ipmfs, ServiceConfig.Koofr, ServiceConfig.Lakefs, ServiceConfig.Memcached, ServiceConfig.Memory, ServiceConfig.MiniMoka, ServiceConfig.Moka, ServiceConfig.Mongodb, ServiceConfig.Monoiofs, ServiceConfig.Mysql, ServiceConfig.Obs, ServiceConfig.Onedrive, ServiceConfig.Opfs, ServiceConfig.Oss, ServiceConfig.Pcloud, ServiceConfig.Persy, ServiceConfig.Postgresql, ServiceConfig.Redb, ServiceConfig.Redis, ServiceConfig.S3, ServiceConfig.Seafile, ServiceConfig.Sftp, ServiceConfig.Sled, ServiceConfig.Sqlite, ServiceConfig.Surrealdb, ServiceConfig.Swift, ServiceConfig.Tos, ServiceConfig.Upyun, ServiceConfig.VercelArtifacts, ServiceConfig.VercelBlob, ServiceConfig.Webdav, ServiceConfig.Webhdfs, ServiceConfig.YandexDisk

Field Summary

Fields

Modifier and Type	Field	Description
final String	accessKeyId	access_key_id of this backend.
final @NonNull String	bucket	bucket name of this backend.
final Boolean	disableConfigLoad	Disable config load so that opendal will not load config from environment.
final String	endpoint	endpoint of this backend.
final String	region	Region represent the signing region of this endpoint.
final String	root	root of this backend.
final String	secretAccessKey	secret_access_key of this backend.
final String	securityToken	security_token of this backend.
final Boolean	skipSignature	Skip signature will skip loading credentials and signing requests.

Constructor Summary

Constructors

Constructor	Description
Tos()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	configMap()	Convert the structured config to a type erased config map.
String	scheme()	The scheme of the service.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

accessKeyId

public final String accessKeyId

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.

bucket

@NonNull
public final @NonNull String bucket

bucket name of this backend.

required.

disableConfigLoad

public final Boolean disableConfigLoad

Disable config load so that opendal will not load config from environment.

For examples:

• envs like TOS_ACCESS_KEY_ID

endpoint

public final String endpoint

endpoint of this backend.

Endpoint must be full uri, e.g.

• TOS: https://tos-cn-beijing.volces.com
• TOS with region: https://tos-{region}.volces.com

If user inputs endpoint without scheme like "tos-cn-beijing.volces.com", we will prepend "https://" before it.

region

public final String region

Region represent the signing region of this endpoint.

Required if endpoint is not provided.

• If region is set, we will take user's input first.
• If not, we will try to load it from environment.
• If still not set, default to cn-beijing.

root

public final String root

root of this backend.

All operations will happen under this root.

default to / if not set.

secretAccessKey

public final String secretAccessKey

secret_access_key of this backend.

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

securityToken

public final String securityToken

security_token of this backend.

This token will expire after sometime, it's recommended to set security_token by hand.

skipSignature

public final Boolean skipSignature

Skip signature will skip loading credentials and signing requests.

Constructor Details

Tos

public Tos()

Method Details

scheme

public String scheme()

Description copied from interface: ServiceConfig

The scheme of the service.

Specified by:

scheme in interface ServiceConfig

Returns:

the scheme

configMap

public Map<String,String> configMap()

Description copied from interface: ServiceConfig

Convert the structured config to a type erased config map.

Specified by:

configMap in interface ServiceConfig

Returns:

the config map