- Value parameters:
- bufferSize
– size of the buffer for multipart uploading (used for large streams without size known in advance).
- crtClient
optional instance S3CrtAsyncClient, which is used by S3 Transfer Manager (Requires additional runtime dependency, but may lead to faster uploads/downloads).
- defaultFullMetadata
– return full object metadata on list, requires additional request per object. Metadata returned by default: size, lastModified, eTag, storageClass. This controls behaviour of list method from Store trait. Use listUnderlying to control on per-invocation basis.
- defaultTrailingSlashFiles
- test if folders returned by list are files with trailing slashes in their names. This controls behaviour of list method from Store trait. Use listUnderlying to control on per-invocation basis.
- objectAcl
optional default ACL to apply to all put, move and copy operations.
- s3
S3 Async Client.
- sseAlgorithm
optional default SSE Algorithm to apply to all put, move and copy operations.
- See also:
- Companion:
- object
Value members
Concrete methods
Copies bytes from srcPath to dstPath. Stores should optimize to use native copy functions to avoid data transfer.
Copies bytes from srcPath to dstPath. Stores should optimize to use native copy functions to avoid data transfer.
- Value parameters:
- dst
path
- src
path
- Returns:
F[Unit]
- Definition Classes
- Store
- Value parameters:
- chunkSize
bytes to read in each chunk.
- url
to get
- Returns:
stream of bytes
- Definition Classes
- Store
- Value parameters:
- recursive
when true returned list would contain files at given path and all sub-folders but no folders, otherwise – return files and folder at given path.
- url
to list
- Returns:
stream of Paths. Implementing stores must guarantee that returned Paths have correct values for size, isDir and lastModified.
- Example:
Given Path pointing at folder: folder/a folder/b folder/c folder/sub-folder/d folder/sub-folder/sub-sub-folder/e list(folder, recursive = true) -> [a, b, c, d, e] list(folder, recursive = false) -> [a, b, c, sub-folder]
- Definition Classes
- Store
Moves bytes from srcPath to dstPath. Stores should optimize to use native move functions to avoid data transfer.
Moves bytes from srcPath to dstPath. Stores should optimize to use native move functions to avoid data transfer.
- Value parameters:
- dst
path
- src
path
- Returns:
F[Unit]
- Definition Classes
- Store
- Value parameters:
- overwrite
when true putting to path with pre-existing file would overwrite the content, otherwise – fail with error.
- url
to put
- Returns:
sink of bytes
Writes all data to a sequence of blobs/files, each limited in size to limit.
Writes all data to a sequence of blobs/files, each limited in size to limit.
The computeUrl operation is used to compute the path of the first file and every subsequent file. Typically, the
next file should be determined by analyzing the current state of the filesystem -- e.g., by looking at all files
in a directory and generating a unique name.
- Value parameters:
- computeUrl
operation to compute the url of the first file and all subsequent files.
- limit
maximum size in bytes for each file.
- Returns:
sink of bytes
- Note:
Put of all files uses overwrite semantic, i.e. if path returned by computeUrl already exists content will be overwritten. If that doesn't suit your use case use computeUrl to guard against overwriting existing files.
- Definition Classes
- Store