GetObjectRequest (OBS SDK for Java 3.21.4 API)

java.lang.Object
- com.obs.services.model.GenericRequest
- - com.obs.services.model.GetObjectRequest

Direct Known Subclasses:

ReadFileRequest
```
public class GetObjectRequest
extends GenericRequest
```
下载对象的请求参数

Constructor Summary

Constructors
Constructor and Description
`GetObjectRequest()`
`GetObjectRequest(String bucketName, String objectKey)` 构造函数
`GetObjectRequest(String bucketName, String objectKey, String versionId)` 构造函数

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBucketName()` 获取桶名
`CacheOptionEnum`	`getCacheOption()` 获取预读缓存的控制选项
`String`	`getIfMatchTag()` 获取下载对象的校验值条件（相等则下载），如果对象的etag校验值与此参数指定的值相等则进行下载。否则返回412（前置条件不满足）
`Date`	`getIfModifiedSince()` 获取下载对象的时间条件（修改则下载），如果对象在此参数指定的时间之后有修改则进行下载，否则返回304（Not Modified）
`String`	`getIfNoneMatchTag()` 获取下载对象的校验值条件（不相等则下载），如果对象的etag校验值与此参数指定的值不相等则进行下载。否则返回304（Not Modified）
`Date`	`getIfUnmodifiedSince()` 获取下载对象的时间条件（未修改则下载），如果对象在此参数指定的时间之后没有修改则进行下载，否则返回412（前置条件不满足）
`String`	`getImageProcess()` 获取图片处理参数
`String`	`getObjectKey()` 获取对象名
`long`	`getProgressInterval()` 获取数据传输监听器回调的阈值，默认为100KB
`ProgressListener`	`getProgressListener()` 获取数据传输监听器
`Long`	`getRangeEnd()` 获取下载对象的结束位置
`Long`	`getRangeStart()` 获取下载对象的起始位置
`ObjectRepleaceMetadata`	`getReplaceMetadata()` 获取下载对象时需要重写的响应头信息
`Map<String,String>`	`getRequestParameters()`
`SseCHeader`	`getSseCHeader()` 获取SSE-C解密头域信息
`long`	`getTtl()` 获取缓存数据过期时间
`String`	`getVersionId()` 获取对象的版本号
`boolean`	`isAutoUnzipResponse()` 获取是否自动解压gzip压缩后的响应，默认为false，表示不自动解压说明：obs sdk使用了okhttp，在okhttp中，如果请求的时候未设置Accetp-Encoding，则okhttp会自动添加Accept-Encoding:gzip头域，并且在收到请求后，会自动解压；如果请求的时候手动设置了Accetp-Encoding头域，则不会自动解压
`void`	`setAutoUnzipResponse(boolean autoUnzipResponse)` 设置是否自动解压gzip压缩后的响应，默认为false，表示不自动解压说明：obs sdk使用了okhttp，在okhttp中，如果请求的时候未设置Accetp-Encoding，则okhttp会自动添加Accept-Encoding:gzip头域，并且在收到请求后，会自动解压；如果请求的时候手动设置了Accetp-Encoding头域，则不会自动解压
`void`	`setBucketName(String bucketName)` 设置桶名
`void`	`setCacheOption(CacheOptionEnum cacheOption)` 设置预读缓存的控制选项
`void`	`setIfMatchTag(String ifMatchTag)` 设置下载对象的校验值条件（相等则下载），如果对象的etag校验值与此参数指定的值相等则进行下载。否则返回412（前置条件不满足）
`void`	`setIfModifiedSince(Date ifModifiedSince)` 设置下载对象的时间条件（修改则下载），如果对象在此参数指定的时间之后有修改则进行下载，否则返回304（Not Modified）
`void`	`setIfNoneMatchTag(String ifNoneMatchTag)` 设置下载对象的校验值条件（不相等则下载），如果对象的etag校验值与此参数指定的值不相等则进行下载。否则返回304（Not Modified）
`void`	`setIfUnmodifiedSince(Date ifUnmodifiedSince)` 设置下载对象的时间条件（未修改则下载），如果对象在此参数指定的时间之后没有修改则进行下载，否则返回412（前置条件不满足）
`void`	`setImageProcess(String imageProcess)` 设置图片处理参数
`void`	`setObjectKey(String objectKey)` 设置对象名
`void`	`setProgressInterval(long progressInterval)` 设置数据传输监听器回调的阈值，默认为100KB
`void`	`setProgressListener(ProgressListener progressListener)` 设置数据传输监听器
`void`	`setRangeEnd(Long rangeEnd)` 设置下载对象的结束位置
`void`	`setRangeStart(Long rangeStart)` 设置下载对象的起始位置
`void`	`setReplaceMetadata(ObjectRepleaceMetadata replaceMetadata)` 设置下载对象时需要重写的响应头信息
`void`	`setRequestParameters(Map<String,String> requestParameters)`
`void`	`setSseCHeader(SseCHeader sseCHeader)` 设置SSE-C解密头域信息
`void`	`setTtl(long ttl)` 设置缓存数据过期时间
`void`	`setVersionId(String versionId)` 设置对象的版本号
`String`	`toString()`

Methods inherited from class com.obs.services.model.GenericRequest
isRequesterPays, setRequesterPays

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetObjectRequest
```
public GetObjectRequest()
```
  - GetObjectRequest
```
public GetObjectRequest(String bucketName,
                        String objectKey)
```
    构造函数
    
    Parameters:
    
    bucketName - 桶名
    
    objectKey - 对象名
  - GetObjectRequest
```
public GetObjectRequest(String bucketName,
                        String objectKey,
                        String versionId)
```
    构造函数
    
    Parameters:
    
    bucketName - 桶名
    
    objectKey - 对象名
    
    versionId - 对象的版本号
- Method Detail
  - getReplaceMetadata
```
public ObjectRepleaceMetadata getReplaceMetadata()
```
    获取下载对象时需要重写的响应头信息
    
    Returns:
    
    重写的响应头信息
  - setReplaceMetadata
```
public void setReplaceMetadata(ObjectRepleaceMetadata replaceMetadata)
```
    设置下载对象时需要重写的响应头信息
    
    Parameters:
    
    replaceMetadata - 重写的响应头信息
  - getSseCHeader
```
public SseCHeader getSseCHeader()
```
    获取SSE-C解密头域信息
    
    Returns:
    
    SSE-C解密头域信息
  - setSseCHeader
```
public void setSseCHeader(SseCHeader sseCHeader)
```
    设置SSE-C解密头域信息
    
    Parameters:
    
    sseCHeader - SSE-C解密头域信息
  - getRangeStart
```
public Long getRangeStart()
```
    获取下载对象的起始位置
    
    Returns:
    
    下载对象的起始位置
  - setRangeStart
```
public void setRangeStart(Long rangeStart)
```
    设置下载对象的起始位置
    
    Parameters:
    
    rangeStart - 下载对象的起始位置
  - getRangeEnd
```
public Long getRangeEnd()
```
    获取下载对象的结束位置
    
    Returns:
    
    下载对象的结束位置
  - setRangeEnd
```
public void setRangeEnd(Long rangeEnd)
```
    设置下载对象的结束位置
    
    Parameters:
    
    rangeEnd - 下载对象的结束位置
  - getBucketName
```
public String getBucketName()
```
    获取桶名
    
    Returns:
    
    桶名
  - setBucketName
```
public void setBucketName(String bucketName)
```
    设置桶名
    
    Parameters:
    
    bucketName - 桶名
  - getObjectKey
```
public String getObjectKey()
```
    获取对象名
    
    Returns:
    
    对象名
  - setObjectKey
```
public void setObjectKey(String objectKey)
```
    设置对象名
    
    Parameters:
    
    objectKey - 对象名
  - getVersionId
```
public String getVersionId()
```
    获取对象的版本号
    
    Returns:
    
    对象的版本号
  - setVersionId
```
public void setVersionId(String versionId)
```
    设置对象的版本号
    
    Parameters:
    
    versionId - 对象的版本号
  - getIfModifiedSince
```
public Date getIfModifiedSince()
```
    获取下载对象的时间条件（修改则下载），如果对象在此参数指定的时间之后有修改则进行下载，否则返回304（Not Modified）
    
    Returns:
    
    下载对象的时间条件
  - setIfModifiedSince
```
public void setIfModifiedSince(Date ifModifiedSince)
```
    设置下载对象的时间条件（修改则下载），如果对象在此参数指定的时间之后有修改则进行下载，否则返回304（Not Modified）
    
    Parameters:
    
    ifModifiedSince - 下载对象的时间条件
  - getIfUnmodifiedSince
```
public Date getIfUnmodifiedSince()
```
    获取下载对象的时间条件（未修改则下载），如果对象在此参数指定的时间之后没有修改则进行下载，否则返回412（前置条件不满足）
    
    Returns:
    
    下载对象的时间条件
  - setIfUnmodifiedSince
```
public void setIfUnmodifiedSince(Date ifUnmodifiedSince)
```
    设置下载对象的时间条件（未修改则下载），如果对象在此参数指定的时间之后没有修改则进行下载，否则返回412（前置条件不满足）
    
    Parameters:
    
    ifUnmodifiedSince - 下载对象的时间条件
  - getIfMatchTag
```
public String getIfMatchTag()
```
    获取下载对象的校验值条件（相等则下载），如果对象的etag校验值与此参数指定的值相等则进行下载。否则返回412（前置条件不满足）
    
    Returns:
    
    下载对象的校验值条件
  - setIfMatchTag
```
public void setIfMatchTag(String ifMatchTag)
```
    设置下载对象的校验值条件（相等则下载），如果对象的etag校验值与此参数指定的值相等则进行下载。否则返回412（前置条件不满足）
    
    Parameters:
    
    ifMatchTag - 下载对象的校验值条件
  - getIfNoneMatchTag
```
public String getIfNoneMatchTag()
```
    获取下载对象的校验值条件（不相等则下载），如果对象的etag校验值与此参数指定的值不相等则进行下载。否则返回304（Not Modified）
    
    Returns:
    
    下载对象的校验值条件
  - setIfNoneMatchTag
```
public void setIfNoneMatchTag(String ifNoneMatchTag)
```
    设置下载对象的校验值条件（不相等则下载），如果对象的etag校验值与此参数指定的值不相等则进行下载。否则返回304（Not Modified）
    
    Parameters:
    
    ifNoneMatchTag - 下载对象的校验值条件
  - getImageProcess
```
public String getImageProcess()
```
    获取图片处理参数
    
    Returns:
    
    图片处理参数
  - setImageProcess
```
public void setImageProcess(String imageProcess)
```
    设置图片处理参数
    
    Parameters:
    
    imageProcess - 图片处理参数
  - getProgressListener
```
public ProgressListener getProgressListener()
```
    获取数据传输监听器
    
    Returns:
    
    数据传输监听器
  - setProgressListener
```
public void setProgressListener(ProgressListener progressListener)
```
    设置数据传输监听器
    
    Parameters:
    
    progressListener - 数据传输监听器
  - getProgressInterval
```
public long getProgressInterval()
```
    获取数据传输监听器回调的阈值，默认为100KB
    
    Returns:
    
    数据传输监听器回调的阈值
  - setProgressInterval
```
public void setProgressInterval(long progressInterval)
```
    设置数据传输监听器回调的阈值，默认为100KB
    
    Parameters:
    
    progressInterval - 数据传输监听器回调的阈值
  - getRequestParameters
```
public Map<String,String> getRequestParameters()
```
  - getCacheOption
```
public CacheOptionEnum getCacheOption()
```
    获取预读缓存的控制选项
    
    Returns:
    
    预读缓存的控制选项
  - setCacheOption
```
public void setCacheOption(CacheOptionEnum cacheOption)
```
    设置预读缓存的控制选项
    
    Parameters:
    
    cacheOption - 预读缓存的控制选项
  - getTtl
```
public long getTtl()
```
    获取缓存数据过期时间
    
    Returns:
    
    缓存数据过期时间
  - setTtl
```
public void setTtl(long ttl)
```
    设置缓存数据过期时间
    
    Parameters:
    
    ttl - 缓存数据过期时间
  - setRequestParameters
```
public void setRequestParameters(Map<String,String> requestParameters)
```
  - isAutoUnzipResponse
```
public boolean isAutoUnzipResponse()
```
    获取是否自动解压gzip压缩后的响应，默认为false，表示不自动解压
    说明：obs sdk使用了okhttp，在okhttp中，如果请求的时候未设置Accetp-Encoding，则okhttp会自动添加Accept-Encoding:gzip头域，并且在收到请求后，会自动解压；
    如果请求的时候手动设置了Accetp-Encoding头域，则不会自动解压
    
    Returns:
    
    Since:
    
    3.20.5
    
    See Also:
    
    BridgeInterceptor
  - setAutoUnzipResponse
```
public void setAutoUnzipResponse(boolean autoUnzipResponse)
```
    设置是否自动解压gzip压缩后的响应，默认为false，表示不自动解压
    说明：obs sdk使用了okhttp，在okhttp中，如果请求的时候未设置Accetp-Encoding，则okhttp会自动添加Accept-Encoding:gzip头域，并且在收到请求后，会自动解压；
    如果请求的时候手动设置了Accetp-Encoding头域，则不会自动解压
    
    Parameters:
    
    autoUnzipResponse -
    
    Since:
    
    3.20.5
    
    See Also:
    
    BridgeInterceptor
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class GenericRequest

Class GetObjectRequest

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

GetObjectRequest

GetObjectRequest

GetObjectRequest

Method Detail

getReplaceMetadata

setReplaceMetadata

getSseCHeader

setSseCHeader

getRangeStart

setRangeStart

getRangeEnd

setRangeEnd

getBucketName

setBucketName

getObjectKey

setObjectKey

getVersionId

setVersionId

getIfModifiedSince

setIfModifiedSince

getIfUnmodifiedSince

setIfUnmodifiedSince

getIfMatchTag

setIfMatchTag

getIfNoneMatchTag

setIfNoneMatchTag

getImageProcess

setImageProcess

getProgressListener

setProgressListener

getProgressInterval

setProgressInterval

getRequestParameters

getCacheOption

setCacheOption

getTtl

setTtl

setRequestParameters

isAutoUnzipResponse

setAutoUnzipResponse

toString