Package org.apache.opendal

Class ServiceConfig.Oss

java.lang.Object

org.apache.opendal.ServiceConfig.Oss

All Implemented Interfaces:

ServiceConfig

Enclosing interface:

ServiceConfig

public static class ServiceConfig.Oss
extends Object
implements ServiceConfig

Configuration for service oss.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.opendal.ServiceConfig

ServiceConfig.AliyunDrive, ServiceConfig.Alluxio, ServiceConfig.Atomicserver, ServiceConfig.Azblob, ServiceConfig.Azdls, ServiceConfig.Azfile, ServiceConfig.B2, ServiceConfig.Cacache, ServiceConfig.Chainsafe, ServiceConfig.CloudflareKv, ServiceConfig.Compfs, ServiceConfig.Cos, ServiceConfig.D1, ServiceConfig.Dashmap, ServiceConfig.Dbfs, ServiceConfig.Dropbox, ServiceConfig.Etcd, ServiceConfig.Fs, ServiceConfig.Gcs, ServiceConfig.Gdrive, ServiceConfig.Ghac, ServiceConfig.Github, ServiceConfig.Gridfs, ServiceConfig.HdfsNative, ServiceConfig.Http, ServiceConfig.Huggingface, ServiceConfig.Icloud, ServiceConfig.Ipfs, ServiceConfig.Ipmfs, ServiceConfig.Koofr, ServiceConfig.Lakefs, ServiceConfig.Libsql, ServiceConfig.Memcached, ServiceConfig.Memory, ServiceConfig.MiniMoka, ServiceConfig.Moka, ServiceConfig.Mongodb, ServiceConfig.Monoiofs, ServiceConfig.Mysql, ServiceConfig.NebulaGraph, ServiceConfig.Obs, ServiceConfig.Onedrive, ServiceConfig.Oss, ServiceConfig.Pcloud, ServiceConfig.Persy, ServiceConfig.Postgresql, ServiceConfig.Redb, ServiceConfig.Redis, ServiceConfig.S3, ServiceConfig.Seafile, ServiceConfig.Sftp, ServiceConfig.Sled, ServiceConfig.Sqlite, ServiceConfig.Supabase, ServiceConfig.Surrealdb, ServiceConfig.Swift, 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 for oss.
final String	accessKeySecret	Access key secret for oss.
final Boolean	allowAnonymous	Allow anonymous for oss.
final Long	batchMaxOperations	Deprecated. Please use `delete_max_size` instead of `batch_max_operations`
final @NonNull String	bucket	Bucket for oss.
final Long	deleteMaxSize	The size of max delete operations.
final Boolean	enableVersioning	is bucket versioning enabled for this bucket
final String	endpoint	Endpoint for oss.
final String	oidcProviderArn	oidc_provider_arn will be loaded from
final String	oidcTokenFile	oidc_token_file will be loaded from
final String	presignEndpoint	Presign endpoint for oss.
final String	roleArn	If role_arn is set, we will use already known config as source credential to assume role with role_arn.
final String	roleSessionName	role_session_name for this backend.
final String	root	Root for oss.
final String	serverSideEncryption	Server side encryption for oss.
final String	serverSideEncryptionKeyId	Server side encryption key id for oss.
final String	stsEndpoint	sts_endpoint will be loaded from

Constructor Summary

Constructors

Constructor	Description
Oss()

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 java.lang.Object

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

Field Details

bucket

@NonNull
public final @NonNull String bucket

Bucket for oss.

root

public final String root

Root for oss.

endpoint

public final String endpoint

Endpoint for oss.

presignEndpoint

public final String presignEndpoint

Presign endpoint for oss.

enableVersioning

public final Boolean enableVersioning

is bucket versioning enabled for this bucket

serverSideEncryption

public final String serverSideEncryption

Server side encryption for oss.

serverSideEncryptionKeyId

public final String serverSideEncryptionKeyId

Server side encryption key id for oss.

allowAnonymous

public final Boolean allowAnonymous

Allow anonymous for oss.

accessKeyId

public final String accessKeyId

Access key id for oss.

accessKeySecret

public final String accessKeySecret

Access key secret for oss.

batchMaxOperations

public final Long batchMaxOperations

Deprecated.

Please use `delete_max_size` instead of `batch_max_operations`

The size of max batch operations.

deleteMaxSize

public final Long deleteMaxSize

The size of max delete operations.

roleArn

public final String roleArn

If role_arn is set, we will use already known config as source credential to assume role with role_arn.

roleSessionName

public final String roleSessionName

role_session_name for this backend.

oidcProviderArn

public final String oidcProviderArn

oidc_provider_arn will be loaded from

• this field if it's is_some
• env value: [ALIBABA_CLOUD_OIDC_PROVIDER_ARN]

oidcTokenFile

public final String oidcTokenFile

oidc_token_file will be loaded from

• this field if it's is_some
• env value: [ALIBABA_CLOUD_OIDC_TOKEN_FILE]

stsEndpoint

public final String stsEndpoint

sts_endpoint will be loaded from

• this field if it's is_some
• env value: [ALIBABA_CLOUD_STS_ENDPOINT]

Constructor Details

Oss

public Oss()

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