All Implemented Interfaces:

Iterable<S3ObjectSummary>

public class S3Objects
extends Object
implements Iterable<S3ObjectSummary>

 for ( S3ObjectSummary summary : S3Objects.withPrefix(s3, "my-bucket", "photos/") ) {
 System.out.printf("Object with key '%s'\n", summary.getKey());
 }
 

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  Integer	getBatchSize ()
  String	getBucketName ()
  String	getDelimiter ()
  String	getEncodingType ()
  String	getMarker ()
  String	getPrefix ()
  AmazonS3	getS3 ()
  static S3Objects	inBucket (AmazonS3 s3, String bucketName) Constructs an iterable that covers all the objects in an Amazon S3 bucket.
  boolean	isRequesterPays ()
  Iterator<S3ObjectSummary>	iterator ()
  S3Objects	withBatchSize (int batchSize) Sets the batch size, i.e., how many S3ObjectSummarys will be fetched at once.
  void	withDelimiter (String delimiter)
  void	withEncodingType (String encodingType)
  void	withMarker (String marker)
  static S3Objects	withPrefix (AmazonS3 s3, String bucketName, String prefix) Constructs an iterable that covers the objects in an Amazon S3 bucket where the key begins with the given prefix.
  void	withRequesterPays (boolean requesterPays)

  • Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Methods inherited from interface java.lang.Iterable

    forEach, spliterator

• Method Detail

  • inBucket

    public static S3Objects inBucket(AmazonS3 s3,
     String bucketName)

    Constructs an iterable that covers all the objects in an Amazon S3 bucket.

    Parameters:

    s3 - The Amazon S3 client.

    bucketName - The bucket name.

    Returns:

    An iterator for object summaries.

  • withPrefix

    public static S3Objects withPrefix(AmazonS3 s3,
     String bucketName,
     String prefix)

    Constructs an iterable that covers the objects in an Amazon S3 bucket where the key begins with the given prefix.

    Parameters:

    s3 - The Amazon S3 client.

    bucketName - The bucket name.

    prefix - The prefix.

    Returns:

    An iterator for object summaries.

  • withBatchSize

    public S3Objects withBatchSize(int batchSize)

    Sets the batch size, i.e., how many S3ObjectSummarys will be fetched at once.

    Parameters:

    batchSize - How many object summaries to fetch at once.

  • withRequesterPays

    public void withRequesterPays(boolean requesterPays)

    See Also:

    ListObjectsRequest.withRequesterPays(boolean)

  • withEncodingType

    public void withEncodingType(String encodingType)

    See Also:

    ListObjectsRequest.withEncodingType(String)

  • withMarker

    public void withMarker(String marker)

    See Also:

    ListObjectsRequest.withMarker(String)

  • withDelimiter

    public void withDelimiter(String delimiter)

    See Also:

    ListObjectsRequest.withDelimiter(String)

  • getBatchSize

    public Integer getBatchSize()

  • getPrefix

    public String getPrefix()

  • getBucketName

    public String getBucketName()

  • getDelimiter

    public String getDelimiter()

  • getMarker

    public String getMarker()

  • getEncodingType

    public String getEncodingType()

  • isRequesterPays

    public boolean isRequesterPays()

  • getS3

    public AmazonS3 getS3()

  • iterator

    public Iterator<S3ObjectSummary> iterator()

    Specified by:

    iterator in interface Iterable<S3ObjectSummary>