Packages

class S3 extends Logging

A representation of Amazon's S3 service. This class wraps an com.amazonaws.services.s3.AmazonS3 instance and provides a higher level interface for querying the information about the buckets and their objects.

Annotations
@deprecated
Deprecated

(Since version 2017/07/13) This will be removed in a future version

Linear Supertypes
Logging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. S3
  2. Logging
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new S3(credentials: AWSCredentials = CredentialStore.getCredentials)

    credentials

    optional AWS credentials to use. If the parameter is not supplied, they will be retrieved from the eu.shiftforward.apso.aws.CredentialStore.

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. def apply(bucketName: String, objName: String): Option[S3Object]

    Returns the representation of an object in a bucket, if it exists.

    Returns the representation of an object in a bucket, if it exists.

    bucketName

    the name of the bucket

    objName

    the name of the object

    returns

    the object wrapped in a Some if that object exists, None otherwise.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def bucketTags(bucketName: String): Map[String, String]

    Returns the tags associated with a bucket.

    Returns the tags associated with a bucket.

    bucketName

    the name of the bucket

    returns

    a map containing the tags associated with the given bucket. If the bucket doesn't exist, an empty map is returned.

  7. def bucketTags(bucket: Bucket): Map[String, String]

    Returns the tags associated with a bucket.

    Returns the tags associated with a bucket.

    bucket

    the bucket object

    returns

    a map containing the tags associated with the given bucket. If the bucket doesn't exist, an empty map is returned.

    Annotations
    @inline()
  8. def buckets: Seq[Bucket]

    Returns a list of all the buckets listable with this object's credentials.

    Returns a list of all the buckets listable with this object's credentials.

    returns

    a list of all the buckets listable with this object's credentials.

  9. val client: AmazonS3

    The underlying com.amazonaws.services.s3.AmazonS3 instance.

  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  16. def headObject(bucketName: String, prefix: String = null, marker: String = null): Option[S3ObjectSummary]

    Returns the first object in a bucket, optionally with a given prefix and after a given marker, if it exists.

    Returns the first object in a bucket, optionally with a given prefix and after a given marker, if it exists.

    bucketName

    the name of the bucket

    prefix

    the prefix of the object to return, or null for no prefix

    marker

    the marker from which the search is to be done, or null to search from the beginning of the bucket

    returns

    the first object in a bucket with the given prefix after the given marker wrapped in a Some if such an object exists, None otherwise.

    Annotations
    @inline()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. lazy val log: Logger

    The Logger object.

    The Logger object. This logger will have the same name as the concrete class into which this trait is mixed-in.

    Definition Classes
    Logging
  19. def metadata(bucketName: String, objName: String): Option[ObjectMetadata]

    Returns the metadata of an object in a bucket, if it exists.

    Returns the metadata of an object in a bucket, if it exists.

    bucketName

    the name of the bucket

    objName

    the name of the object

    returns

    the object metadata wrapped in a Some if that object exists, None otherwise.

  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  23. def objects(bucketName: String, prefix: String = null, marker: String = null, maxKeys: Int = 1): Iterator[S3ObjectSummary]

    Returns the objects in a bucket, optionally with a given prefix and after a given marker.

    Returns the objects in a bucket, optionally with a given prefix and after a given marker.

    bucketName

    the name of the bucket

    prefix

    the prefix of the objects to return, or null for no prefix

    marker

    the marker from which the search is to be done, or null to search from the beginning of the bucket

    maxKeys

    the maximum number of objects to return. As S3 can limit the number of objects returned in a single request, there is no guarantee that maxKeys objects will be returned, even if there is more than maxKeys objects in S3 with the specified constraints.

    returns

    a list with at most maxKeys objects in a bucket with the given prefix after the given marker.

  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped