Packages

object S3

Java API

Factory of S3 operations.

Source
S3.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. S3
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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 checkIfBucketExists(bucketName: String, materializer: Materializer): CompletionStage[BucketAccess]

    Checks whether the bucket exits and user has rights to perform ListBucket operation

    Checks whether the bucket exits and user has rights to perform ListBucket operation

    bucketName

    bucket name

    materializer

    materializer to run with

    returns

    CompletionStage of type BucketAccess

    See also

    https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketHEAD.html

  6. def checkIfBucketExists(bucketName: String, materializer: Materializer, attributes: Attributes): CompletionStage[BucketAccess]

    Checks whether the bucket exists and the user has rights to perform the ListBucket operation

    Checks whether the bucket exists and the user has rights to perform the ListBucket operation

    bucketName

    bucket name

    materializer

    materializer to run with

    attributes

    attributes to run request with

    returns

    CompletionStage of type BucketAccess

    See also

    https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketHEAD.html

  7. def checkIfBucketExistsSource(bucketName: String): Source[BucketAccess, NotUsed]

    Checks whether the bucket exits and user has rights to perform ListBucket operation

    Checks whether the bucket exits and user has rights to perform ListBucket operation

    bucketName

    bucket name

    returns

    Source of type BucketAccess

    See also

    https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketHEAD.html

  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. def deleteBucket(bucketName: String, materializer: Materializer): CompletionStage[Done]

    Delete bucket with a given name

    Delete bucket with a given name

    bucketName

    bucket name

    materializer

    materializer to run with

    returns

    CompletionStage of type Done as API doesn't return any additional information

    See also

    https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketDELETE.html

  10. def deleteBucket(bucketName: String, materializer: Materializer, attributes: Attributes): CompletionStage[Done]

    Delete bucket with a given name

    Delete bucket with a given name

    bucketName

    bucket name

    materializer

    materializer to run with

    attributes

    attributes to run request with

    returns

    CompletionStage of type Done as API doesn't return any additional information

    See also

    https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketDELETE.html

  11. def deleteBucketSource(bucketName: String): Source[Done, NotUsed]

    Delete bucket with a given name

    Delete bucket with a given name

    bucketName

    bucket name

    returns

    Source of type Done as API doesn't return any additional information

    See also

    https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketDELETE.html

  12. def deleteObject(bucket: String, key: String, versionId: Optional[String]): Source[Done, NotUsed]

    Deletes a S3 Object

    Deletes a S3 Object

    bucket

    the s3 bucket name

    key

    the s3 object key

    versionId

    optional version id of the object

    returns

    A Source that will emit java.lang.Void when operation is completed

  13. def deleteObject(bucket: String, key: String): Source[Done, NotUsed]

    Deletes a S3 Object

    Deletes a S3 Object

    bucket

    the s3 bucket name

    key

    the s3 object key

    returns

    A Source that will emit java.lang.Void when operation is completed

  14. def deleteObjectsByPrefix(bucket: String, prefix: Optional[String]): Source[Done, NotUsed]

    Deletes all keys which have the given prefix under the specified bucket

    Deletes all keys which have the given prefix under the specified bucket

    bucket

    the s3 bucket name

    prefix

    optional s3 objects prefix

    returns

    A Source that will emit java.lang.Void when operation is completed

  15. def deleteObjectsByPrefix(bucket: String): Source[Done, NotUsed]

    Deletes all keys under the specified bucket

    Deletes all keys under the specified bucket

    bucket

    the s3 bucket name

    returns

    A Source that will emit java.lang.Void when operation is completed

  16. def download(bucket: String, key: String, range: ByteRange, versionId: Optional[String], sse: ServerSideEncryption): Source[Optional[Pair[Source[ByteString, NotUsed], ObjectMetadata]], NotUsed]

    Downloads a specific byte range of a S3 Object

    Downloads a specific byte range of a S3 Object

    bucket

    the s3 bucket name

    key

    the s3 object key

    range

    the ByteRange you want to download

    versionId

    optional version id of the object

    sse

    the server side encryption to use

    returns

    A akka.japi.Pair with a Source of ByteString, and a Source containing the ObjectMetadata

  17. def download(bucket: String, key: String, range: ByteRange, sse: ServerSideEncryption): Source[Optional[Pair[Source[ByteString, NotUsed], ObjectMetadata]], NotUsed]

    Downloads a specific byte range of a S3 Object

    Downloads a specific byte range of a S3 Object

    bucket

    the s3 bucket name

    key

    the s3 object key

    range

    the ByteRange you want to download

    sse

    the server side encryption to use

    returns

    A akka.japi.Pair with a Source of ByteString, and a Source containing the ObjectMetadata

  18. def download(bucket: String, key: String, range: ByteRange): Source[Optional[Pair[Source[ByteString, NotUsed], ObjectMetadata]], NotUsed]

    Downloads a specific byte range of a S3 Object

    Downloads a specific byte range of a S3 Object

    bucket

    the s3 bucket name

    key

    the s3 object key

    range

    the ByteRange you want to download

    returns

    A akka.japi.Pair with a Source of ByteString, and a Source containing the ObjectMetadata

  19. def download(bucket: String, key: String, sse: ServerSideEncryption): Source[Optional[Pair[Source[ByteString, NotUsed], ObjectMetadata]], NotUsed]

    Downloads a S3 Object

    Downloads a S3 Object

    bucket

    the s3 bucket name

    key

    the s3 object key

    sse

    the server side encryption to use

    returns

    A akka.japi.Pair with a Source of ByteString, and a Source containing the ObjectMetadata

  20. def download(bucket: String, key: String): Source[Optional[Pair[Source[ByteString, NotUsed], ObjectMetadata]], NotUsed]

    Downloads a S3 Object

    Downloads a S3 Object

    bucket

    the s3 bucket name

    key

    the s3 object key

    returns

    A akka.japi.Pair with a Source of ByteString, and a Source containing the ObjectMetadata

  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  23. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. def getObjectMetadata(bucket: String, key: String, versionId: Optional[String], sse: ServerSideEncryption): Source[Optional[ObjectMetadata], NotUsed]

    Gets the metadata for a S3 Object

    Gets the metadata for a S3 Object

    bucket

    the s3 bucket name

    key

    the s3 object key

    versionId

    optional versionId of source object

    sse

    the server side encryption to use

    returns

    A Source containing an Optional that will be empty in case the object does not exist

  26. def getObjectMetadata(bucket: String, key: String, sse: ServerSideEncryption): Source[Optional[ObjectMetadata], NotUsed]

    Gets the metadata for a S3 Object

    Gets the metadata for a S3 Object

    bucket

    the s3 bucket name

    key

    the s3 object key

    sse

    the server side encryption to use

    returns

    A Source containing an Optional that will be empty in case the object does not exist

  27. def getObjectMetadata(bucket: String, key: String): Source[Optional[ObjectMetadata], NotUsed]

    Gets the metadata for a S3 Object

    Gets the metadata for a S3 Object

    bucket

    the s3 bucket name

    key

    the s3 object key

    returns

    A Source containing an Optional that will be empty in case the object does not exist

  28. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. def listBucket(bucket: String, prefix: Option[String]): Source[ListBucketResultContents, NotUsed]

    Will return a source of object metadata for a given bucket with optional prefix using version 2 of the List Bucket API.

    Will return a source of object metadata for a given bucket with optional prefix using version 2 of the List Bucket API. This will automatically page through all keys with the given parameters.

    The akka.stream.alpakka.s3.list-bucket-api-version can be set to 1 to use the older API version 1

    bucket

    Which bucket that you list object metadata for

    prefix

    Prefix of the keys you want to list under passed bucket

    returns

    Source of object metadata

    See also

    https://docs.aws.amazon.com/AmazonS3/latest/API/v2-RESTBucketGET.html (version 1 API)

    https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGET.html (version 1 API)

  31. def makeBucket(bucketName: String, materializer: Materializer): CompletionStage[Done]

    Create new bucket with a given name

    Create new bucket with a given name

    bucketName

    bucket name

    materializer

    materializer to run with

    returns

    CompletionStage of type Done as API doesn't return any additional information

    See also

    https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUT.html

  32. def makeBucket(bucketName: String, materializer: Materializer, attributes: Attributes): CompletionStage[Done]

    Create new bucket with a given name

    Create new bucket with a given name

    bucketName

    bucket name

    materializer

    materializer to run with

    attributes

    attributes to run request with

    returns

    CompletionStage of type Done as API doesn't return any additional information

    See also

    https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUT.html

  33. def makeBucketSource(bucketName: String): Source[Done, NotUsed]

    Create new bucket with a given name

    Create new bucket with a given name

    bucketName

    bucket name

    returns

    Source of type Done as API doesn't return any additional information

    See also

    https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUT.html

  34. def multipartCopy(sourceBucket: String, sourceKey: String, targetBucket: String, targetKey: String): RunnableGraph[CompletionStage[MultipartUploadResult]]

    Copy a S3 Object by making multiple requests.

    Copy a S3 Object by making multiple requests.

    sourceBucket

    the source s3 bucket name

    sourceKey

    the source s3 key

    targetBucket

    the target s3 bucket name

    targetKey

    the target s3 key

    returns

    the MultipartUploadResult of the uploaded S3 Object

  35. def multipartCopy(sourceBucket: String, sourceKey: String, targetBucket: String, targetKey: String, s3Headers: S3Headers): RunnableGraph[CompletionStage[MultipartUploadResult]]

    Copy a S3 Object by making multiple requests.

    Copy a S3 Object by making multiple requests.

    sourceBucket

    the source s3 bucket name

    sourceKey

    the source s3 key

    targetBucket

    the target s3 bucket name

    targetKey

    the target s3 key

    s3Headers

    any headers you want to add

    returns

    the MultipartUploadResult of the uploaded S3 Object

  36. def multipartCopy(sourceBucket: String, sourceKey: String, targetBucket: String, targetKey: String, contentType: ContentType, s3Headers: S3Headers): RunnableGraph[CompletionStage[MultipartUploadResult]]

    Copy a S3 Object by making multiple requests.

    Copy a S3 Object by making multiple requests.

    sourceBucket

    the source s3 bucket name

    sourceKey

    the source s3 key

    targetBucket

    the target s3 bucket name

    targetKey

    the target s3 key

    contentType

    an optional ContentType

    s3Headers

    any headers you want to add

    returns

    the MultipartUploadResult of the uploaded S3 Object

  37. def multipartCopy(sourceBucket: String, sourceKey: String, targetBucket: String, targetKey: String, sourceVersionId: Optional[String], s3Headers: S3Headers): RunnableGraph[CompletionStage[MultipartUploadResult]]

    Copy a S3 Object by making multiple requests.

    Copy a S3 Object by making multiple requests.

    sourceBucket

    the source s3 bucket name

    sourceKey

    the source s3 key

    targetBucket

    the target s3 bucket name

    targetKey

    the target s3 key

    sourceVersionId

    version id of source object, if the versioning is enabled in source bucket

    s3Headers

    any headers you want to add

    returns

    the MultipartUploadResult of the uploaded S3 Object

  38. def multipartCopy(sourceBucket: String, sourceKey: String, targetBucket: String, targetKey: String, sourceVersionId: Optional[String], contentType: ContentType, s3Headers: S3Headers): RunnableGraph[CompletionStage[MultipartUploadResult]]

    Copy a S3 Object by making multiple requests.

    Copy a S3 Object by making multiple requests.

    sourceBucket

    the source s3 bucket name

    sourceKey

    the source s3 key

    targetBucket

    the target s3 bucket name

    targetKey

    the target s3 key

    sourceVersionId

    version id of source object, if the versioning is enabled in source bucket

    contentType

    an optional ContentType

    s3Headers

    any headers you want to add

    returns

    the MultipartUploadResult of the uploaded S3 Object

  39. def multipartUpload(bucket: String, key: String): Sink[ByteString, CompletionStage[MultipartUploadResult]]

    Uploads a S3 Object by making multiple requests

    Uploads a S3 Object by making multiple requests

    bucket

    the s3 bucket name

    key

    the s3 object key

    returns

    a Sink that accepts ByteString's and materializes to a CompletionStage of MultipartUploadResult

  40. def multipartUpload(bucket: String, key: String, contentType: ContentType): Sink[ByteString, CompletionStage[MultipartUploadResult]]

    Uploads a S3 Object by making multiple requests

    Uploads a S3 Object by making multiple requests

    bucket

    the s3 bucket name

    key

    the s3 object key

    contentType

    an optional ContentType

    returns

    a Sink that accepts ByteString's and materializes to a CompletionStage of MultipartUploadResult

  41. def multipartUpload(bucket: String, key: String, contentType: ContentType, s3Headers: S3Headers): Sink[ByteString, CompletionStage[MultipartUploadResult]]

    Uploads a S3 Object by making multiple requests

    Uploads a S3 Object by making multiple requests

    bucket

    the s3 bucket name

    key

    the s3 object key

    contentType

    an optional ContentType

    s3Headers

    any headers you want to add

    returns

    a Sink that accepts ByteString's and materializes to a CompletionStage of MultipartUploadResult

  42. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  43. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  44. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  45. def putObject(bucket: String, key: String, data: Source[ByteString, _], contentLength: Long): Source[ObjectMetadata, NotUsed]

    Uploads a S3 Object, use this for small files and multipartUpload for bigger ones

    Uploads a S3 Object, use this for small files and multipartUpload for bigger ones

    bucket

    the s3 bucket name

    key

    the s3 object key

    data

    a Source of ByteString

    contentLength

    the number of bytes that will be uploaded (required!)

    returns

    a Source containing the ObjectMetadata of the uploaded S3 Object

  46. def putObject(bucket: String, key: String, data: Source[ByteString, _], contentLength: Long, contentType: ContentType): Source[ObjectMetadata, NotUsed]

    Uploads a S3 Object, use this for small files and multipartUpload for bigger ones

    Uploads a S3 Object, use this for small files and multipartUpload for bigger ones

    bucket

    the s3 bucket name

    key

    the s3 object key

    data

    a Source of ByteString

    contentLength

    the number of bytes that will be uploaded (required!)

    contentType

    an optional ContentType

    returns

    a Source containing the ObjectMetadata of the uploaded S3 Object

  47. def putObject(bucket: String, key: String, data: Source[ByteString, _], contentLength: Long, contentType: ContentType, s3Headers: S3Headers): Source[ObjectMetadata, NotUsed]

    Uploads a S3 Object, use this for small files and multipartUpload for bigger ones

    Uploads a S3 Object, use this for small files and multipartUpload for bigger ones

    bucket

    the s3 bucket name

    key

    the s3 object key

    data

    a Source of ByteString

    contentLength

    the number of bytes that will be uploaded (required!)

    contentType

    an optional ContentType

    s3Headers

    any additional headers for the request

    returns

    a Source containing the ObjectMetadata of the uploaded S3 Object

  48. def request(bucket: String, key: String, versionId: Optional[String], method: HttpMethod = HttpMethods.GET, s3Headers: S3Headers = S3Headers()): Source[HttpResponse, NotUsed]

    Use this for a low level access to S3.

    Use this for a low level access to S3.

    bucket

    the s3 bucket name

    key

    the s3 object key

    versionId

    optional versionId of source object

    method

    the HttpMethod to use when making the request

    s3Headers

    any headers you want to add

    returns

    a raw HTTP response from S3

  49. def request(bucket: String, key: String, method: HttpMethod, s3Headers: S3Headers): Source[HttpResponse, NotUsed]

    Use this for a low level access to S3.

    Use this for a low level access to S3.

    bucket

    the s3 bucket name

    key

    the s3 object key

    method

    the HttpMethod to use when making the request

    s3Headers

    any headers you want to add

    returns

    a raw HTTP response from S3

  50. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  51. def toString(): String
    Definition Classes
    AnyRef → Any
  52. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped