com.obs.services.model

Class ListPartsRequest

java.lang.Object

com.obs.services.model.GenericRequest

com.obs.services.model.BaseObjectRequest

com.obs.services.model.ListPartsRequest

public class ListPartsRequest
extends BaseObjectRequest

Parameters in a request for listing uploaded parts

Field Summary

Fields inherited from class com.obs.services.model.BaseObjectRequest

encodeHeaders, objectKey

Fields inherited from class com.obs.services.model.GenericRequest

bucketName, httpMethod, userHeaders

Constructor Summary

Constructors

Constructor and Description
ListPartsRequest()
ListPartsRequest(String bucketName, String objectKey) Constructor
ListPartsRequest(String bucketName, String objectKey, String uploadId) Constructor
ListPartsRequest(String bucketName, String objectKey, String uploadId, Integer maxParts) Constructor
ListPartsRequest(String bucketName, String objectKey, String uploadId, Integer maxParts, Integer partNumberMarker) Constructor
ListPartsRequest(String bucketName, String objectKey, String uploadId, Integer maxParts, Integer partNumberMarker, String encodingType) Constructor

Method Summary

Modifier and Type	Method and Description
String	getEncodingType() Get encoding type to encode objectkeys
String	getKey() Deprecated.
Integer	getMaxParts() Obtain the maximum number of uploaded parts that can be listed.
Integer	getPartNumberMarker() Obtain the start position for listing parts.
String	getUploadId() Obtain the multipart upload ID.
void	setEncodingType(String encodingType) Set encoding type to encode objectkeys, the value could be url
void	setKey(String objectKey) Deprecated.
void	setMaxParts(Integer maxParts) Set the maximum number of uploaded parts that can be listed.
void	setPartNumberMarker(Integer partNumberMarker) Set the start position for listing parts.
void	setUploadId(String uploadId) Set the multipart upload ID.
String	toString()

Methods inherited from class com.obs.services.model.BaseObjectRequest

getObjectKey, isEncodeHeaders, setIsEncodeHeaders, setObjectKey

Methods inherited from class com.obs.services.model.GenericRequest

addUserHeaders, getBucketName, getHttpMethod, getUserHeaders, isRequesterPays, setBucketName, setRequesterPays, setUserHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

ListPartsRequest

public ListPartsRequest()

ListPartsRequest

public ListPartsRequest(String bucketName,
                        String objectKey)

Constructor

Parameters:

bucketName - Name of the bucket to which the multipart upload belongs

objectKey - Name of the object involved in the multipart upload

ListPartsRequest

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

Constructor

Parameters:

bucketName - Name of the bucket to which the multipart upload belongs

objectKey - Name of the object involved in the multipart upload

uploadId - Multipart upload ID

ListPartsRequest

public ListPartsRequest(String bucketName,
                        String objectKey,
                        String uploadId,
                        Integer maxParts)

Constructor

Parameters:

bucketName - Name of the bucket to which the multipart upload belongs

objectKey - Name of the object involved in the multipart upload

uploadId - Multipart upload ID

maxParts - Maximum number of uploaded parts that can be listed

ListPartsRequest

public ListPartsRequest(String bucketName,
                        String objectKey,
                        String uploadId,
                        Integer maxParts,
                        Integer partNumberMarker)

Constructor

Parameters:

bucketName - Name of the bucket to which the multipart upload belongs

objectKey - Name of the object involved in the multipart upload

uploadId - Multipart upload ID

maxParts - Maximum number of uploaded parts that can be listed

partNumberMarker - Start position for listing parts

ListPartsRequest

public ListPartsRequest(String bucketName,
                        String objectKey,
                        String uploadId,
                        Integer maxParts,
                        Integer partNumberMarker,
                        String encodingType)

Constructor

Parameters:

bucketName - Name of the bucket to which the multipart upload belongs

objectKey - Name of the object involved in the multipart upload

uploadId - Multipart upload ID

maxParts - Maximum number of uploaded parts that can be listed

partNumberMarker - Start position for listing parts

encodingType - Use this encoding type to encode keys that contains invalid characters, the value could be "url"

Method Detail

getKey

@Deprecated
public String getKey()

Deprecated.

setKey

@Deprecated
public void setKey(String objectKey)

Deprecated.

getUploadId

public String getUploadId()

Obtain the multipart upload ID.

Returns:

Multipart upload ID

setUploadId

public void setUploadId(String uploadId)

Set the multipart upload ID.

Parameters:

uploadId - Multipart upload ID

getMaxParts

public Integer getMaxParts()

Obtain the maximum number of uploaded parts that can be listed.

Returns:

Maximum number of uploaded parts that can be listed

setMaxParts

public void setMaxParts(Integer maxParts)

Set the maximum number of uploaded parts that can be listed.

Parameters:

maxParts - Maximum number of uploaded parts that can be listed

getPartNumberMarker

public Integer getPartNumberMarker()

Obtain the start position for listing parts.

Returns:

Start position for listing parts

setPartNumberMarker

public void setPartNumberMarker(Integer partNumberMarker)

Set the start position for listing parts.

Parameters:

partNumberMarker - Start position for listing parts

setEncodingType

public void setEncodingType(String encodingType)

Set encoding type to encode objectkeys, the value could be url

Parameters:

encodingType - encoding type for encoding

getEncodingType

public String getEncodingType()

Get encoding type to encode objectkeys

Returns:

encoding type for encoding

toString

public String toString()

Overrides:

toString in class BaseObjectRequest