public class PartListing extends Object implements Serializable, S3RequesterChargedResult
Constructor and Description |
---|
PartListing() |
Modifier and Type | Method and Description |
---|---|
Date |
getAbortDate()
Date when multipart upload will become eligible for abort operation by lifecycle.
|
String |
getAbortRuleId()
Id of the lifecycle rule that makes a multipart upload eligible for abort operation.
|
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 |
isRequesterCharged()
Returns true if the user has enabled Requester Pays option when
conducting this operation from Requester Pays Bucket; else false.
|
boolean |
isTruncated()
Returns whether or not this listing is truncated, and additional requests
need to be made to get more results.
|
void |
setAbortDate(Date abortDate)
Date when multipart upload will become eligible for abort operation by lifecycle.
|
void |
setAbortRuleId(String abortRuleId)
Id of the lifecycle rule that makes a multipart upload eligible for abort operation.
|
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(int maxParts)
Sets the optional max parts value specified in the original request to
limit how many parts are listed.
|
void |
setNextPartNumberMarker(int nextPartNumberMarker)
Sets the next part number marker.
|
void |
setOwner(Owner owner)
Sets the user who owns the associated multipart upload.
|
void |
setPartNumberMarker(int 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 |
setRequesterCharged(boolean isRequesterCharged)
Used for conducting this operation from a Requester Pays Bucket.
|
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.
|
public String getBucketName()
public void setBucketName(String bucketName)
bucketName
- the name of the bucket containing the listed parts, as
specified in the original request.public String getKey()
public void setKey(String key)
key
- the key value specified in the original request used to
identify which multipart upload contains the parts to list.public String getUploadId()
public void setUploadId(String uploadId)
uploadId
- the upload ID value specified in the original request used to
identify which multipart upload contains the parts to list.public Owner getOwner()
public void setOwner(Owner owner)
owner
- the user who owns the associated multipart upload.public Owner getInitiator()
public void setInitiator(Owner initiator)
initiator
- the user who initiated the associated multipart upload.public String getStorageClass()
public void setStorageClass(String storageClass)
storageClass
- The class of storage used for the parts in the associated
multipart upload.public Integer getPartNumberMarker()
public void setPartNumberMarker(int partNumberMarker)
partNumberMarker
- the optional part number marker specified in the original
request to specify where in the results to begin listing
parts.public Integer getNextPartNumberMarker()
public void setNextPartNumberMarker(int nextPartNumberMarker)
nextPartNumberMarker
- The next part number marker.public Integer getMaxParts()
public void setMaxParts(int maxParts)
maxParts
- The optional max parts value specified in the original request
to limit how many parts are listed.public String getEncodingType()
encodingType
request
parameter, Amazon S3 includes this element in the response, and returns
encoded key name values in the Key
element.Null
if encodingType
is not specified
in the request parameter.public void setEncodingType(String encodingType)
encodingType
- Null
if encodingType
is not
specified in the request parameter.public boolean isTruncated()
public void setTruncated(boolean isTruncated)
isTruncated
- whether or not this listing is truncated, and additional
requests need to be made to get more results.public List<PartSummary> getParts()
public void setParts(List<PartSummary> parts)
parts
- The list of parts described in this part listing.public Date getAbortDate()
public void setAbortDate(Date abortDate)
abortDate
- The date when the upload will be eligible for abort.public String getAbortRuleId()
public void setAbortRuleId(String abortRuleId)
abortRuleId
- Rule IDpublic boolean isRequesterCharged()
S3RequesterChargedResult
If a bucket is enabled for Requester Pays, then any attempt of operation from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.
Enabling Requester Pays disables the ability to have anonymous access to this bucket
isRequesterCharged
in interface S3RequesterChargedResult
public void setRequesterCharged(boolean isRequesterCharged)
S3RequesterChargedResult
If a bucket is enabled for Requester Pays, then any attempt of operation from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.
setRequesterCharged
in interface S3RequesterChargedResult
isRequesterCharged
- Indicates requester is charged for this operation.