public class PartListing extends java.lang.Object implements java.io.Serializable, S3RequesterChargedResult
Modifier and Type | Field and Description |
---|---|
private java.util.Date |
abortDate
Date when multipart upload will become eligible for abort operation by lifecycle.
|
private java.lang.String |
abortRuleId
Id of the lifecycle rule that makes a multipart upload eligible for abort operation.
|
private java.lang.String |
bucketName
The name of the bucket containing the listed parts, as specified in the
original request.
|
private java.lang.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 |
isRequesterCharged
Indicate if the requester is charged for conducting this operation from
Requester Pays Buckets.
|
private boolean |
isTruncated
Indicates if the listing is truncated, and additional requests need to be
made to get more results.
|
private java.lang.String |
key
The key value specified in the original request used to identify which
multipart upload contains the parts to list.
|
private java.lang.Integer |
maxParts
The optional max parts value specified in the original request to limit
how many parts are listed.
|
private java.lang.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 java.lang.Integer |
partNumberMarker
The optional part number marker specified in the original request to
specify where in the results to begin listing parts.
|
private java.util.List<PartSummary> |
parts
The list of parts described in this part listing.
|
private java.lang.String |
storageClass
The class of storage used for the parts in the associated multipart upload.
|
private java.lang.String |
uploadId
The upload ID value specified in the original request used to identify
which multipart upload contains the parts to list.
|
Constructor and Description |
---|
PartListing() |
Modifier and Type | Method and Description |
---|---|
java.util.Date |
getAbortDate()
Date when multipart upload will become eligible for abort operation by lifecycle.
|
java.lang.String |
getAbortRuleId()
Id of the lifecycle rule that makes a multipart upload eligible for abort operation.
|
java.lang.String |
getBucketName()
Returns the name of the bucket containing the listed parts, as specified
in the original request.
|
java.lang.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.
|
java.lang.String |
getKey()
Returns the key value specified in the original request used to identify
which multipart upload contains the parts to list.
|
java.lang.Integer |
getMaxParts()
Returns the optional max parts value specified in the original request to
limit how many parts are listed.
|
java.lang.Integer |
getNextPartNumberMarker()
Returns the next part number marker.
|
Owner |
getOwner()
Returns details on the user who owns the associated multipart
upload.
|
java.lang.Integer |
getPartNumberMarker()
Returns the optional part number marker specified in the original request
to specify where in the results to begin listing parts.
|
java.util.List<PartSummary> |
getParts()
Returns the list of parts described in this part listing.
|
java.lang.String |
getStorageClass()
Returns the class of storage used for the parts in the associated
multipart upload.
|
java.lang.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(java.util.Date abortDate)
Date when multipart upload will become eligible for abort operation by lifecycle.
|
void |
setAbortRuleId(java.lang.String abortRuleId)
Id of the lifecycle rule that makes a multipart upload eligible for abort operation.
|
void |
setBucketName(java.lang.String bucketName)
Sets the name of the bucket containing the listed parts, as specified in
the original request.
|
void |
setEncodingType(java.lang.String encodingType)
For internal use only.
|
void |
setInitiator(Owner initiator)
Sets the user who initiated the associated multipart upload.
|
void |
setKey(java.lang.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(java.util.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(java.lang.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(java.lang.String uploadId)
Sets the upload ID value specified in the original request used to
identify which multipart upload contains the parts to list.
|
private java.lang.String bucketName
private java.lang.String key
private java.lang.String uploadId
private java.lang.Integer maxParts
private java.lang.Integer partNumberMarker
private java.lang.String encodingType
private Owner owner
private Owner initiator
private java.lang.String storageClass
private boolean isTruncated
private java.lang.Integer nextPartNumberMarker
private java.util.List<PartSummary> parts
private java.util.Date abortDate
private java.lang.String abortRuleId
private boolean isRequesterCharged
public java.lang.String getBucketName()
public void setBucketName(java.lang.String bucketName)
bucketName
- the name of the bucket containing the listed parts, as
specified in the original request.public java.lang.String getKey()
public void setKey(java.lang.String key)
key
- the key value specified in the original request used to
identify which multipart upload contains the parts to list.public java.lang.String getUploadId()
public void setUploadId(java.lang.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 java.lang.String getStorageClass()
public void setStorageClass(java.lang.String storageClass)
storageClass
- The class of storage used for the parts in the associated
multipart upload.public java.lang.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 java.lang.Integer getNextPartNumberMarker()
public void setNextPartNumberMarker(int nextPartNumberMarker)
nextPartNumberMarker
- The next part number marker.public java.lang.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 java.lang.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(java.lang.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 java.util.List<PartSummary> getParts()
public void setParts(java.util.List<PartSummary> parts)
parts
- The list of parts described in this part listing.public java.util.Date getAbortDate()
public void setAbortDate(java.util.Date abortDate)
abortDate
- The date when the upload will be eligible for abort.public java.lang.String getAbortRuleId()
public void setAbortRuleId(java.lang.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.