com.tencent.cos.xml.model.object

类 BasePutObjectRequest

java.lang.Object

com.tencent.cos.xml.model.CosXmlRequest

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

com.tencent.cos.xml.model.object.UploadRequest

com.tencent.cos.xml.model.object.BasePutObjectRequest

直接已知子类:

PutObjectRequest

public class BasePutObjectRequest
extends UploadRequest

简单上传的请求.

另请参阅:

BaseCosXml.basePutObject(BasePutObjectRequest), BaseCosXml.basePutObjectAsync(BasePutObjectRequest, CosXmlResultListener)

嵌套类概要

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

CosXmlRequest.OnRequestWeightListener

字段概要

字段

限定符和类型	字段和说明
protected byte[]	data
protected long	fileLength
protected java.io.InputStream	inputStream
protected CosXmlProgressListener	progressListener
protected java.lang.String	srcPath
protected java.lang.String	strData
protected android.net.Uri	uri
protected java.net.URL	url
protected UrlUploadPolicy	urlUploadPolicy

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

cosPath

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

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

构造器概要

构造器

限定符	构造器和说明
protected	BasePutObjectRequest(java.lang.String bucket, java.lang.String cosPath)
	BasePutObjectRequest(java.lang.String bucket, java.lang.String cosPath, byte[] data) PutObject 构造方法
	BasePutObjectRequest(java.lang.String bucket, java.lang.String cosPath, java.io.InputStream inputStream) PutObject 构造方法
	BasePutObjectRequest(java.lang.String bucket, java.lang.String cosPath, java.lang.String srcPath) PutObject 构造方法
	BasePutObjectRequest(java.lang.String bucket, java.lang.String cosPath, java.lang.StringBuilder stringBuilder) PutObject 构造方法
	BasePutObjectRequest(java.lang.String bucket, java.lang.String cosPath, android.net.Uri uri)
	BasePutObjectRequest(java.lang.String bucket, java.lang.String cosPath, java.net.URL url) PutObject 构造方法

方法概要

限定符和类型	方法和说明
void	checkParameters() sdk 参数校验
byte[]	getData() 获取用户设置的字节数组
long	getFileLength() 获取待上传数据的总长度
java.io.InputStream	getInputStream()
java.lang.String	getMethod() 获取HTTP请求方法 RequestMethod
CosXmlProgressListener	getProgressListener()
java.lang.String	getSrcPath() 获取设置的本地文件路径
java.lang.String	getStrData()
android.net.Uri	getUri()
java.net.URL	getUrl()
UrlUploadPolicy	getUrlUploadPolicy()
boolean	isPriorityLow()
void	setData(byte[] data) 设置上传的字节数组.
void	setInputStream(java.io.InputStream inputStream)
void	setPriorityLow()
void	setProgressListener(CosXmlProgressListener progressListener) 上传进度回调
void	setSrcPath(java.lang.String srcPath) 设置上传的本地文件路径.
void	setStrData(java.lang.String strData)
void	setTrafficLimit(long limit) 单链接限速，单位为bit/s 限速值设置范围为819200~838860800，即100KB/s~100MB/s，如果超出该范围会返回400错误。
void	setUri(android.net.Uri uri)
void	setUrl(java.net.URL url)
void	setUrlUploadPolicy(UrlUploadPolicy urlUploadPolicy) 设置URL上传策略
protected RequestBodySerializer	xmlBuilder() 收拢xml解析

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

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, getQueryString, 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

字段详细资料

srcPath

protected java.lang.String srcPath

data

protected byte[] data

inputStream

protected java.io.InputStream inputStream

strData

protected java.lang.String strData

url

protected java.net.URL url

urlUploadPolicy

protected UrlUploadPolicy urlUploadPolicy

fileLength

protected long fileLength

uri

protected android.net.Uri uri

progressListener

protected CosXmlProgressListener progressListener

构造器详细资料

BasePutObjectRequest

protected BasePutObjectRequest(java.lang.String bucket,
                               java.lang.String cosPath)

BasePutObjectRequest

public BasePutObjectRequest(java.lang.String bucket,
                            java.lang.String cosPath,
                            java.lang.String srcPath)

PutObject 构造方法

参数:

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

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

srcPath - 本地文件的绝对路径

BasePutObjectRequest

public BasePutObjectRequest(java.lang.String bucket,
                            java.lang.String cosPath,
                            android.net.Uri uri)

BasePutObjectRequest

public BasePutObjectRequest(java.lang.String bucket,
                            java.lang.String cosPath,
                            byte[] data)

PutObject 构造方法

参数:

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

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

data - 上传的数据

BasePutObjectRequest

public BasePutObjectRequest(java.lang.String bucket,
                            java.lang.String cosPath,
                            java.lang.StringBuilder stringBuilder)

PutObject 构造方法

参数:

bucket - 存储桶名称

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

stringBuilder - 上传的字符串

BasePutObjectRequest

public BasePutObjectRequest(java.lang.String bucket,
                            java.lang.String cosPath,
                            java.io.InputStream inputStream)

PutObject 构造方法

参数:

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

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

inputStream - 上传的数据流

BasePutObjectRequest

public BasePutObjectRequest(java.lang.String bucket,
                            java.lang.String cosPath,
                            java.net.URL url)

PutObject 构造方法

参数:

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

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

url - 上传的url

方法详细资料

getMethod

public java.lang.String getMethod()

从类复制的说明: CosXmlRequest

获取HTTP请求方法 RequestMethod

指定者:

getMethod 在类中 CosXmlRequest

返回:

HTTP请求方法

setPriorityLow

public void setPriorityLow()

isPriorityLow

public boolean isPriorityLow()

xmlBuilder

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

从类复制的说明: CosXmlRequest

收拢xml解析

覆盖:

xmlBuilder 在类中 CosXmlRequest

抛出:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

checkParameters

public void checkParameters()
                     throws CosXmlClientException

从类复制的说明: CosXmlRequest

sdk 参数校验

覆盖:

checkParameters 在类中 ObjectRequest

抛出:

CosXmlClientException - cosXmlClientException

setProgressListener

public void setProgressListener(CosXmlProgressListener progressListener)

上传进度回调

参数:

progressListener - 进度监听器 CosXmlProgressListener

getProgressListener

public CosXmlProgressListener getProgressListener()

setSrcPath

public void setSrcPath(java.lang.String srcPath)

设置上传的本地文件路径.
可以设置上传本地文件、字节数组或者输入流。每次只能上传一种类型，若同时设置， 则优先级为 本地文件>字节数组>输入流

参数:

srcPath - 本地文件路径

getSrcPath

public java.lang.String getSrcPath()

获取设置的本地文件路径

返回:

String

setData

public void setData(byte[] data)

设置上传的字节数组.
可以设置上传本地文件、字节数组或者输入流。每次只能上传一种类型，若同时设置， 则优先级为 本地文件>字节数组>输入流

参数:

data - 需要上传的字节数组

setStrData

public void setStrData(java.lang.String strData)

getStrData

public java.lang.String getStrData()

getUrl

public java.net.URL getUrl()

getUrlUploadPolicy

public UrlUploadPolicy getUrlUploadPolicy()

setUrl

public void setUrl(java.net.URL url)

setUri

public void setUri(android.net.Uri uri)

getUri

public android.net.Uri getUri()

getInputStream

public java.io.InputStream getInputStream()

setInputStream

public void setInputStream(java.io.InputStream inputStream)

getData

public byte[] getData()

获取用户设置的字节数组

返回:

byte[]

getFileLength

public long getFileLength()

获取待上传数据的总长度

返回:

long

setTrafficLimit

public void setTrafficLimit(long limit)

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

setUrlUploadPolicy

public void setUrlUploadPolicy(UrlUploadPolicy urlUploadPolicy)

设置URL上传策略

参数:

urlUploadPolicy - url上传策略