org.mule.module.s3.model

Class PartListing

java.lang.Object

org.mule.module.s3.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()

Method Summary

Methods

Modifier and Type	Method and Description
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.
boolean	isTruncated() Returns whether or not this 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 parts, as specified in the original request.
void	setEncodingType(String encodingType) For internal use only.
void	setInitiator(Owner initiator) Sets the user who initiated the associated multipart upload.
void	setKey(String key) Sets the key value specified in the original request used to identify which multipart upload contains the parts to list.
void	setMaxParts(Integer maxParts) Sets the optional max parts value specified in the original request to limit how many parts are listed.
void	setNextPartNumberMarker(Integer nextPartNumberMarker) Sets the next part number marker.
void	setOwner(Owner owner) Sets the user who owns the associated multipart upload.
void	setPartNumberMarker(Integer partNumberMarker) Sets the optional part number marker specified in the original request to specify where in the results to begin listing parts.
void	setParts(List<PartSummary> parts) Sets the list of parts described in this part listing.
void	setStorageClass(String storageClass) Sets the class of storage used for the parts in the associated multipart upload.
void	setTruncated(boolean isTruncated) Sets whether or not this listing is truncated, and additional requests need to be made to get more results.
void	setUploadId(String uploadId) Sets the upload ID value specified in the original request used to identify which multipart upload contains the parts to list.

Methods inherited from class java.lang.Object

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

Constructor Detail

PartListing

public PartListing()

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.

setBucketName

public void setBucketName(String bucketName)

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

Parameters:

bucketName - 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.

setKey

public void setKey(String key)

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

Parameters:

key - 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.

setUploadId

public void setUploadId(String uploadId)

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

Parameters:

uploadId - 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.

setOwner

public void setOwner(Owner owner)

Sets the user who owns the associated multipart upload.

Parameters:

owner - 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.

setInitiator

public void setInitiator(Owner initiator)

Sets the user who initiated the associated multipart upload.

Parameters:

initiator - 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.

setStorageClass

public void setStorageClass(String storageClass)

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

Parameters:

storageClass - 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.

setPartNumberMarker

public void setPartNumberMarker(Integer partNumberMarker)

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

Parameters:

partNumberMarker - 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.

setNextPartNumberMarker

public void setNextPartNumberMarker(Integer nextPartNumberMarker)

Sets 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.

Parameters:

nextPartNumberMarker - The next part number marker.

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.

setMaxParts

public void setMaxParts(Integer maxParts)

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

Parameters:

maxParts - 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.

setEncodingType

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.

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.

setTruncated

public void setTruncated(boolean isTruncated)

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

Parameters:

isTruncated - 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.

setParts

public void setParts(List<PartSummary> parts)

Sets the list of parts described in this part listing.

Parameters:

parts - The list of parts described in this part listing.