xtdb-aws/xtdb.aws/S3/Factory

Factory

@Serializable

@SerialName(value = "!S3")

data class Factory(var region: String? = null, val bucket: String, var prefix: Path? = null, var credentials: S3.Companion.BasicCredentials? = null, var endpoint: String? = null, var pathStyleAccessEnabled: Boolean = false, var s3Configurator: S3Configurator = S3Configurator.Default, var coroutineContext: CoroutineContext = Dispatchers.IO) : ObjectStore.Factory

Constructors

constructor(region: String? = null, bucket: String, prefix: Path? = null, credentials: S3.Companion.BasicCredentials? = null, endpoint: String? = null, pathStyleAccessEnabled: Boolean = false, s3Configurator: S3Configurator = S3Configurator.Default, coroutineContext: CoroutineContext = Dispatchers.IO)

Properties

val bucket: String

open override val configProto: Any?

coroutineContext

@Transient

var coroutineContext: CoroutineContext

var credentials: S3.Companion.BasicCredentials?

var endpoint: String?

pathStyleAccessEnabled

var pathStyleAccessEnabled: Boolean

@Serializable(with = PathSerde::class)

var prefix: Path?

var region: String?

@Transient

var s3Configurator: S3Configurator

Functions

coroutineContext

fun coroutineContext(coroutineContext: CoroutineContext): S3.Factory

fun credentials(accessKey: String, secretKey: String): S3.Factory

fun endpoint(endpoint: String): S3.Factory

openObjectStore

open override fun openObjectStore(storageRoot: Path, remotes: Map<RemoteAlias, Remote>): S3

pathStyleAccessEnabled

fun pathStyleAccessEnabled(enabled: Boolean): S3.Factory

fun prefix(prefix: Path): S3.Factory

fun region(region: String): S3.Factory

fun region(region: Region): S3.Factory

fun s3Configurator(s3Configurator: S3Configurator): S3.Factory