com.obs.services.model

Class ListMultipartUploadsRequest

java.lang.Object

com.obs.services.model.GenericRequest

com.obs.services.model.ListMultipartUploadsRequest

public class ListMultipartUploadsRequest
extends GenericRequest

Parameters in a request for listing multipart uploads

Field Summary

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

bucketName, httpMethod, userHeaders

Constructor Summary

Constructors

Constructor and Description
ListMultipartUploadsRequest()
ListMultipartUploadsRequest(String bucketName) Constructor
ListMultipartUploadsRequest(String bucketName, Integer maxUploads) Constructor
ListMultipartUploadsRequest(String bucketName, String prefix, String delimiter, Integer maxUploads, String keyMarker, String uploadIdMarker) Constructor
ListMultipartUploadsRequest(String bucketName, String prefix, String delimiter, Integer maxUploads, String keyMarker, String uploadIdMarker, String encodingType) Constructor

Method Summary

Modifier and Type	Method and Description
String	getDelimiter() Obtain the character used for sorting objects involved in the multipart uploads into different groups.
String	getEncodingType() Get encoding type to encode objectkeys
String	getKeyMarker() Obtain the start position for query (sorted by object name).
Integer	getMaxUploads() Obtain the maximum number of listed multipart uploads.
String	getPrefix() Obtain the prefix of names of the returned objects involved in the multipart uploads.
String	getUploadIdMarker() Obtain the start position for query (sorted by multipart upload ID).
void	setDelimiter(String delimiter) Set the character used for sorting objects involved in the multipart uploads into different groups
void	setEncodingType(String encodingType) Set encoding type to encode objectkeys, the value could be url
void	setKeyMarker(String keyMarker) Set the start position for query (sorted by object name).
void	setMaxUploads(Integer maxUploads) Set the maximum number of listed multipart uploads.
void	setPrefix(String prefix) Set the prefix of names of the returned objects involved in the multipart uploads.
void	setUploadIdMarker(String uploadIdMarker) Set the start position for query (sorted by multipart upload ID).
String	toString()

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

ListMultipartUploadsRequest

public ListMultipartUploadsRequest()

ListMultipartUploadsRequest

public ListMultipartUploadsRequest(String bucketName)

Constructor

Parameters:

bucketName - Bucket name

ListMultipartUploadsRequest

public ListMultipartUploadsRequest(String bucketName,
                                   Integer maxUploads)

Constructor

Parameters:

bucketName - Bucket name

maxUploads - Maximum number of listed multipart uploads

ListMultipartUploadsRequest

public ListMultipartUploadsRequest(String bucketName,
                                   String prefix,
                                   String delimiter,
                                   Integer maxUploads,
                                   String keyMarker,
                                   String uploadIdMarker)

Constructor

Parameters:

bucketName - Bucket name

prefix - Prefix of names of the returned objects involved in the multipart uploads

delimiter - Character used for sorting objects involved in the multipart uploads into different groups

maxUploads - Maximum number of listed multipart uploads

keyMarker - Start position for the query

uploadIdMarker - Start position of the return result. This parameter is valid only when used together with "keyMarker". Only multipart uploads after "uploadIdMarker" of the specified "keyMarker" will be returned.

ListMultipartUploadsRequest

public ListMultipartUploadsRequest(String bucketName,
                                   String prefix,
                                   String delimiter,
                                   Integer maxUploads,
                                   String keyMarker,
                                   String uploadIdMarker,
                                   String encodingType)

Constructor

Parameters:

bucketName - Bucket name

prefix - Prefix of names of the returned objects involved in the multipart uploads

delimiter - Character used for sorting objects involved in the multipart uploads into different groups

maxUploads - Maximum number of listed multipart uploads

keyMarker - Start position for the query

uploadIdMarker - Start position of the return result. This parameter is valid only when used together with "keyMarker". Only multipart uploads after "uploadIdMarker" of the specified "keyMarker" will be returned.

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

Method Detail

getPrefix

public String getPrefix()

Obtain the prefix of names of the returned objects involved in the multipart uploads.

Returns:

Object name prefix

setPrefix

public void setPrefix(String prefix)

Set the prefix of names of the returned objects involved in the multipart uploads.

Parameters:

prefix - Object name prefix

getDelimiter

public String getDelimiter()

Obtain the character used for sorting objects involved in the multipart uploads into different groups.

Returns:

Character for grouping object names

setDelimiter

public void setDelimiter(String delimiter)

Set the character used for sorting objects involved in the multipart uploads into different groups

Parameters:

delimiter - Character for grouping object names

getKeyMarker

public String getKeyMarker()

Obtain the start position for query (sorted by object name).

Returns:

Start position for query

setKeyMarker

public void setKeyMarker(String keyMarker)

Set the start position for query (sorted by object name).

Parameters:

keyMarker - Start position for query

getUploadIdMarker

public String getUploadIdMarker()

Obtain the start position for query (sorted by multipart upload ID). This parameter is valid when used together with "keyMarker" and it specifies the start position of the returned result.

Returns:

Start position for query

setUploadIdMarker

public void setUploadIdMarker(String uploadIdMarker)

Set the start position for query (sorted by multipart upload ID). This parameter is valid when used together with "keyMarker" and it specifies the start position of the returned result.

Parameters:

uploadIdMarker - Start position for query

getMaxUploads

public Integer getMaxUploads()

Obtain the maximum number of listed multipart uploads.

Returns:

Maximum number of listed multipart uploads

setMaxUploads

public void setMaxUploads(Integer maxUploads)

Set the maximum number of listed multipart uploads.

Parameters:

maxUploads - Maximum number of listed multipart uploads

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 GenericRequest