trait Service extends AnyRef
- Alphabetic
- By Inheritance
- Service
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
createBucket(bucketName: String): IO[S3Exception, Unit]
Create a bucket
Create a bucket
- bucketName
name of the bucket
-
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
-
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
-
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
-
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
-
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
-
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
-
abstract
def
isBucketExists(bucketName: String): IO[S3Exception, Boolean]
Check if bucket exists
Check if bucket exists
- bucketName
name of the bucket
-
abstract
val
listBuckets: IO[S3Exception, S3BucketListing]
List all available buckets
- abstract def listObjects(bucketName: String, options: ListObjectOptions): IO[S3Exception, S3ObjectListing]
-
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, minimun size of the data is 5 Mb to use multipartt 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
-
abstract
def
putObject[R](bucketName: String, key: String, contentLength: Long, content: ZStream[R, Throwable, Byte], options: UploadOptions = UploadOptions.default): ZIO[R, S3Exception, Unit]
Store data object into a specific bucket
Store data object into a specific bucket
- bucketName
name of the bucket
- key
unique object identifier
- contentLength
length of the data in bytes
- content
object data
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def listAllObjects(bucketName: String, options: ListObjectOptions): Stream[S3Exception, S3ObjectSummary]
-
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
-
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
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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
-
def
streamLines(bucketName: String, key: String): Stream[S3Exception, String]
Read an object by lines
Read an object by lines
- bucketName
name of the bucket
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()