public class ListPartsRequest extends AmazonWebServiceRequest implements Serializable, ExpectedBucketOwnerRequest
Required Parameters: BucketName, Key, UploadId
NOOP
Constructor and Description |
---|
ListPartsRequest(String bucketName,
String key,
String uploadId)
Constructs a new ListPartsRequest from the required parameters bucket
name, key and upload ID.
|
Modifier and Type | Method and Description |
---|---|
String |
getBucketName()
Returns the name of the bucket containing the multipart upload whose
parts are being listed.
|
String |
getEncodingType()
Gets the optional
encodingType parameter indicating the
encoding method to be applied on the response. |
String |
getExpectedBucketOwner()
Returns he account id of the expected bucket owner.
|
String |
getKey()
Returns the key of the associated multipart upload whose parts are being
listed.
|
Integer |
getMaxParts()
Returns the optional maximum number of parts to be returned in the part
listing.
|
Integer |
getPartNumberMarker()
Returns the optional part number marker indicating where in the results
to being listing parts.
|
String |
getUploadId()
Returns the ID of the multipart upload whose parts are being listed.
|
boolean |
isRequesterPays()
Returns true if the user has enabled Requester Pays option when
conducting this operation from Requester Pays Bucket; else false.
|
void |
setBucketName(String bucketName)
Sets the name of the bucket containing the multipart upload whose parts
are being listed.
|
void |
setEncodingType(String encodingType)
Sets the optional
encodingType parameter indicating the
encoding method to be applied on the response. |
void |
setExpectedBucketOwner(String expectedBucketOwner)
Set the account id of the expected bucket owner.
|
void |
setKey(String key)
Sets the key of the associated multipart upload whose parts are being
listed.
|
void |
setMaxParts(int maxParts)
Sets the optional maximum number of parts to be returned in the part
listing.
|
void |
setPartNumberMarker(Integer partNumberMarker)
Sets the optional part number marker indicating where in the results to
being listing parts.
|
void |
setRequesterPays(boolean isRequesterPays)
Used for conducting this operation from a Requester Pays Bucket.
|
void |
setUploadId(String uploadId)
Sets the ID of the multipart upload whose parts are being listed.
|
ListPartsRequest |
withBucketName(String bucketName)
Sets the BucketName property for this request.
|
ListPartsRequest |
withEncodingType(String encodingType)
Sets the optional
encodingType parameter indicating the
encoding method to be applied on the response. |
ListPartsRequest |
withExpectedBucketOwner(String expectedBucketOwner)
Set the account id of the expected bucket owner.
|
ListPartsRequest |
withKey(String key)
Sets the key of the associated multipart upload whose parts are being
listed, and returns this updated ListPartsRequest object so that
additional method calls can be chained together.
|
ListPartsRequest |
withMaxParts(int maxParts)
Sets the optional maximum number of parts to be returned in the part
listing and returns this updated ListPartsRequest objects so that
additional method calls can be chained together.
|
ListPartsRequest |
withPartNumberMarker(Integer partNumberMarker)
Sets the optional part number marker indicating where in the results to
being listing parts, and returns this updated ListPartsRequest object so
that additional method calls can be chained together.
|
ListPartsRequest |
withRequesterPays(boolean isRequesterPays)
Used for conducting this operation from a Requester Pays Bucket.
|
ListPartsRequest |
withUploadId(String uploadId)
Sets the ID of the multipart upload whose parts are being listed, and
returns this updated ListPartsRequest object so that additional method
calls can be chained together.
|
addHandlerContext, clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public ListPartsRequest(String bucketName, String key, String uploadId)
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The
S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
.
When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the
Amazon S3 User Guide.
bucketName
- The name of the bucket, or access point ARN, containing the parts to list.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
.
When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts
in the Amazon S3 User Guide.
key
- The key of the associated multipart upload whose parts are
being listed.uploadId
- The ID of the multipart upload whose parts are being listed.public String getExpectedBucketOwner()
ExpectedBucketOwnerRequest
403 (Access Denied)
error.getExpectedBucketOwner
in interface ExpectedBucketOwnerRequest
public ListPartsRequest withExpectedBucketOwner(String expectedBucketOwner)
ExpectedBucketOwnerRequest
403 (Access Denied)
error.withExpectedBucketOwner
in interface ExpectedBucketOwnerRequest
public void setExpectedBucketOwner(String expectedBucketOwner)
ExpectedBucketOwnerRequest
403 (Access Denied)
error.setExpectedBucketOwner
in interface ExpectedBucketOwnerRequest
public String getBucketName()
public void setBucketName(String bucketName)
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The
S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
.
When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the
Amazon S3 User Guide.
bucketName
- The name of the bucket, or access point ARN, containing the multipart upload whose
parts are being listed.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
.
When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts
in the Amazon S3 User Guide.
public ListPartsRequest withBucketName(String bucketName)
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The
S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
.
When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the
Amazon S3 User Guide.
bucketName
- The value that BucketName is set to
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
.
When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts
in the Amazon S3 User Guide.
public String getKey()
public void setKey(String key)
key
- The key of the associated multipart upload whose parts are
being listed.public ListPartsRequest withKey(String key)
key
- The key of the associated multipart upload whose parts are
being listed.public String getUploadId()
public void setUploadId(String uploadId)
uploadId
- The ID of the multipart upload whose parts are being listed.public ListPartsRequest withUploadId(String uploadId)
uploadId
- The ID of the multipart upload whose parts are being listed.public Integer getMaxParts()
public void setMaxParts(int maxParts)
maxParts
- The optional maximum number of parts to be returned in the
part listing.public ListPartsRequest withMaxParts(int maxParts)
maxParts
- The optional maximum number of parts to be returned in the
part listing.public Integer getPartNumberMarker()
public void setPartNumberMarker(Integer partNumberMarker)
partNumberMarker
- The optional part number marker indicating where in the
results to being listing parts.public ListPartsRequest withPartNumberMarker(Integer partNumberMarker)
partNumberMarker
- The optional part number marker indicating where in the
results to being listing parts.public String getEncodingType()
encodingType
parameter indicating the
encoding method to be applied on the response.public void setEncodingType(String encodingType)
encodingType
parameter indicating the
encoding method to be applied on the response. An object key can contain
any Unicode character; however, XML 1.0 parser cannot parse some
characters, such as characters with an ASCII value from 0 to 10. For
characters that are not supported in XML 1.0, you can add this parameter
to request that Amazon S3 encode the keys in the response.encodingType
- The encoding method to be applied on the response. Valid
values: null (not encoded) or "url".public ListPartsRequest withEncodingType(String encodingType)
encodingType
parameter indicating the
encoding method to be applied on the response. An object key can contain
any Unicode character; however, XML 1.0 parser cannot parse some
characters, such as characters with an ASCII value from 0 to 10. For
characters that are not supported in XML 1.0, you can add this parameter
to request that Amazon S3 encode the keys in the response.
Returns this ListPartsRequest
, enabling additional method calls
to be chained together.encodingType
- The encoding method to be applied on the response. Valid
values: null (not encoded) or "url".public boolean isRequesterPays()
If a bucket is enabled for Requester Pays, then any attempt to upload or download an object 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
public void setRequesterPays(boolean isRequesterPays)
If a bucket is enabled for Requester Pays, then any attempt to upload or download an object 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.
isRequesterPays
- Enable Requester Pays option for the operation.public ListPartsRequest withRequesterPays(boolean isRequesterPays)
If a bucket is enabled for Requester Pays, then any attempt to upload or download an object 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.
isRequesterPays
- Enable Requester Pays option for the operation.