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
- Alphabetic
- By Inheritance
- S3
- Logging
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
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
-
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
-
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
Someif that object exists,Noneotherwise.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
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.
-
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()
-
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.
-
val
client: AmazonS3
The underlying com.amazonaws.services.s3.AmazonS3 instance.
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
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
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
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
nullfor no prefix- marker
the marker from which the search is to be done, or
nullto 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
Someif such an object exists,Noneotherwise.
- Annotations
- @inline()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
lazy val
log: Logger
The
Loggerobject.The
Loggerobject. This logger will have the same name as the concrete class into which this trait is mixed-in.- Definition Classes
- Logging
-
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
Someif that object exists,Noneotherwise.
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
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
nullfor no prefix- marker
the marker from which the search is to be done, or
nullto 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
maxKeysobjects will be returned, even if there is more thanmaxKeysobjects in S3 with the specified constraints.- returns
a list with at most
maxKeysobjects in a bucket with the given prefix after the given marker.
-
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( ... )