public class

PartListing

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

Class Overview

The ListPartsResponse contains all the information about the ListParts method.

Summary

Constants
long serialVersionUID
Fields
private String bucketName The name of the bucket containing the listed parts, as specified in the original request.
private String encodingType The encodingType parameter originally specified by the caller when this part listing was returned.
private Owner initiator The initiator of the associated multipart upload.
private boolean isTruncated Indicates if the listing is truncated, and additional requests need to be made to get more results.
private String key The key value specified in the original request used to identify which multipart upload contains the parts to list.
private Integer maxParts The optional max parts value specified in the original request to limit how many parts are listed.
private Integer nextPartNumberMarker 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.
private Owner owner The user who owns the associated multipart upload.
private Integer partNumberMarker The optional part number marker specified in the original request to specify where in the results to begin listing parts.
private List<PartSummary> parts The list of parts described in this part listing.
private String storageClass The class of storage used for the parts in the associated multipart upload.
private String uploadId The upload ID value specified in the original request used to identify which multipart upload contains the parts to list.
Public Constructors
PartListing()
Public Methods
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.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

private static final long serialVersionUID

Constant Value: -3990571071243947931 (0xc89ea4c0ef8df065)

Fields

private String bucketName

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

private String encodingType

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

private Owner initiator

The initiator of the associated multipart upload.

private boolean isTruncated

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

private String key

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

private Integer maxParts

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

private Integer nextPartNumberMarker

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.

private Owner owner

The user who owns the associated multipart upload.

private Integer partNumberMarker

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

private List<PartSummary> parts

The list of parts described in this part listing.

private String storageClass

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

private String uploadId

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

Public Constructors

public PartListing ()

Public Methods

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.

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.

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.

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.

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.

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.

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.

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.

public List<PartSummary> getParts ()

Returns the list of parts described in this part listing.

Returns
  • The list of parts described in this part listing.

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.

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.

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.

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.

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 setInitiator (Owner initiator)

Sets the user who initiated the associated multipart upload.

Parameters
initiator The user who initiated the associated multipart upload.

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.

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.

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.

public void setOwner (Owner owner)

Sets the user who owns the associated multipart upload.

Parameters
owner The user who owns the associated multipart upload.

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.

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.

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.

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.

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.