S3Client

Instance Constructors

new S3Client(s3Settings: S3Settings, system: ActorSystem, mat: Materializer)

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[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def deleteObject(bucket: String, key: String): CompletionStage[Done]

Deletes a S3 Object
Deletes a S3 Object
bucket
the s3 bucket name
key
the s3 object key
returns
A CompletionStage of java.lang.Void
def download(bucket: String, key: String, range: ByteRange, sse: ServerSideEncryption): Pair[Source[ByteString, NotUsed], CompletionStage[ObjectMetadata]]

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 CompletionStage containing the ObjectMetadata
def download(bucket: String, key: String, range: ByteRange): Pair[Source[ByteString, NotUsed], CompletionStage[ObjectMetadata]]

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 CompletionStage containing the ObjectMetadata
def download(bucket: String, key: String, sse: ServerSideEncryption): Pair[Source[ByteString, NotUsed], CompletionStage[ObjectMetadata]]

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 CompletionStage containing the ObjectMetadata
def download(bucket: String, key: String): Pair[Source[ByteString, NotUsed], CompletionStage[ObjectMetadata]]

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 CompletionStage containing the ObjectMetadata
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getObjectMetadata(bucket: String, key: String, sse: ServerSideEncryption): CompletionStage[Optional[ObjectMetadata]]

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 CompletionStage containing an Optional that will be empty in case the object does not exist
def getObjectMetadata(bucket: String, key: String): CompletionStage[Optional[ObjectMetadata]]

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 CompletionStage containing an Optional that will be empty in case the object does not exist
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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/RESTBucketGET.html (version 1 API)
https://docs.aws.amazon.com/AmazonS3/latest/API/v2-RESTBucketGET.html (version 1 API)
def multipartCopy(sourceBucket: String, sourceKey: String, targetBucket: String, targetKey: String): 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
a CompletionStage containing the MultipartUploadResult of the uploaded S3 Object
def multipartCopy(sourceBucket: String, sourceKey: String, targetBucket: String, targetKey: String, s3Headers: S3Headers, sse: ServerSideEncryption): 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
sse
the server side encryption to use
returns
a CompletionStage containing the MultipartUploadResult of the uploaded S3 Object
def multipartCopy(sourceBucket: String, sourceKey: String, targetBucket: String, targetKey: String, contentType: ContentType, s3Headers: S3Headers, sse: ServerSideEncryption): 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
sse
the server side encryption to use
returns
a CompletionStage containing the MultipartUploadResult of the uploaded S3 Object
def multipartCopy(sourceBucket: String, sourceKey: String, targetBucket: String, targetKey: String, sourceVersionId: String, s3Headers: S3Headers, sse: ServerSideEncryption): 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
sse
the server side encryption to use
returns
a CompletionStage containing the MultipartUploadResult of the uploaded S3 Object
def multipartCopy(sourceBucket: String, sourceKey: String, targetBucket: String, targetKey: String, sourceVersionId: String, contentType: ContentType, s3Headers: S3Headers, sse: ServerSideEncryption): 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
sse
the server side encryption to use
returns
a CompletionStage containing the MultipartUploadResult of the uploaded S3 Object
def multipartUpload(bucket: String, key: String, sse: ServerSideEncryption): 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
sse
the server side encryption to use
returns
a Sink that accepts ByteString's and materializes to a CompletionStage of MultipartUploadResult
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
def multipartUpload(bucket: String, key: String, contentType: ContentType, sse: ServerSideEncryption): 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
sse
the server side encryption to use
returns
a Sink that accepts ByteString's and materializes to a CompletionStage of MultipartUploadResult
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
def multipartUpload(bucket: String, key: String, contentType: ContentType, cannedAcl: CannedAcl, sse: ServerSideEncryption): 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
cannedAcl
a CannedAcl, defaults to CannedAcl.Private
sse
the server side encryption to use
returns
a Sink that accepts ByteString's and materializes to a CompletionStage of MultipartUploadResult
def multipartUpload(bucket: String, key: String, contentType: ContentType, cannedAcl: CannedAcl): 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
cannedAcl
a CannedAcl, defaults to CannedAcl.Private
returns
a Sink that accepts ByteString's and materializes to a CompletionStage of MultipartUploadResult
def multipartUpload(bucket: String, key: String, contentType: ContentType, cannedAcl: CannedAcl, metaHeaders: MetaHeaders, sse: ServerSideEncryption): 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
cannedAcl
a CannedAcl, defaults to CannedAcl.Private
metaHeaders
any meta-headers you want to add
sse
sse the server side encryption to use
returns
a Sink that accepts ByteString's and materializes to a CompletionStage of MultipartUploadResult
def multipartUpload(bucket: String, key: String, contentType: ContentType, cannedAcl: CannedAcl, metaHeaders: MetaHeaders): 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
cannedAcl
a CannedAcl, defaults to CannedAcl.Private
metaHeaders
any meta-headers you want to add
returns
a Sink that accepts ByteString's and materializes to a CompletionStage of MultipartUploadResult
def multipartUpload(bucket: String, key: String, contentType: ContentType, s3Headers: S3Headers, sse: ServerSideEncryption): 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
sse
the server side encryption to use
returns
a Sink that accepts ByteString's and materializes to a CompletionStage of MultipartUploadResult
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
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def putObject(bucket: String, key: String, data: Source[ByteString, _], contentLength: Long, sse: ServerSideEncryption): CompletionStage[ObjectMetadata]

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!)
sse
the server side encryption to use
returns
a CompletionStage containing the ObjectMetadata of the uploaded S3 Object
def putObject(bucket: String, key: String, data: Source[ByteString, _], contentLength: Long): CompletionStage[ObjectMetadata]

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 CompletionStage containing the ObjectMetadata of the uploaded S3 Object
def putObject(bucket: String, key: String, data: Source[ByteString, _], contentLength: Long, contentType: ContentType, sse: ServerSideEncryption): CompletionStage[ObjectMetadata]

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
sse
the server side encryption to use
returns
a CompletionStage containing the ObjectMetadata of the uploaded S3 Object
def putObject(bucket: String, key: String, data: Source[ByteString, _], contentLength: Long, contentType: ContentType): CompletionStage[ObjectMetadata]

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 CompletionStage containing the ObjectMetadata of the uploaded S3 Object
def putObject(bucket: String, key: String, data: Source[ByteString, _], contentLength: Long, contentType: ContentType, cannedAcl: CannedAcl, metaHeaders: MetaHeaders, sse: ServerSideEncryption): CompletionStage[ObjectMetadata]

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
cannedAcl
the Acl
metaHeaders
the metadata headers
sse
the server side encryption to use
returns
a CompletionStage containing the ObjectMetadata of the uploaded S3 Object
def putObject(bucket: String, key: String, data: Source[ByteString, _], contentLength: Long, contentType: ContentType, cannedAcl: CannedAcl, metaHeaders: MetaHeaders): CompletionStage[ObjectMetadata]

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
cannedAcl
the Acl
metaHeaders
the metadata headers
returns
ta CompletionStage containing the ObjectMetadata of the uploaded S3 Object
def putObject(bucket: String, key: String, data: Source[ByteString, _], contentLength: Long, contentType: ContentType, s3Headers: S3Headers, sse: ServerSideEncryption): CompletionStage[ObjectMetadata]

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
sse
the server side encryption to use
returns
a CompletionStage containing the ObjectMetadata of the uploaded S3 Object
def putObject(bucket: String, key: String, data: Source[ByteString, _], contentLength: Long, contentType: ContentType, s3Headers: S3Headers): CompletionStage[ObjectMetadata]

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 CompletionStage containing the ObjectMetadata of the uploaded S3 Object
def request(bucket: String, key: String, method: HttpMethod = HttpMethods.GET, s3Headers: S3Headers = S3Headers.empty): CompletionStage[HttpResponse]

Use this to extend the library
Use this to extend the library
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 CompletionStage containing the raw HttpResponse
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( ... )

Related Docs: object S3Client | package javadsl

final class S3Client extends AnyRef

Instance Constructors

new S3Client(s3Settings: S3Settings, system: ActorSystem, mat: Materializer)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def deleteObject(bucket: String, key: String): CompletionStage[Done]

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

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

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

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getObjectMetadata(bucket: String, key: String, sse: ServerSideEncryption): CompletionStage[Optional[ObjectMetadata]]

def getObjectMetadata(bucket: String, key: String): CompletionStage[Optional[ObjectMetadata]]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def listBucket(bucket: String, prefix: Option[String]): Source[ListBucketResultContents, NotUsed]

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

def multipartCopy(sourceBucket: String, sourceKey: String, targetBucket: String, targetKey: String, s3Headers: S3Headers, sse: ServerSideEncryption): CompletionStage[MultipartUploadResult]

def multipartCopy(sourceBucket: String, sourceKey: String, targetBucket: String, targetKey: String, contentType: ContentType, s3Headers: S3Headers, sse: ServerSideEncryption): CompletionStage[MultipartUploadResult]

def multipartCopy(sourceBucket: String, sourceKey: String, targetBucket: String, targetKey: String, sourceVersionId: String, s3Headers: S3Headers, sse: ServerSideEncryption): CompletionStage[MultipartUploadResult]

def multipartCopy(sourceBucket: String, sourceKey: String, targetBucket: String, targetKey: String, sourceVersionId: String, contentType: ContentType, s3Headers: S3Headers, sse: ServerSideEncryption): CompletionStage[MultipartUploadResult]

def multipartUpload(bucket: String, key: String, sse: ServerSideEncryption): Sink[ByteString, CompletionStage[MultipartUploadResult]]

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

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

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

def multipartUpload(bucket: String, key: String, contentType: ContentType, cannedAcl: CannedAcl, sse: ServerSideEncryption): Sink[ByteString, CompletionStage[MultipartUploadResult]]

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

def multipartUpload(bucket: String, key: String, contentType: ContentType, cannedAcl: CannedAcl, metaHeaders: MetaHeaders, sse: ServerSideEncryption): Sink[ByteString, CompletionStage[MultipartUploadResult]]

def multipartUpload(bucket: String, key: String, contentType: ContentType, cannedAcl: CannedAcl, metaHeaders: MetaHeaders): Sink[ByteString, CompletionStage[MultipartUploadResult]]

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

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def putObject(bucket: String, key: String, data: Source[ByteString, _], contentLength: Long, sse: ServerSideEncryption): CompletionStage[ObjectMetadata]

def putObject(bucket: String, key: String, data: Source[ByteString, _], contentLength: Long): CompletionStage[ObjectMetadata]

def putObject(bucket: String, key: String, data: Source[ByteString, _], contentLength: Long, contentType: ContentType, sse: ServerSideEncryption): CompletionStage[ObjectMetadata]

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

def putObject(bucket: String, key: String, data: Source[ByteString, _], contentLength: Long, contentType: ContentType, cannedAcl: CannedAcl, metaHeaders: MetaHeaders, sse: ServerSideEncryption): CompletionStage[ObjectMetadata]

def putObject(bucket: String, key: String, data: Source[ByteString, _], contentLength: Long, contentType: ContentType, cannedAcl: CannedAcl, metaHeaders: MetaHeaders): CompletionStage[ObjectMetadata]

def putObject(bucket: String, key: String, data: Source[ByteString, _], contentLength: Long, contentType: ContentType, s3Headers: S3Headers, sse: ServerSideEncryption): CompletionStage[ObjectMetadata]

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

def request(bucket: String, key: String, method: HttpMethod = HttpMethods.GET, s3Headers: S3Headers = S3Headers.empty): CompletionStage[HttpResponse]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped