trait S3 extends AnyRef

The S3 module provides access to a s3 amazon storage. All operations are async since we are relying on the amazon async client

Self Type
S3
Linear Supertypes
AnyRef, Any
Known Subclasses
Live
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. S3
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def createBucket(bucketName: String): IO[S3Exception, Unit]

    Create a bucket

    Create a bucket

    bucketName

    name of the bucket

  2. abstract def deleteBucket(bucketName: String): IO[S3Exception, Unit]

    Delete bucket, the operation fail if bucket is not present

    Delete bucket, the operation fail if bucket is not present

    bucketName

    name of the bucket

  3. abstract def deleteObject(bucketName: String, key: String): IO[S3Exception, Unit]

    delete an object from a bucket, if not present it will succeed

    delete an object from a bucket, if not present it will succeed

    bucketName

    name of the bucket

    key

    object identifier to remove

  4. abstract def execute[T](f: (S3AsyncClient) => CompletableFuture[T]): IO[S3Exception, T]

    * expose safely amazon s3 async client

    * expose safely amazon s3 async client

    T

    value type to return

    f

    call any operations on s3 async client

  5. abstract def getNextObjects(listing: S3ObjectListing): IO[S3Exception, S3ObjectListing]

    Fetch the next object listing from a specific object listing.

    Fetch the next object listing from a specific object listing.

    listing

    listing to use as a start

  6. abstract def getObject(bucketName: String, key: String): Stream[S3Exception, Byte]

    Read an object from a bucket, the operation fail if object is not present

    Read an object from a bucket, the operation fail if object is not present

    bucketName

    name of the bucket

    key

    object identifier to read

  7. abstract def getObjectMetadata(bucketName: String, key: String): IO[S3Exception, ObjectMetadata]

    Retrieves metadata from an object without returning the object itself.

    Retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata.

    bucketName

    name of the bucket

    key

    object identifier to read

    returns

    the ObjectMetadata

  8. abstract def isBucketExists(bucketName: String): IO[S3Exception, Boolean]

    Check if bucket exists

    Check if bucket exists

    bucketName

    name of the bucket

  9. abstract val listBuckets: IO[S3Exception, S3BucketListing]

    List all available buckets

  10. abstract def listObjects(bucketName: String, options: ListObjectOptions): IO[S3Exception, S3ObjectListing]
  11. abstract def multipartUpload[R](bucketName: String, key: String, content: ZStream[R, Throwable, Byte], options: MultipartUploadOptions = MultipartUploadOptions.default)(parallelism: Int): ZIO[R, S3Exception, Unit]

    *

    *

    Store data object into a specific bucket, minimum size of the data is 5 Mb to use multipart upload (restriction from amazon API)

    bucketName

    name of the bucket

    key

    unique object identifier

    content

    object data

    options

    the optional configurations of the multipart upload

    parallelism

    the number of parallel requests to upload chunks

  12. abstract def putObject[R](bucketName: String, key: String, contentLength: Long, content: ZStream[R, Throwable, Byte], options: UploadOptions = UploadOptions.default, contentMD5: Option[String] = None): ZIO[R, S3Exception, Unit]

    Store data object into a specific bucket

    Store data object into a specific bucket

    Example of creating a contentMD5 option

    The md5 option is required when the target bucket is configured with object locking, otherwise the AWS S3 API will not accept the putObject request.

    import software.amazon.awssdk.utils.Md5Utils
import scala.util.Random

val bytes  = Random.nextString(65536).getBytes()
val contentMD5 = Some(Md5Utils.md5AsBase64(bytes))
    bucketName

    name of the bucket

    key

    unique object identifier

    contentLength

    length of the data in bytes

    content

    object data

    contentMD5

    a String Option containing the MD5 hash of the content encoded as base64

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def listAllObjects(bucketName: String, options: ListObjectOptions): Stream[S3Exception, S3ObjectSummary]
  13. def listAllObjects(bucketName: String): Stream[S3Exception, S3ObjectSummary]

    List all descendant objects of a bucket Fetch all objects recursively of all nested directory by traversing all of them

    List all descendant objects of a bucket Fetch all objects recursively of all nested directory by traversing all of them

    bucketName

    name of the bucket MaxKeys have a default value to 1000 elements

  14. def listObjects(bucketName: String): IO[S3Exception, S3ObjectListing]

    list all object for a specific bucket

    list all object for a specific bucket

    bucketName

    name of the bucket

  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def paginate(initialListing: S3ObjectListing): Stream[S3Exception, S3ObjectListing]

    List all objects by traversing all nested directories

    List all objects by traversing all nested directories

    initialListing

    object listing to start with

  19. def streamLines(bucketName: String, key: String): Stream[S3Exception, String]

    Read an object by lines

    Read an object by lines

    bucketName

    name of the bucket

  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped