case class Bucket(name: String, delimiter: Option[String] = Some("/"), s3: S3) extends Product with Serializable
Representation of a bucket
- name
The name of the bucket needed to create a Bucket representation
- delimiter
A delimiter to use for this Bucket instance, default is a / (slash)
- Alphabetic
- By Inheritance
- Bucket
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(bucketFile: BucketFile)(implicit executionContext: ExecutionContext): Future[Unit]
- See also
add
- def -(itemName: String)(implicit executionContext: ExecutionContext): Future[Unit]
- See also
remove
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def abortMultipartUpload(uploadTicket: BucketFileUploadTicket)(implicit executionContext: ExecutionContext): Future[Unit]
Aborts a multipart upload
Aborts a multipart upload
- uploadTicket
The ticket acquired from initiateMultipartUpload
- def add(bucketFile: BucketFile)(implicit executionContext: ExecutionContext): Future[Unit]
Adds a file to this bucket
Adds a file to this bucket
- bucketFile
A representation of the file
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(sourceItemName: String, destinationItemName: String, acl: ACL = PUBLIC_READ, headers: Map[String, String] = Map.empty)(implicit executionContext: ExecutionContext): Future[Unit]
Allows you to copy a file within this bucket.
Allows you to copy a file within this bucket.
Note that copying a file removes the
server-side-encryption,storage-class, andwebsite-redirect-locationmetadata.- sourceItemName
The source name of the item
- destinationItemName
The destination name of the item
- acl
The ACL for the new item, default is PUBLIC_READ
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def completeMultipartUpload(uploadTicket: BucketFileUploadTicket, partUploadTickets: Seq[BucketFilePartUploadTicket])(implicit executionContext: ExecutionContext): Future[Unit]
Completes a multipart upload
Completes a multipart upload
- uploadTicket
The ticket acquired from initiateMultipartUpload
- partUploadTickets
The tickets acquired from uploadPart
- val delimiter: Option[String]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def get(itemName: String)(implicit executionContext: ExecutionContext): Future[BucketFile]
Retrieves a single item with the given name
Retrieves a single item with the given name
- itemName
The name of the item you want to retrieve
- def getAcl(itemName: String)(implicit executionContext: ExecutionContext): Future[ACLList]
Retrieves the ACL
Retrieves the ACL
- itemName
The name of the file that you want to retrieve the ACL for
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getHeadersOf(itemName: String)(implicit executionContext: ExecutionContext): Future[Map[String, Seq[String]]]
Retrieves the headers of a single item.
Retrieves the headers of a single item.
- itemName
The name of the item you want to receive the headers from
- def initiateMultipartUpload(bucketFile: BucketFile)(implicit executionContext: ExecutionContext): Future[BucketFileUploadTicket]
Initiates a multipart upload
Initiates a multipart upload
- bucketFile
A representation of the file
- returns
The upload id
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def list(prefix: String)(implicit executionContext: ExecutionContext): Future[Iterable[BucketItem]]
Lists the contents of a 'directory' in the bucket
- def list(implicit executionContext: ExecutionContext): Future[Iterable[BucketItem]]
Lists the contents of the bucket
- val name: String
- 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 productElementNames: Iterator[String]
- Definition Classes
- Product
- def remove(itemName: String)(implicit executionContext: ExecutionContext): Future[Unit]
Removes a file from this bucket
Removes a file from this bucket
- itemName
The name of the file that needs to be removed
- def rename(sourceItemName: String, destinationItemName: String, acl: ACL = PUBLIC_READ, headers: Map[String, String] = Map.empty)(implicit executionContext: ExecutionContext): Future[Unit]
Allows you to rename a file within this bucket.
Allows you to rename a file within this bucket. It will actually do a copy and a remove.
Note that renaming a file removes the
server-side-encryption,storage-class, andwebsite-redirect-locationmetadata.- sourceItemName
The old name of the item
- destinationItemName
The new name of the item
- acl
The ACL for the new item, default is PUBLIC_READ
- val s3: S3
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def updateAcl(itemName: String, acl: ACL)(implicit executionContext: ExecutionContext): Future[Unit]
Updates the ACL of given item
Updates the ACL of given item
- itemName
The name of file that needs to be updated
- acl
The ACL
- def uploadPart(uploadTicket: BucketFileUploadTicket, bucketFilePart: BucketFilePart)(implicit executionContext: ExecutionContext): Future[BucketFilePartUploadTicket]
Uploads a part in the multipart upload
Uploads a part in the multipart upload
- uploadTicket
The ticket acquired from initiateMultipartUpload
- bucketFilePart
The part that you want to upload
- def uploadPolicy(expiration: Date): PolicyBuilder
Utility method to create a policy builder for this bucket
Utility method to create a policy builder for this bucket
- expiration
The date this policy expires
- def url(itemName: String, method: String = "GET"): String
Creates an unsigned url for the given item name
Creates an unsigned url for the given item name
- itemName
The item for which the url should be created
- def url(itemName: String, expires: Int, method: String): String
Creates an authenticated url for an item with the given name and method
Creates an authenticated url for an item with the given name and method
- itemName
The item for which the url should be created
- expires
The expiration in seconds from now
- def url(itemName: String, expires: Int): String
Creates an authenticated url for an item with the given name
Creates an authenticated url for an item with the given name
- itemName
The item for which the url should be created
- expires
The expiration in seconds from now
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withDelimiter(delimiter: Option[String]): Bucket
Creates a new instance of the Bucket with another delimiter
- def withDelimiter(delimiter: String): Bucket
Creates a new instance of the Bucket with another delimiter