public class

MultipartUploadListing

extends Object
implements Serializable
java.lang.Object
   ↳ org.mule.module.s3.model.MultipartUploadListing

Class Overview

The ListMultipartUploadsResponse contains all the information about the ListMultipartUploads method.

Summary

Constants
long serialVersionUID
Fields
private String bucketName The name of the bucket containing the listed multipart uploads, as specified in the original request.
private List<String> commonPrefixes A list of the common prefixes included in this multipart upload listing - common prefixes will only be populated for requests that specified a delimiter, and indicate additional key prefixes that contain more multipart uploads that have not been included in this listing.
private String delimiter The optional delimiter specified in the original request to control how multipart uploads for keys with common prefixes are condensed.
private String encodingType The encodingType parameter originally specified by the caller when this multipart upload listing was returned.
private boolean isTruncated Indicates if the listing is truncated, and additional requests need to be made to get more results.
private String keyMarker The optional key marker specified in the original request to specify where in the results to begin listing multipart uploads.
private int maxUploads The optional maximum number of uploads to be listed, as specified in the original request.
private List<MultipartUpload> multipartUploads The list of multipart uploads.
private String nextKeyMarker If this listing is truncated, this is the next key marker that should be used in the next request to get the next page of results.
private String nextUploadIdMarker If this listing is truncated, this is the next upload ID marker that should be used in the next request to get the next page of results.
private String prefix The optional prefix specified in the original request to limit the returned multipart uploads to those for keys that match this prefix.
private String uploadIdMarker The optional upload ID marker specified in the original request to specify where in the results to begin listing multipart uploads.
Public Constructors
MultipartUploadListing()
Public Methods
String getBucketName()
Returns the name of the bucket containing the listed multipart uploads, as specified in the original request.
List<String> getCommonPrefixes()

Returns the common prefixes included in this multipart upload listing.

String getDelimiter()
Gets the delimiter parameter originally used to request this multipart upload listing, or null if no delimiter specified.
String getEncodingType()
Gets the encoding type used by Amazon S3 to encode object key names in the XML response.
String getKeyMarker()
Returns the optional key marker specified in the original request to specify where in the results to begin listing multipart uploads.
int getMaxUploads()
Returns the optional maximum number of uploads to be listed, as specified in the original request.
List<MultipartUpload> getMultipartUploads()
Returns the list of multipart uploads.
String getNextKeyMarker()
Returns the next key marker that should be used in the next request to get the next page of results.
String getNextUploadIdMarker()
Returns the next upload ID marker that should be used in the next request to get the next page of results.
String getPrefix()
Returns the prefix parameter originally used to request this multipart upload listing, or null if no prefix was specified.
String getUploadIdMarker()
Returns the optional upload ID marker specified in the original request to specify where in the results to begin listing multipart uploads.
boolean isTruncated()
Returns true if the listing is truncated, and additional requests need to be made to get more results.
void setBucketName(String bucketName)
Sets the name of the bucket containing the listed multipart uploads, as specified in the original request.
void setCommonPrefixes(List<String> commonPrefixes)
For internal use only.
void setDelimiter(String delimiter)
For internal use only.
void setEncodingType(String encodingType)
For internal use only.
void setKeyMarker(String keyMarker)
Sets the optional key marker specified in the original request to specify where in the results to begin listing multipart uploads.
void setMaxUploads(int maxUploads)
Sets the optional maximum number of uploads to be listed, as specified in the original request.
void setMultipartUploads(List<MultipartUpload> multipartUploads)
Sets the list of multipart uploads.
void setNextKeyMarker(String nextKeyMarker)
Sets the next key marker that should be used in the next request to get the next page of results.
void setNextUploadIdMarker(String nextUploadIdMarker)
Sets the next upload ID marker that should be used in the next request to get the next page of results.
void setPrefix(String prefix)
For internal use only.
void setTruncated(boolean isTruncated)
Sets whether this listing is truncated, and additional requests need to be made to get more results.
void setUploadIdMarker(String uploadIdMarker)
Sets the optional upload ID marker specified in the original request to specify where in the results to begin listing multipart uploads.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

private static final long serialVersionUID

Constant Value: -4598646654069587634 (0xc02e533b98a4c14e)

Fields

private String bucketName

The name of the bucket containing the listed multipart uploads, as specified in the original request.

private List<String> commonPrefixes

A list of the common prefixes included in this multipart upload listing - common prefixes will only be populated for requests that specified a delimiter, and indicate additional key prefixes that contain more multipart uploads that have not been included in this listing.

private String delimiter

The optional delimiter specified in the original request to control how multipart uploads for keys with common prefixes are condensed.

private String encodingType

The encodingType parameter originally specified by the caller when this multipart upload listing was returned.

private boolean isTruncated

Indicates if the listing is truncated, and additional requests need to be made to get more results.

private String keyMarker

The optional key marker specified in the original request to specify where in the results to begin listing multipart uploads.

private int maxUploads

The optional maximum number of uploads to be listed, as specified in the original request.

private List<MultipartUpload> multipartUploads

The list of multipart uploads.

private String nextKeyMarker

If this listing is truncated, this is the next key marker that should be used in the next request to get the next page of results.

private String nextUploadIdMarker

If this listing is truncated, this is the next upload ID marker that should be used in the next request to get the next page of results.

private String prefix

The optional prefix specified in the original request to limit the returned multipart uploads to those for keys that match this prefix.

private String uploadIdMarker

The optional upload ID marker specified in the original request to specify where in the results to begin listing multipart uploads.

Public Constructors

public MultipartUploadListing ()

Public Methods

public String getBucketName ()

Returns the name of the bucket containing the listed multipart uploads, as specified in the original request.

Returns
  • The name of the bucket containing the listed multipart uploads, as specified in the original request.

public List<String> getCommonPrefixes ()

Returns the common prefixes included in this multipart upload listing. Common prefixes are only present if a delimiter was specified in the original request.

Each common prefix represents a set of keys in the S3 bucket that have been condensed and omitted from the multipart upload listing results. This allows applications to organize and browse their multipart uploads hierarchically, similar to how a file system organizes files into directories.

For example, consider a bucket that contains the following keys currently involved in multipart uploads:

  • "foo/bar/baz"
  • "foo/bar/bash"
  • "foo/bar/bang"
  • "foo/boo"
If calling listMultipartUploads with the prefix="foo/" and the delimiter="/" on this bucket, the returned MultipartUploadListing will contain one entry in the common prefixes list ("foo/bar/") and none of the uploads for the keys beginning with that common prefix will be included in the multipart upload list.

Returns
  • The list of common prefixes included in this multipart object listing, which might be an empty list if no common prefixes were found.

public String getDelimiter ()

Gets the delimiter parameter originally used to request this multipart upload listing, or null if no delimiter specified.

The delimiter value allows callers to condense multipart uploads for keys with common prefixes. For example, if a caller specifies a delimiter of "/" (a commonly used value for delimiter), any multipart uploads for keys that contain a common prefix between the start of the key and the first occurrence of "/" will not be included in the list of multipart uploads. Instead, the common prefixes list will have one entry for the common prefix.

Returns
  • The delimiter parameter originally used to request this multipart upload listing. Returns null if no delimiter was specified.

public String getEncodingType ()

Gets the encoding type used by Amazon S3 to encode object key names in the XML response. If you specify encodingType request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements: Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

Returns
  • Null if encodingType is not specified in the request parameter.

public String getKeyMarker ()

Returns the optional key marker specified in the original request to specify where in the results to begin listing multipart uploads.

Returns
  • The optional key marker specified in the original request to specify where in the results to begin listing multipart uploads.

public int getMaxUploads ()

Returns the optional maximum number of uploads to be listed, as specified in the original request.

Returns
  • The optional maximum number of uploads to be listed, as specified in the original request.

public List<MultipartUpload> getMultipartUploads ()

Returns the list of multipart uploads.

Returns
  • The list of multipart uploads.

public String getNextKeyMarker ()

Returns the next key marker that should be used in the next request to get the next page of results. This value is only valid if isTruncated() indicates this listing is truncated.

Returns
  • the next key marker that should be used in the next request to get the next page of results. This value is only valid if isTruncated() indicates this listing is truncated.

public String getNextUploadIdMarker ()

Returns the next upload ID marker that should be used in the next request to get the next page of results. This value is only valid if isTruncated() indicates this listing is truncated.

Returns
  • the next upload ID marker that should be used in the next request to get the next page of results.

public String getPrefix ()

Returns the prefix parameter originally used to request this multipart upload listing, or null if no prefix was specified. All objects and common prefixes included in this multipart upload listing start with the specified prefix.

Returns
  • The prefix parameter originally used to request this multipart upload listing. Returns null if no prefix was specified.

public String getUploadIdMarker ()

Returns the optional upload ID marker specified in the original request to specify where in the results to begin listing multipart uploads.

Returns
  • The optional upload ID marker specified in the original request to specify where in the results to begin listing multipart uploads.

public boolean isTruncated ()

Returns true if the listing is truncated, and additional requests need to be made to get more results.

Returns
  • true if the listing is truncated, and additional requests need to be made to get more results.

public void setBucketName (String bucketName)

Sets the name of the bucket containing the listed multipart uploads, as specified in the original request.

Parameters
bucketName The name of the bucket containing the listed multipart uploads, as specified in the original request.

public void setCommonPrefixes (List<String> commonPrefixes)

For internal use only. Sets the common prefixes for this multipart upload listing, representing the uploads for key prefixes that were rolled up because of the request's delimiter parameter.

Parameters
commonPrefixes The common prefixes for this multipart upload listing.

public void setDelimiter (String delimiter)

For internal use only. Sets the delimiter parameter originally used to request this multipart upload listing.

Parameters
delimiter The delimiter parameter originally used to request this multipart upload listing.

public void setEncodingType (String encodingType)

For internal use only. Sets the encoding type used by Amazon S3 to encode object key names in the XML response.

Parameters
encodingType Null if encodingType is not specified in the request parameter.

public void setKeyMarker (String keyMarker)

Sets the optional key marker specified in the original request to specify where in the results to begin listing multipart uploads.

Parameters
keyMarker The optional key marker specified in the original request to specify where in the results to begin listing multipart uploads.

public void setMaxUploads (int maxUploads)

Sets the optional maximum number of uploads to be listed, as specified in the original request.

Parameters
maxUploads The optional maximum number of uploads to be listed, as specified in the original request.

public void setMultipartUploads (List<MultipartUpload> multipartUploads)

Sets the list of multipart uploads.

Parameters
multipartUploads The list of multipart uploads.

public void setNextKeyMarker (String nextKeyMarker)

Sets the next key marker that should be used in the next request to get the next page of results.

Parameters
nextKeyMarker The next key marker that should be used in the next request to get the next page of results.

public void setNextUploadIdMarker (String nextUploadIdMarker)

Sets the next upload ID marker that should be used in the next request to get the next page of results.

Parameters
nextUploadIdMarker The next upload ID marker that should be used in the next request to get the next page of results.

public void setPrefix (String prefix)

For internal use only. Sets the prefix parameter originally used to request this multipart upload listing.

Parameters
prefix The prefix parameter originally used to request this multipart upload listing.

public void setTruncated (boolean isTruncated)

Sets whether this listing is truncated, and additional requests need to be made to get more results.

Parameters
isTruncated True if the listing is truncated, and additional requests need to be made to get more results.

public void setUploadIdMarker (String uploadIdMarker)

Sets the optional upload ID marker specified in the original request to specify where in the results to begin listing multipart uploads.

Parameters
uploadIdMarker The optional upload ID marker specified in the original request to specify where in the results to begin listing multipart uploads.