com.tencent.cos.xml.model.object

类 GetObjectRequest

java.lang.Object

com.tencent.cos.xml.model.CosXmlRequest

com.tencent.cos.xml.model.object.ObjectRequest

com.tencent.cos.xml.model.object.GetObjectRequest

直接已知子类:

COSXMLDownloadTask.COSXMLDownloadTaskRequest, GetSnapshotRequest, PreviewDocumentInHtmlRequest, PreviewDocumentRequest

public class GetObjectRequest
extends ObjectRequest

下载 COS 对象的请求.

另请参阅:

BaseCosXml.getObject(GetObjectRequest), BaseCosXml.getObjectAsync(GetObjectRequest, CosXmlResultListener)

嵌套类概要

从类继承的嵌套类/接口 com.tencent.cos.xml.model.CosXmlRequest

CosXmlRequest.OnRequestWeightListener

字段概要

从类继承的字段 com.tencent.cos.xml.model.object.ObjectRequest

cosPath

从类继承的字段 com.tencent.cos.xml.model.CosXmlRequest

bucket, noSignHeaders, noSignParams, priority, qCloudTaskStateListener, queryParameters, region, requestHeaders, requestURL, signSourceProvider

构造器概要

构造器

构造器和说明
GetObjectRequest(java.lang.String bucket, java.lang.String cosPath, java.lang.String savePath) GetObjectRequest 构造函数
GetObjectRequest(java.lang.String bucket, java.lang.String cosPath, java.lang.String savePath, java.lang.String saveFileName) GetObjectRequest 构造函数
GetObjectRequest(java.lang.String bucket, java.lang.String cosPath, android.net.Uri fileContentUri) GetObjectRequest 构造函数

方法概要

限定符和类型	方法和说明
java.lang.String	getDownloadPath()
android.net.Uri	getFileContentUri()
long	getFileOffset()
java.lang.String	getMethod() 获取HTTP请求方法 RequestMethod
CosXmlProgressListener	getProgressListener() 获取设置的请求进度监听器
java.util.Map<java.lang.String,java.lang.String>	getQueryString() 获取url query集合
Range	getRange() 获取设置的下载范围
java.lang.String	getRspCacheControl() 获取用户设置的Cache-Control 参数。
java.lang.String	getRspContentDispositon() 获取用户设置的Content-Disposition 参数。
java.lang.String	getRspContentEncoding() 获取用户设置的 Content-Encoding 参数。
java.lang.String	getRspContentLanguage() 获取用户设置的Content-Language 参数。
java.lang.String	getRspContentType() 获取设置的响应头Content-Type 值.
java.lang.String	getRspExpires() 获取用户设置的Content-Expires 参数。
java.lang.String	getSaveFileName() 获取文件存储在本地的文件名 如果用户没有设置，则返回null
java.lang.String	getSavePath() 获取设置的文件本地保存路径
void	setFileOffset(long fileOffset)
void	setIfMatch(java.lang.String ifMatch)
void	setIfModifiedSince(java.lang.String ifModifiedSince) 设置下载请求的 If-Modified-Since 头部.
void	setIfNONEMatch(java.lang.String ifNONEMatch)
void	setIfUnmodifiedSince(java.lang.String ifUnmodifiedSince)
void	setProgressListener(CosXmlProgressListener progressListener) 设置进度监听器
void	setRange(long start) 设置下载的范围
void	setRange(long start, long end) 设置下载的范围
void	setRspCacheControl(java.lang.String rspCacheControl) 设置响应头部中的 Cache-Control 值.
void	setRspContentDispositon(java.lang.String rspContentDispositon) 设置响应头部中的 Content-Disposition 值.
void	setRspContentEncoding(java.lang.String rspContentEncoding) 设置响应头部中的 Content-Encoding 值.
void	setRspContentLanguage(java.lang.String rspContentLanguage) 设置响应头部中的 Content-Language 值.
void	setRspContentType(java.lang.String rspContentType) 设置响应头部中的 Content-Type 值.
void	setRspExpires(java.lang.String rspExpires) 设置响应头部中的 Content-Expires 值.
void	setSaveFileName(java.lang.String saveFileName) 设置文件存储在本地的文件名
void	setSavePath(java.lang.String savePath) 设置文件的本地保存路径
void	setTrafficLimit(long limit) 单链接限速，单位为bit/s 限速值设置范围为819200~838860800，即100KB/s~100MB/s，如果超出该范围会返回400错误。
void	setVersionId(java.lang.String versionId)
protected RequestBodySerializer	xmlBuilder() 收拢xml解析

从类继承的方法 com.tencent.cos.xml.model.object.ObjectRequest

checkParameters, getContentType, getCosPath, getPath, setCosPath, setCOSServerSideEncryption, setCOSServerSideEncryptionWithCustomerKey, setCOSServerSideEncryptionWithKMS

从类继承的方法 com.tencent.cos.xml.model.CosXmlRequest

addHeader, addNoSignHeader, addNoSignParams, addQuery, attachMetrics, getBucket, getHttpTask, getKeyTime, getMetrics, getNoSignHeaders, getNoSignParams, getPriority, getQueryEncodedString, getRegion, getRequestBody, getRequestHeaders, getRequestHost, getRequestURL, getSignSourceProvider, getSTSCredentialScope, getWeight, headersHasUnsafeNonAscii, isNeedMD5, isSignInUrl, isSupportAccelerate, isSupportAccelerate, setNeedMD5, setOnRequestWeightListener, setQueryEncodedString, setQueryParameters, setRegion, setRequestHeaders, setRequestHeaders, setRequestHeaders, setRequestURL, setSign, setSign, setSign, setSign, setSign, setSignInUrl, setSignKeyTime, setSignParamsAndHeaders, setSignSourceProvider, setTask, setTaskStateListener

从类继承的方法 java.lang.Object

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

构造器详细资料

GetObjectRequest

public GetObjectRequest(java.lang.String bucket,
                        java.lang.String cosPath,
                        java.lang.String savePath)

GetObjectRequest 构造函数

参数:

bucket - 存储桶名称(cos v5 的 bucket格式为：xxx-appid, 如 bucket-1250000000)

cosPath - 远端路径，即存储到 COS 上的绝对路径

savePath - 文件下载到本地文件夹的绝对路径

GetObjectRequest

public GetObjectRequest(java.lang.String bucket,
                        java.lang.String cosPath,
                        java.lang.String savePath,
                        java.lang.String saveFileName)

GetObjectRequest 构造函数

参数:

bucket - 存储桶名称(cos v5 的 bucket格式为：xxx-appid, 如 bucket-1250000000)

cosPath - 远端路径，即存储到 COS 上的绝对路径

savePath - 文件下载到本地文件夹的绝对路径

saveFileName - 保存到本地的文件名

GetObjectRequest

public GetObjectRequest(java.lang.String bucket,
                        java.lang.String cosPath,
                        android.net.Uri fileContentUri)

GetObjectRequest 构造函数

参数:

bucket - 存储桶名称(cos v5 的 bucket格式为：xxx-appid, 如 bucket-1250000000)

cosPath - 远端路径，即存储到 COS 上的绝对路径

fileContentUri - 本地文件 Uri

方法详细资料

getFileOffset

public long getFileOffset()

setFileOffset

public void setFileOffset(long fileOffset)

setVersionId

public void setVersionId(java.lang.String versionId)

setRspContentType

public void setRspContentType(java.lang.String rspContentType)

设置响应头部中的 Content-Type 值.

参数:

rspContentType - Content-Type

getRspContentType

public java.lang.String getRspContentType()

获取设置的响应头Content-Type 值.

返回:

Content-Type 参数.

setRspContentLanguage

public void setRspContentLanguage(java.lang.String rspContentLanguage)

设置响应头部中的 Content-Language 值.

参数:

rspContentLanguage - Content-Language 参数。

getRspContentLanguage

public java.lang.String getRspContentLanguage()

获取用户设置的Content-Language 参数。

返回:

Content-Language 参数。

setRspExpires

public void setRspExpires(java.lang.String rspExpires)

设置响应头部中的 Content-Expires 值.

参数:

rspExpires - Content-Expires 参数。

getRspExpires

public java.lang.String getRspExpires()

获取用户设置的Content-Expires 参数。

返回:

Content-Expires 参数。

setRspCacheControl

public void setRspCacheControl(java.lang.String rspCacheControl)

设置响应头部中的 Cache-Control 值.

参数:

rspCacheControl - Cache-Control 参数。

getRspCacheControl

public java.lang.String getRspCacheControl()

获取用户设置的Cache-Control 参数。

返回:

Cache-Control 参数。

setRspContentDispositon

public void setRspContentDispositon(java.lang.String rspContentDispositon)

设置响应头部中的 Content-Disposition 值.

参数:

rspContentDispositon - Content-Disposition 参数。

getRspContentDispositon

public java.lang.String getRspContentDispositon()

获取用户设置的Content-Disposition 参数。

返回:

Content-Disposition 参数。

setRspContentEncoding

public void setRspContentEncoding(java.lang.String rspContentEncoding)

设置响应头部中的 Content-Encoding 值.

参数:

rspContentEncoding - Content-Encoding 参数。

getRspContentEncoding

public java.lang.String getRspContentEncoding()

获取用户设置的 Content-Encoding 参数。

返回:

Content-Encoding 参数。

setRange

public void setRange(long start,
                     long end)

设置下载的范围

参数:

start - 起点

end - 终点

setRange

public void setRange(long start)

设置下载的范围

参数:

start - 起点

getRange

public Range getRange()

获取设置的下载范围

返回:

下载范围 Range

setIfModifiedSince

public void setIfModifiedSince(java.lang.String ifModifiedSince)

设置下载请求的 If-Modified-Since 头部.
如果文件修改时间早于或等于指定时间，才返回文件内容。否则返回 412 (precondition failed)

参数:

ifModifiedSince -

setIfUnmodifiedSince

public void setIfUnmodifiedSince(java.lang.String ifUnmodifiedSince)

setIfMatch

public void setIfMatch(java.lang.String ifMatch)

setIfNONEMatch

public void setIfNONEMatch(java.lang.String ifNONEMatch)

setProgressListener

public void setProgressListener(CosXmlProgressListener progressListener)

设置进度监听器

参数:

progressListener -

getProgressListener

public CosXmlProgressListener getProgressListener()

获取设置的请求进度监听器

setSavePath

public void setSavePath(java.lang.String savePath)

设置文件的本地保存路径

参数:

savePath -

getSavePath

public java.lang.String getSavePath()

获取设置的文件本地保存路径

返回:

String

setSaveFileName

public void setSaveFileName(java.lang.String saveFileName)

设置文件存储在本地的文件名

参数:

saveFileName -

getSaveFileName

public java.lang.String getSaveFileName()

获取文件存储在本地的文件名 如果用户没有设置，则返回null

返回:

String

getDownloadPath

public java.lang.String getDownloadPath()

getFileContentUri

public android.net.Uri getFileContentUri()

getMethod

public java.lang.String getMethod()

从类复制的说明: CosXmlRequest

获取HTTP请求方法 RequestMethod

指定者:

getMethod 在类中 CosXmlRequest

返回:

HTTP请求方法

getQueryString

public java.util.Map<java.lang.String,java.lang.String> getQueryString()

从类复制的说明: CosXmlRequest

获取url query集合

覆盖:

getQueryString 在类中 CosXmlRequest

返回:

url query集合

xmlBuilder

protected RequestBodySerializer xmlBuilder()
                                    throws org.xmlpull.v1.XmlPullParserException,
                                           java.io.IOException

从类复制的说明: CosXmlRequest

收拢xml解析

覆盖:

xmlBuilder 在类中 CosXmlRequest

抛出:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

setTrafficLimit

public void setTrafficLimit(long limit)

单链接限速，单位为bit/s 限速值设置范围为819200~838860800，即100KB/s~100MB/s，如果超出该范围会返回400错误。