com.ibm.cloud.objectstorage.services.s3.model

Class ListPartsRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

com.ibm.cloud.objectstorage.services.s3.model.ListPartsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, WormMirrorDestinationProvider, Serializable, Cloneable

public class ListPartsRequest
extends AmazonWebServiceRequest
implements WormMirrorDestinationProvider, Serializable

Container for the the parameters of the ListParts operation.

Required Parameters: BucketName, Key, UploadId

See Also:

AmazonS3.listParts(ListPartsRequest), Serialized Form

Field Summary

Fields inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListPartsRequest(String bucketName, String key, String uploadId) Constructs a new ListPartsRequest from the required parameters bucket name, key and upload ID.

Method Summary

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	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.
String	getWormMirrorDestination() Returns the optional mirror-destination value for WORM mirroring
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	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.
void	setWormMirrorDestination(String wormMirrorDestination) Sets the optional mirror-destination value for WORM mirroring
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	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.
ListPartsRequest	withWormMirrorDestination(String wormMirrorDestination) Sets the optional mirror-destination value for WORM mirroring and returns the updated ListPartsRequest so that additional method calls may be chained together.

Methods inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

addHandlerContext, clone, copyBaseTo, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

ListPartsRequest

public ListPartsRequest(String bucketName,
                        String key,
                        String uploadId)

Constructs a new ListPartsRequest from the required parameters bucket name, key and upload ID.

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.

Parameters:

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.

Method Detail

getBucketName

public String getBucketName()

Returns the name of the bucket containing the multipart upload whose parts are being listed.

Returns:

The name of the bucket containing the multipart upload whose parts are being listed.

setBucketName

public void setBucketName(String bucketName)

Sets the name of the bucket 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.

Parameters:

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.

withBucketName

public ListPartsRequest withBucketName(String bucketName)

Sets the BucketName property for this request.

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.

Parameters:

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.

Returns:

the request with the BucketName set

getKey

public String getKey()

Returns the key of the associated multipart upload whose parts are being listed.

Returns:

The key of the associated multipart upload whose parts are being listed.

setKey

public void setKey(String key)

Sets the key of the associated multipart upload whose parts are being listed.

Parameters:

key - The key of the associated multipart upload whose parts are being listed.

withKey

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

Parameters:

key - The key of the associated multipart upload whose parts are being listed.

Returns:

This updated ListPartsRequest object.

getUploadId

public String getUploadId()

Returns the ID of the multipart upload whose parts are being listed.

Returns:

The ID of the multipart upload whose parts are being listed.

setUploadId

public void setUploadId(String uploadId)

Sets the ID of the multipart upload whose parts are being listed.

Parameters:

uploadId - The ID of the multipart upload whose parts are being listed.

withUploadId

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

Parameters:

uploadId - The ID of the multipart upload whose parts are being listed.

Returns:

This updated ListPartsRequest object.

getMaxParts

public Integer getMaxParts()

Returns the optional maximum number of parts to be returned in the part listing.

Returns:

The optional maximum number of parts to be returned in the part listing.

setMaxParts

public void setMaxParts(int maxParts)

Sets the optional maximum number of parts to be returned in the part listing.

Parameters:

maxParts - The optional maximum number of parts to be returned in the part listing.

withMaxParts

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

Parameters:

maxParts - The optional maximum number of parts to be returned in the part listing.

Returns:

This updated ListPartsRequest object.

getPartNumberMarker

public Integer getPartNumberMarker()

Returns the optional part number marker indicating where in the results to being listing parts.

Returns:

The optional part number marker indicating where in the results to being listing parts.

setPartNumberMarker

public void setPartNumberMarker(Integer partNumberMarker)

Sets the optional part number marker indicating where in the results to being listing parts.

Parameters:

partNumberMarker - The optional part number marker indicating where in the results to being listing parts.

withPartNumberMarker

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

Parameters:

partNumberMarker - The optional part number marker indicating where in the results to being listing parts.

Returns:

This updated ListPartsRequest object.

getEncodingType

public String getEncodingType()

Gets the optional encodingType parameter indicating the encoding method to be applied on the response.

Returns:

The encoding method to be applied on the response.

setEncodingType

public void setEncodingType(String encodingType)

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

Parameters:

encodingType - The encoding method to be applied on the response. Valid values: null (not encoded) or "url".

withEncodingType

public ListPartsRequest withEncodingType(String encodingType)

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

Parameters:

encodingType - The encoding method to be applied on the response. Valid values: null (not encoded) or "url".

isRequesterPays

public boolean isRequesterPays()

Returns true if the user has enabled Requester Pays option when conducting this operation from Requester Pays Bucket; else false.

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

Returns:

true if the user has enabled Requester Pays option for conducting this operation from Requester Pays Bucket.

setRequesterPays

public void setRequesterPays(boolean isRequesterPays)

Used for conducting this operation from a Requester Pays Bucket. If set the requester is charged for requests from the bucket.

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.

Parameters:

isRequesterPays - Enable Requester Pays option for the operation.

withRequesterPays

public ListPartsRequest withRequesterPays(boolean isRequesterPays)

Used for conducting this operation from a Requester Pays Bucket. If set the requester is charged for requests from the bucket. It returns this updated ListPartsRequest object so that additional method calls can be chained together.

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.

Parameters:

isRequesterPays - Enable Requester Pays option for the operation.

Returns:

The updated ListPartsRequest object.

getWormMirrorDestination

public String getWormMirrorDestination()

Returns the optional mirror-destination value for WORM mirroring

Specified by:

getWormMirrorDestination in interface WormMirrorDestinationProvider

Returns:

The optional mirror-destination value

setWormMirrorDestination

public void setWormMirrorDestination(String wormMirrorDestination)

Sets the optional mirror-destination value for WORM mirroring

Specified by:

setWormMirrorDestination in interface WormMirrorDestinationProvider

Parameters:

wormMirrorDestination - The optional mirror-destination value for WORM mirroring

withWormMirrorDestination

public ListPartsRequest withWormMirrorDestination(String wormMirrorDestination)

Sets the optional mirror-destination value for WORM mirroring and returns the updated ListPartsRequest so that additional method calls may be chained together.

Parameters:

wormMirrorDestination - The optional mirror-destination value for WORM mirroring

Returns:

This ListPartsRequest, enabling additional method calls to be chained together.