com.obs.services.model

Class ReadAheadRequest

java.lang.Object

com.obs.services.model.GenericRequest

com.obs.services.model.ReadAheadRequest

public class ReadAheadRequest
extends GenericRequest

Request parameters for reading ahead objects

Field Summary

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

bucketName, httpMethod, userHeaders

Constructor Summary

Constructors

Constructor and Description
ReadAheadRequest(String bucketName, String prefix) Constructor
ReadAheadRequest(String bucketName, String prefix, CacheOptionEnum cacheOption, long ttl) Constructor

Method Summary

Modifier and Type	Method and Description
CacheOptionEnum	getCacheOption() Obtain the control option of the read-ahead cache.
String	getPrefix() Obtain the name prefix of objects to be read ahead.
long	getTtl() Obtain the cache data expiration time.
void	setCacheOption(CacheOptionEnum cacheOption) Set the control option of the read-ahead cache.
void	setPrefix(String prefix) Set the name prefix of objects to be read ahead.
void	setTtl(long ttl) Set the cache data expiration time.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadAheadRequest

public ReadAheadRequest(String bucketName,
                        String prefix)

Constructor

Parameters:

bucketName - Bucket name

prefix - Name prefix of objects to be read ahead

ReadAheadRequest

public ReadAheadRequest(String bucketName,
                        String prefix,
                        CacheOptionEnum cacheOption,
                        long ttl)

Constructor

Parameters:

bucketName - Bucket name

prefix - Name prefix of objects to be read ahead

cacheOption - Control option of the read-ahead cache

ttl - Expiration time of cached data, in seconds. The value ranges from 0 to 259200 (3 days)

Method Detail

getPrefix

public String getPrefix()

Obtain the name prefix of objects to be read ahead.

Returns:

Name prefix of objects to be read ahead

setPrefix

public void setPrefix(String prefix)

Set the name prefix of objects to be read ahead.

Parameters:

prefix - Name prefix of objects to be read ahead

getCacheOption

public CacheOptionEnum getCacheOption()

Obtain the control option of the read-ahead cache.

Returns:

Control option of the read-ahead cache

setCacheOption

public void setCacheOption(CacheOptionEnum cacheOption)

Set the control option of the read-ahead cache.

Parameters:

cacheOption - Control option of the read-ahead cache

getTtl

public long getTtl()

Obtain the cache data expiration time.

Returns:

Expiration time of cached data, in seconds

setTtl

public void setTtl(long ttl)

Set the cache data expiration time.

Parameters:

ttl - Expiration time of cached data, in seconds. The value ranges from 0 to 259200 (72 hours). The default value is 24 hours.