fly.play.s3

Bucket

Related Doc: package s3

case class Bucket(name: String, delimiter: Option[String] = Some("/"), s3: S3) extends Product with Serializable

Representation of a bucket

delimiter

A delimiter to use for this Bucket instance, default is a / (slash)

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Bucket
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Bucket(name: String, delimiter: Option[String] = Some("/"), s3: S3)

    delimiter

    A delimiter to use for this Bucket instance, default is a / (slash)

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. def +: (BucketFile) ⇒ Future[Unit]

    See also

    add

  4. def -: (String) ⇒ Future[Unit]

    See also

    remove

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  6. def abortMultipartUpload(uploadTicket: BucketFileUploadTicket): Future[Unit]

    Aborts a multipart upload

    Aborts a multipart upload

    uploadTicket

    The ticket acquired from initiateMultipartUpload

  7. def add(bucketFile: BucketFile): Future[Unit]

    Adds a file to this bucket

    Adds a file to this bucket

    bucketFile

    A representation of the file

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(sourceItemName: String, destinationItemName: String, acl: ACL = PUBLIC_READ, headers: Map[String, String] = Map.empty): 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, and website-redirect-location metadata.

    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

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def completeMultipartUpload(uploadTicket: BucketFileUploadTicket, partUploadTickets: Seq[BucketFilePartUploadTicket]): Future[Unit]

    Completes a multipart upload

    Completes a multipart upload

    uploadTicket

    The ticket acquired from initiateMultipartUpload

    partUploadTickets

    The tickets acquired from uploadPart

  12. val delimiter: Option[String]

    A delimiter to use for this Bucket instance, default is a / (slash)

  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def get(itemName: String): 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

  16. def getAcl(itemName: String): Future[ACLList]

    Retrieves the ACL

    Retrieves the ACL

    itemName

    The name of the file that you want to retrieve the ACL for

  17. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  18. def getHeadersOf(itemName: String): Future[Map[String, Seq[String]]]

    Retrueves the headers of a single item.

    Retrueves the headers of a single item.

    itemName

    The name of the item you want to receive the headers from

  19. def initiateMultipartUpload(bucketFile: BucketFile): Future[BucketFileUploadTicket]

    Initiates a multipart upload

    Initiates a multipart upload

    bucketFile

    A representation of the file

    returns

    The upload id

  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. def list(prefix: String): Future[Iterable[BucketItem]]

    Lists the contents of a 'directory' in the bucket

  22. def list: Future[Iterable[BucketItem]]

    Lists the contents of the bucket

  23. val name: String

  24. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  27. def remove(itemName: String): 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

  28. def rename(sourceItemName: String, destinationItemName: String, acl: ACL = PUBLIC_READ, headers: Map[String, String] = Map.empty): 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, and website-redirect-location metadata.

    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

  29. val s3: S3

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

    Definition Classes
    AnyRef
  31. def updateAcl(itemName: String, acl: ACL): 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

  32. def uploadPart(uploadTicket: BucketFileUploadTicket, bucketFilePart: BucketFilePart): 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

  33. def uploadPolicy(expiration: Date): PolicyBuilder

    Utility method to create a policy builder for this bucket

  34. 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

  35. 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

  36. 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

  37. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. def withDelimiter(delimiter: Option[String]): Bucket

    Creates a new instance of the Bucket with another delimiter

  41. def withDelimiter(delimiter: String): Bucket

    Creates a new instance of the Bucket with another delimiter

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped