object S3
- Alphabetic
- By Inheritance
- S3
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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
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/API_HeadBucket.html
-
def
checkIfBucketExists(bucketName: String, materializer: Materializer, attributes: Attributes, s3Headers: S3Headers): CompletionStage[BucketAccess]
Checks whether the bucket exists and the user has rights to perform the
ListBucketoperationChecks whether the bucket exists and the user has rights to perform the
ListBucketoperation- bucketName
bucket name
- materializer
materializer to run with
- attributes
attributes to run request with
- s3Headers
any headers you want to add
- returns
CompletionStage of type BucketAccess
- See also
https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html
-
def
checkIfBucketExists(bucketName: String, materializer: Materializer, attributes: Attributes): CompletionStage[BucketAccess]
Checks whether the bucket exists and the user has rights to perform the
ListBucketoperationChecks whether the bucket exists and the user has rights to perform the
ListBucketoperation- 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/API_HeadBucket.html
-
def
checkIfBucketExistsSource(bucketName: String, s3Headers: S3Headers): 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
- s3Headers
any headers you want to add
- returns
Source of type BucketAccess
- See also
https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html
-
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/API_HeadBucket.html
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
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/API_DeleteBucket.html
-
def
deleteBucket(bucketName: String, materializer: Materializer, attributes: Attributes, s3Headers: S3Headers): 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
- s3Headers
any headers you want to add
- returns
CompletionStage of type Done as API doesn't return any additional information
- See also
https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html
-
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/API_DeleteBucket.html
-
def
deleteBucketContents(bucket: String): Source[Done, NotUsed]
Deletes all S3 Objects within the given bucket
Deletes all S3 Objects within the given bucket
- bucket
the s3 bucket name
- returns
A Source that will emit java.lang.Void when operation is completed
-
def
deleteBucketSource(bucketName: String, s3Headers: S3Headers): Source[Done, NotUsed]
Delete bucket with a given name
-
def
deleteBucketSource(bucketName: String): Source[Done, NotUsed]
Delete bucket with a given name
-
def
deleteObject(bucket: String, key: String, versionId: Optional[String], s3Headers: S3Headers): 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
- s3Headers
any headers you want to add
- returns
A Source that will emit java.lang.Void when operation is completed
-
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
-
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
-
def
deleteObjectsByPrefix(bucket: String, prefix: Optional[String], s3Headers: S3Headers): 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
- s3Headers
any headers you want to add
- returns
A Source that will emit java.lang.Void when operation is completed
-
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
-
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
-
def
download(bucket: String, key: String, range: ByteRange, versionId: Optional[String], s3Headers: S3Headers): 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
- s3Headers
any headers you want to add
- returns
A akka.japi.Pair with a Source of ByteString, and a Source containing the ObjectMetadata
-
def
download(bucket: String, key: String, range: ByteRange, s3Headers: S3Headers): 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
- s3Headers
any headers you want to add
- returns
A akka.japi.Pair with a Source of ByteString, and a Source containing the ObjectMetadata
-
def
download(bucket: String, key: String, s3Headers: S3Headers): 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
- s3Headers
any headers you want to add
- returns
A akka.japi.Pair with a Source of ByteString, and a Source containing the ObjectMetadata
-
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
-
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
-
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
-
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
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getObjectMetadata(bucket: String, key: String, s3Headers: S3Headers): Source[Optional[ObjectMetadata], NotUsed]
Gets the metadata for a S3 Object
-
def
getObjectMetadata(bucket: String, key: String, versionId: Optional[String], sse: ServerSideEncryption): Source[Optional[ObjectMetadata], NotUsed]
Gets the metadata for a S3 Object
-
def
getObjectMetadata(bucket: String, key: String, sse: ServerSideEncryption): Source[Optional[ObjectMetadata], NotUsed]
Gets the metadata for a S3 Object
-
def
getObjectMetadata(bucket: String, key: String): Source[Optional[ObjectMetadata], NotUsed]
Gets the metadata for a S3 Object
-
def
getObjectMetadataWithHeaders(bucket: String, key: String, versionId: Optional[String], s3Headers: S3Headers): Source[Optional[ObjectMetadata], NotUsed]
Gets the metadata for a S3 Object
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
listBucket(bucket: String, delimiter: String, prefix: Optional[String], s3Headers: S3Headers): Source[ListBucketResultContents, NotUsed]
Will return a source of object metadata for a given bucket with delimiter and optional prefix using version 2 of the List Bucket API.
Will return a source of object metadata for a given bucket with delimiter and 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-versioncan be set to 1 to use the older API version 1- bucket
Which bucket that you list object metadata for
- delimiter
Delimiter to use for listing only one level of hierarchy
- prefix
Prefix of the keys you want to list under passed bucket
- s3Headers
any headers you want to add
- returns
Source of object metadata
- See also
https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html (version 2 API)
https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html (version 1 API)
-
def
listBucket(bucket: String, delimiter: String, prefix: Optional[String]): Source[ListBucketResultContents, NotUsed]
Will return a source of object metadata for a given bucket with delimiter and optional prefix using version 2 of the List Bucket API.
Will return a source of object metadata for a given bucket with delimiter and 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-versioncan be set to 1 to use the older API version 1- bucket
Which bucket that you list object metadata for
- delimiter
Delimiter to use for listing only one level of hierarchy
- 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/API_ListObjectsV2.html (version 2 API)
https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html (version 1 API)
-
def
listBucket(bucket: String, prefix: Optional[String], s3Headers: S3Headers): 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-versioncan 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/API_ListObjectsV2.html (version 2 API)
https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html (version 1 API)
-
def
listBucket(bucket: String, prefix: Optional[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-versioncan 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/API_ListObjectsV2.html (version 2 API)
https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html (version 1 API)
-
def
listBucketAndCommonPrefixes(bucket: String, delimiter: String, prefix: Optional[String], s3Headers: S3Headers): Source[Pair[List[ListBucketResultContents], List[ListBucketResultCommonPrefixes]], NotUsed]
Will return a source of object metadata and common prefixes for a given bucket and delimiter with optional prefix using version 2 of the List Bucket API.
Will return a source of object metadata and common prefixes for a given bucket and delimiter with optional prefix using version 2 of the List Bucket API. This will automatically page through all keys with the given parameters.
The
alpakka.s3.list-bucket-api-versioncan be set to 1 to use the older API version 1- bucket
Which bucket that you list object metadata for
- delimiter
Delimiter to use for listing only one level of hierarchy
- prefix
Prefix of the keys you want to list under passed bucket
- s3Headers
any headers you want to add
- returns
Source of Pair of (List of ListBucketResultContents, List of ListBucketResultCommonPrefixes
- See also
https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html (version 2 API)
https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html (version 1 API)
https://docs.aws.amazon.com/AmazonS3/latest/dev/ListingKeysHierarchy.html (prefix and delimiter documentation)
-
def
makeBucket(bucketName: String, materializer: Materializer, attributes: Attributes, s3Headers: S3Headers): 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
- s3Headers
any headers you want to add
- returns
CompletionStage of type Done as API doesn't return any additional information
- See also
https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
-
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/API_CreateBucket.html
-
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/API_CreateBucket.html
-
def
makeBucketSource(bucketName: String, s3Headers: S3Headers): Source[Done, NotUsed]
Create new bucket with a given name
-
def
makeBucketSource(bucketName: String): Source[Done, NotUsed]
Create new bucket with a given name
-
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
-
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
-
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
-
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
-
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
-
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): 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, 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
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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
-
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
-
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
-
def
request(bucket: String, key: String, versionId: Optional[String], method: HttpMethod = HttpMethods.GET, s3Headers: S3Headers = S3Headers.empty): 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
-
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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
- Deprecated
(Since version ) see corresponding Javadoc for more information.
-
def
listBucket(bucket: String, prefix: Option[String], s3Headers: S3Headers): 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-versioncan 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
- Annotations
- @Deprecated
- Deprecated
use version with
Optionalinstead, since 2.0.0- See also
https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html (version 2 API)
https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html (version 1 API)
-
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-versioncan 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
- Annotations
- @Deprecated
- Deprecated
use version with
Optionalinstead, since 2.0.0- See also
https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html (version 2 API)
https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html (version 1 API)