类 GetObjectRequest
- java.lang.Object
-
- com.tencent.cos.xml.model.CosXmlRequest
-
- com.tencent.cos.xml.model.object.ObjectRequest
-
- com.tencent.cos.xml.model.object.GetObjectRequest
-
- 所有已实现的接口:
SaveLocalRequest
public class GetObjectRequest extends ObjectRequest implements SaveLocalRequest
下载 COS 对象的请求.
-
-
嵌套类概要
-
从类继承的嵌套类/接口 com.tencent.cos.xml.model.CosXmlRequest
CosXmlRequest.OnRequestWeightListener, CosXmlRequest.RequestNetworkType
-
-
字段概要
-
从类继承的字段 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, android.net.Uri fileContentUri)GetObjectRequest 构造函数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 构造函数
-
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 voidcheckParameters()sdk 参数校验java.lang.StringgetDownloadPath()android.net.UrigetFileContentUri()longgetFileOffset()java.lang.StringgetMethod()获取HTTP请求方法RequestMethodCosXmlProgressListenergetProgressListener()获取设置的请求进度监听器java.util.Map<java.lang.String,java.lang.String>getQueryString()获取url query集合RangegetRange()获取设置的下载范围java.lang.StringgetRspCacheControl()获取用户设置的Cache-Control 参数。java.lang.StringgetRspContentDispositon()获取用户设置的Content-Disposition 参数。java.lang.StringgetRspContentEncoding()获取用户设置的 Content-Encoding 参数。java.lang.StringgetRspContentLanguage()获取用户设置的Content-Language 参数。java.lang.StringgetRspContentType()获取设置的响应头Content-Type 值.java.lang.StringgetRspExpires()获取用户设置的Content-Expires 参数。java.lang.StringgetSaveFileName()获取文件存储在本地的文件名 如果用户没有设置,则返回nulllonggetSaveLocalOffset()java.lang.StringgetSaveLocalPath()获取文件本地保存路径android.net.UrigetSaveLocalUri()获取文件本地保存urijava.lang.StringgetSavePath()获取设置的文件本地保存路径booleanisObjectKeySimplifyCheck()voidsetFileOffset(long fileOffset)voidsetIfMatch(java.lang.String ifMatch)voidsetIfModifiedSince(java.lang.String ifModifiedSince)设置下载请求的 If-Modified-Since 头部.
如果文件修改时间早于或等于指定时间,才返回文件内容。voidsetIfNONEMatch(java.lang.String ifNONEMatch)voidsetIfUnmodifiedSince(java.lang.String ifUnmodifiedSince)voidsetObjectKeySimplifyCheck(boolean objectKeySimplifyCheck)设置是否校验cosPath归并后是否符合规范,默认为truevoidsetProgressListener(CosXmlProgressListener progressListener)设置进度监听器voidsetRange(long start)设置下载的范围voidsetRange(long start, long end)设置下载的范围voidsetRspCacheControl(java.lang.String rspCacheControl)设置响应头部中的 Cache-Control 值.voidsetRspContentDispositon(java.lang.String rspContentDispositon)设置响应头部中的 Content-Disposition 值.voidsetRspContentEncoding(java.lang.String rspContentEncoding)设置响应头部中的 Content-Encoding 值.voidsetRspContentLanguage(java.lang.String rspContentLanguage)设置响应头部中的 Content-Language 值.voidsetRspContentType(java.lang.String rspContentType)设置响应头部中的 Content-Type 值.voidsetRspExpires(java.lang.String rspExpires)设置响应头部中的 Content-Expires 值.voidsetSaveFileName(java.lang.String saveFileName)设置文件存储在本地的文件名voidsetSavePath(java.lang.String savePath)设置文件的本地保存路径voidsetTrafficLimit(long limit)voidsetVersionId(java.lang.String versionId)protected com.tencent.qcloud.core.http.RequestBodySerializerxmlBuilder()收拢xml解析-
从类继承的方法 com.tencent.cos.xml.model.object.ObjectRequest
getContentType, getCosPath, getPath, setCosPath, setCOSServerSideEncryption, setCOSServerSideEncryptionWithCustomerKey, setCOSServerSideEncryptionWithKMS
-
从类继承的方法 com.tencent.cos.xml.model.CosXmlRequest
addHeader, addNoSignHeader, addNoSignHeader, addNoSignParams, addQuery, attachMetrics, getBucket, getClientTraceId, getCredentialProvider, getHost, getHttpTask, getKeyTime, getMetrics, getNetworkType, getNoSignHeaders, getNoSignParams, getPriority, getQueryEncodedString, getRegion, getRequestBody, getRequestHeaders, getRequestHost, getRequestURL, getSignSourceProvider, getSTSCredentialScope, getWeight, headersHasUnsafeNonAscii, isNeedMD5, isSignInUrl, isSupportAccelerate, isSupportAccelerate, setClientTraceId, setCredential, setCredentialProvider, setHost, setNeedMD5, setNetworkType, setOnRequestWeightListener, setQueryEncodedString, setQueryParameters, setRegion, setRequestHeaders, setRequestHeaders, setRequestHeaders, setRequestURL, setSign, setSign, setSign, setSign, setSign, setSign, setSignInUrl, setSignKeyTime, setSignParamsAndHeaders, setSignSourceProvider, setTask, setTaskStateListener
-
-
-
-
构造器详细资料
-
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- 起点
-
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
-
setObjectKeySimplifyCheck
public void setObjectKeySimplifyCheck(boolean objectKeySimplifyCheck)
设置是否校验cosPath归并后是否符合规范,默认为true- 参数:
objectKeySimplifyCheck- 是否校验cosPath归并后是否符合规范
-
isObjectKeySimplifyCheck
public boolean isObjectKeySimplifyCheck()
-
getDownloadPath
public java.lang.String getDownloadPath()
-
getFileContentUri
public android.net.Uri getFileContentUri()
-
getSaveLocalPath
public java.lang.String getSaveLocalPath()
从接口复制的说明:SaveLocalRequest获取文件本地保存路径- 指定者:
getSaveLocalPath在接口中SaveLocalRequest- 返回:
- 本地保存路径
-
getSaveLocalUri
public android.net.Uri getSaveLocalUri()
从接口复制的说明:SaveLocalRequest获取文件本地保存uri- 指定者:
getSaveLocalUri在接口中SaveLocalRequest- 返回:
- 本地保存uri
-
getSaveLocalOffset
public long getSaveLocalOffset()
- 指定者:
getSaveLocalOffset在接口中SaveLocalRequest
-
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 com.tencent.qcloud.core.http.RequestBodySerializer xmlBuilder() throws org.xmlpull.v1.XmlPullParserException, java.io.IOException从类复制的说明:CosXmlRequest收拢xml解析- 覆盖:
xmlBuilder在类中CosXmlRequest- 抛出:
org.xmlpull.v1.XmlPullParserExceptionjava.io.IOException
-
setTrafficLimit
public void setTrafficLimit(long limit)
-
checkParameters
public void checkParameters() throws CosXmlClientException从类复制的说明:CosXmlRequestsdk 参数校验- 覆盖:
checkParameters在类中ObjectRequest- 抛出:
CosXmlClientException- cosXmlClientException
-
-