org.mule.extension.s3.api.model

Class PartListing

java.lang.Object

org.mule.extension.s3.api.model.PartListing

All Implemented Interfaces:

Serializable

public class PartListing
extends Object
implements Serializable

The ListPartsResponse contains all the information about the ListParts method.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PartListing()
PartListing(String bucketName, String key, String uploadId, Integer maxParts, Integer partNumberMarker, String encodingType, Owner owner, Owner initiator, String storageClass, boolean truncated, Integer nextPartNumberMarker, List<PartSummary> parts)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getBucketName() Returns the name of the bucket containing the listed parts, as specified in the original request.
String	getEncodingType() Gets the encoding type used by Amazon S3 to encode object key names in the XML response.
Owner	getInitiator() Returns details on the user who initiated the associated multipart upload.
String	getKey() Returns the key value specified in the original request used to identify which multipart upload contains the parts to list.
Integer	getMaxParts() Returns the optional max parts value specified in the original request to limit how many parts are listed.
Integer	getNextPartNumberMarker() Returns the next part number marker.
Owner	getOwner() Returns details on the user who owns the associated multipart upload.
Integer	getPartNumberMarker() Returns the optional part number marker specified in the original request to specify where in the results to begin listing parts.
List<PartSummary>	getParts() Returns the list of parts described in this part listing.
String	getStorageClass() Returns the class of storage used for the parts in the associated multipart upload.
String	getUploadId() Returns the upload ID value specified in the original request used to identify which multipart upload contains the parts to list.
int	hashCode()
boolean	isTruncated() Returns whether or not this listing is truncated, and additional requests need to be made to get more results.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PartListing

public PartListing()

PartListing

public PartListing(String bucketName,
                   String key,
                   String uploadId,
                   Integer maxParts,
                   Integer partNumberMarker,
                   String encodingType,
                   Owner owner,
                   Owner initiator,
                   String storageClass,
                   boolean truncated,
                   Integer nextPartNumberMarker,
                   List<PartSummary> parts)

Method Detail

getBucketName

public String getBucketName()

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

Returns:

the name of the bucket containing the listed parts, as specified in the original request.

getKey

public String getKey()

Returns the key value specified in the original request used to identify which multipart upload contains the parts to list.

Returns:

the key value specified in the original request used to identify which multipart upload contains the parts to list.

getUploadId

public String getUploadId()

Returns the upload ID value specified in the original request used to identify which multipart upload contains the parts to list.

Returns:

the upload ID value specified in the original request used to identify which multipart upload contains the parts to list.

getOwner

public Owner getOwner()

Returns details on the user who owns the associated multipart upload.

Returns:

details on the user who owns the associated multipart upload.

getInitiator

public Owner getInitiator()

Returns details on the user who initiated the associated multipart upload.

Returns:

details on the user who initiated the associated multipart upload.

getStorageClass

public String getStorageClass()

Returns the class of storage used for the parts in the associated multipart upload.

Returns:

The class of storage used for the parts in the associated multipart upload.

getPartNumberMarker

public Integer getPartNumberMarker()

Returns the optional part number marker specified in the original request to specify where in the results to begin listing parts.

Returns:

the optional part number marker specified in the original request to specify where in the results to begin listing parts.

getNextPartNumberMarker

public Integer getNextPartNumberMarker()

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

Returns:

The next part number marker, to be used for pagination if this part listing is truncated.

getMaxParts

public Integer getMaxParts()

Returns the optional max parts value specified in the original request to limit how many parts are listed.

Returns:

The optional max parts value specified in the original request to limit how many parts are listed.

getEncodingType

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 Key element.

Returns:

Null if encodingType is not specified in the request parameter.

isTruncated

public boolean isTruncated()

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

Returns:

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

getParts

public List<PartSummary> getParts()

Returns the list of parts described in this part listing.

Returns:

The list of parts described in this part listing.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object