Class ServiceConfig.Foyer

java.lang.Object

org.apache.opendal.ServiceConfig.Foyer

All Implemented Interfaces:

ServiceConfig

Enclosing interface:

ServiceConfig

public static class ServiceConfig.Foyer
extends Object
implements ServiceConfig

Configuration for service foyer.

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 Long	diskCapacity	Disk cache total capacity in bytes.
final Long	diskFileSize	Individual cache file size in bytes.
final String	diskPath	Disk cache directory path.
final Long	memory	Memory capacity in bytes for the cache.
final String	name	Name for this cache instance.
final String	recoverMode	Recovery mode when starting the cache.
final String	root	Root path of this backend.
final Long	shards	Number of shards for concurrent access.

Constructor Summary

Constructors

Constructor	Description
Foyer()

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

diskCapacity

public final Long diskCapacity

Disk cache total capacity in bytes. Only used when disk_path is set.

diskFileSize

public final Long diskFileSize

Individual cache file size in bytes.

Default is 1 MiB. Only used when disk_path is set.

diskPath

public final String diskPath

Disk cache directory path.

If set, enables hybrid cache with disk storage. Data will be persisted to this directory when memory cache is full.

memory

public final Long memory

Memory capacity in bytes for the cache.

name

public final String name

Name for this cache instance.

recoverMode

public final String recoverMode

Recovery mode when starting the cache.

Valid values: "none" (default), "quiet", "strict".

• "none": Don't recover from disk
• "quiet": Recover and skip errors
• "strict": Recover and panic on errors

root

public final String root

Root path of this backend.

shards

public final Long shards

Number of shards for concurrent access.

Default is 1. Higher values improve concurrency but increase overhead.

Constructor Details

Foyer

public Foyer()

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