p

zio

s3

package s3

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. s3
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final case class ConnectionError(message: String, cause: Throwable) extends S3Exception with Product with Serializable
  2. final case class InvalidCredentials(message: String) extends S3Exception with Product with Serializable
  3. final case class InvalidPartSize(message: String, size: Int) extends S3Exception with Product with Serializable
  4. final case class InvalidSettings(message: String) extends S3Exception with Product with Serializable
  5. final case class ListObjectOptions(prefix: Option[String], maxKeys: Long, delimiter: Option[String], starAfter: Option[String]) extends Product with Serializable

    The options of the listing object inside a bucket.

    The options of the listing object inside a bucket.

    prefix

    filter all object identifier which start with this prefix

    maxKeys

    max total number of objects, default value is 1000 elements

    delimiter

    A delimiter is a character you use to group keys, default value is empty

    starAfter

    Starts listing after this specified key. StartAfter can be any key in the bucket, default value is empty

  6. final class Live extends Service

    Service use to wrap the unsafe amazon s3 client and access safely to s3 storage

  7. final case class MultipartUploadOptions(uploadOptions: UploadOptions, partSize: Int) extends Product with Serializable

    The upload options that are specific to multipart uploads

    The upload options that are specific to multipart uploads

    uploadOptions

    UploadOptions

    partSize

    the size of the part in bytes, the minimum is 5 MB

  8. final case class ObjectMetadata(metadata: Map[String, String], contentType: String, contentLength: Long) extends Product with Serializable

    metadata

    the user-defined metadata without the "x-amz-meta-" prefix

    contentType

    the content type of the object (application/json, application/zip, text/plain, ...)

    contentLength

    the size of the object in bytes

  9. type S3 = Has[Service]
  10. final case class S3Bucket(name: String, creationDate: Instant) extends Product with Serializable
  11. final case class S3ObjectListing(bucketName: String, delimiter: Option[String], starAfter: Option[String], objectSummaries: Chunk[S3ObjectSummary], nextContinuationToken: Option[String], prefix: Option[String]) extends Product with Serializable
  12. final case class S3ObjectSummary(bucketName: String, key: String, lastModified: Instant, size: Long) extends Product with Serializable
  13. final case class S3Region(region: Region) extends Product with Serializable
  14. final case class S3Settings(s3Region: S3Region, credentials: AwsCredentials) extends Product with Serializable
  15. type S3Stream[A] = ZStream[S3, S3Exception, A]
  16. final case class SdkError(error: SdkException) extends S3Exception with Product with Serializable
  17. type Settings = Has[S3Settings]
  18. final case class UploadOptions(metadata: Map[String, String], cannedAcl: ObjectCannedACL, contentType: Option[String]) extends Product with Serializable

    The options of the multipart upload and the put object request.

    The options of the multipart upload and the put object request.

    metadata

    the user-defined metadata without the "x-amz-meta-" prefix

    cannedAcl

    a canned acl, defaults to "private"

    contentType

    the content type of the object (application/json, application/zip, text/plain, ...)

Value Members

  1. def createBucket(bucketName: String): ZIO[S3, S3Exception, Unit]
  2. def deleteBucket(bucketName: String): ZIO[S3, S3Exception, Unit]
  3. def deleteObject(bucketName: String, key: String): ZIO[S3, S3Exception, Unit]
  4. def execute[T](f: (S3AsyncClient) ⇒ CompletableFuture[T]): ZIO[S3, S3Exception, T]
  5. def getNextObjects(listing: S3ObjectListing): ZIO[S3, S3Exception, S3ObjectListing]
  6. def getObject(bucketName: String, key: String): ZStream[S3, S3Exception, Byte]
  7. def getObjectMetadata(bucketName: String, key: String): ZIO[S3, S3Exception, ObjectMetadata]
  8. def isBucketExists(bucketName: String): ZIO[S3, S3Exception, Boolean]
  9. def listAllObjects(bucketName: String, options: ListObjectOptions): S3Stream[S3ObjectSummary]
  10. def listAllObjects(bucketName: String): S3Stream[S3ObjectSummary]
  11. val listBuckets: ZIO[S3, S3Exception, S3BucketListing]
  12. def listObjects(bucketName: String, options: ListObjectOptions): ZIO[S3, S3Exception, S3ObjectListing]
  13. def listObjects(bucketName: String): ZIO[S3, S3Exception, S3ObjectListing]

    Same as listObjects with default values for an empty prefix and sets the maximum number of object max to 1000

    Same as listObjects with default values for an empty prefix and sets the maximum number of object max to 1000

    bucketName

    name of the bucket

  14. def live(region: Region, credentials: AwsCredentials, uriEndpoint: Option[URI] = None): Layer[S3Exception, S3]
  15. val live: ZLayer[Settings, ConnectionError, S3]
  16. def liveM[R](region: Region, provider: RManaged[R, AwsCredentialsProvider], uriEndpoint: Option[URI] = None): ZLayer[R, S3Exception, S3]
  17. def multipartUpload[R](bucketName: String, key: String, content: ZStream[R, Throwable, Byte], options: MultipartUploadOptions = MultipartUploadOptions.default)(parallelism: Int): ZIO[S3 with R, S3Exception, Unit]

    Same as multipartUpload with default parallelism = 1

    Same as multipartUpload with default parallelism = 1

    bucketName

    name of the bucket

    key

    unique object identifier

    content

    object data

    options

    the optional configurations of the multipart upload

  18. def paginate(initialListing: S3ObjectListing): S3Stream[S3ObjectListing]
  19. def putObject[R](bucketName: String, key: String, contentLength: Long, content: ZStream[R, Throwable, Byte], options: UploadOptions = UploadOptions.default): ZIO[S3 with R, S3Exception, Unit]
  20. def settings[R](region: Region, cred: ZIO[R, S3Exception, AwsCredentials]): ZLayer[R, S3Exception, Settings]
  21. def streamLines(bucketName: String, key: String): S3Stream[String]
  22. def stub(path: Path): ZLayer[Blocking, Nothing, S3]
  23. object BuildInfo extends Product with Serializable

    This object was generated by sbt-buildinfo.

  24. object ListObjectOptions extends Serializable
  25. object Live
  26. object MaxKeys
  27. object MultipartUploadOptions extends Serializable
  28. object ObjectMetadata extends Serializable
  29. object PartSize
  30. object S3

    The S3 module provides access to a s3 amazon storage.

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

  31. object S3Bucket extends Serializable
  32. object S3ObjectListing extends Serializable
  33. object S3Region extends Serializable
  34. object S3Settings extends Serializable
  35. object Test

    Stub Service which is back by a filesystem storage

  36. object UploadOptions extends Serializable
  37. object providers

Inherited from AnyRef

Inherited from Any

Ungrouped