com.obs.services.model

Class ListObjectsRequest

java.lang.Object

com.obs.services.model.GenericRequest

com.obs.services.model.ListObjectsRequest

public class ListObjectsRequest
extends GenericRequest

Parameters in a request for listing objects in a bucket

Field Summary

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

bucketName, httpMethod, userHeaders

Constructor Summary

Constructors

Constructor and Description
ListObjectsRequest()
ListObjectsRequest(String bucketName) Constructor
ListObjectsRequest(String bucketName, int maxKeys) Constructor
ListObjectsRequest(String bucketName, String prefix, String marker, String delimiter, int maxKeys) Constructor
ListObjectsRequest(String bucketName, String prefix, String marker, String delimiter, int maxKeys, String encodingType) Constructor

Method Summary

Modifier and Type	Method and Description
String	getDelimiter() Obtain the character used for grouping object names.
String	getEncodingType() Get encoding type to encode objectkeys
int	getListTimeout()
String	getMarker() Obtain the start position for listing objects.
int	getMaxKeys() Obtain the maximum number of objects to be listed.
String	getPrefix() Obtain the object name prefix used for filtering objects to be listed.
void	setDelimiter(String delimiter) Set the character used for grouping object names.
void	setEncodingType(String encodingType) Set encoding type to encode objectkeys, the value could be url
void	setListTimeout(int listTimeout)
void	setMarker(String marker) Set the start position for listing objects.
void	setMaxKeys(int maxKeys) Set the maximum number of objects to be listed.
void	setPrefix(String prefix) Set the object name prefix used for filtering objects to be listed.
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

ListObjectsRequest

public ListObjectsRequest()

ListObjectsRequest

public ListObjectsRequest(String bucketName)

Constructor

Parameters:

bucketName - Bucket name

ListObjectsRequest

public ListObjectsRequest(String bucketName,
                          int maxKeys)

Constructor

Parameters:

bucketName - Bucket name

maxKeys - Maximum number of objects to be listed

ListObjectsRequest

public ListObjectsRequest(String bucketName,
                          String prefix,
                          String marker,
                          String delimiter,
                          int maxKeys)

Constructor

Parameters:

bucketName - Bucket name

prefix - Object name prefix, used for filtering objects to be listed

marker - Start position for listing objects

delimiter - Character used for grouping object names

maxKeys - Maximum number of objects to be listed

ListObjectsRequest

public ListObjectsRequest(String bucketName,
                          String prefix,
                          String marker,
                          String delimiter,
                          int maxKeys,
                          String encodingType)

Constructor

Parameters:

bucketName - Bucket name

prefix - Object name prefix, used for filtering objects to be listed

marker - Start position for listing objects

delimiter - Character used for grouping object names

maxKeys - Maximum number of objects to be listed

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 object name prefix used for filtering objects to be listed.

Returns:

Object name prefix

setPrefix

public void setPrefix(String prefix)

Set the object name prefix used for filtering objects to be listed.

Parameters:

prefix - Object name prefix

getMarker

public String getMarker()

Obtain the start position for listing objects.

Returns:

Start position marker

setMarker

public void setMarker(String marker)

Set the start position for listing objects.

Parameters:

marker - Start position marker

getMaxKeys

public int getMaxKeys()

Obtain the maximum number of objects to be listed.

Returns:

Maximum number of objects to be listed

setMaxKeys

public void setMaxKeys(int maxKeys)

Set the maximum number of objects to be listed.

Parameters:

maxKeys - Maximum number of objects to be listed

setEncodingType

public void setEncodingType(String encodingType)

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

Parameters:

encodingType - encoding type for encoding

getDelimiter

public String getDelimiter()

Obtain the character used for grouping object names.

Returns:

Character for grouping object names

getEncodingType

public String getEncodingType()

Get encoding type to encode objectkeys

Returns:

encoding type for encoding

setDelimiter

public void setDelimiter(String delimiter)

Set the character used for grouping object names.

Parameters:

delimiter - Character for grouping object names

getListTimeout

public int getListTimeout()

setListTimeout

public void setListTimeout(int listTimeout)

toString

public String toString()

Overrides:

toString in class GenericRequest