com.tencent.cos.xml.model.object

类 SelectObjectContentRequest

java.lang.Object

com.tencent.cos.xml.model.CosXmlRequest

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

com.tencent.cos.xml.model.object.SelectObjectContentRequest

public class SelectObjectContentRequest
extends ObjectRequest

使用结构化查询语句从指定对象（CSV 格式或者 JSON 格式）中检索内容的请求.

另请参阅:

CosXml.selectObjectContent(SelectObjectContentRequest), CosXml.selectObjectContentAsync(SelectObjectContentRequest, CosXmlResultListener)

嵌套类概要

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

CosXmlRequest.OnRequestWeightListener

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	EXPRESSION_TYPE_SQL

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

cosPath

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

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

构造器概要

构造器

构造器和说明
SelectObjectContentRequest(java.lang.String bucket, java.lang.String cosPath, java.lang.String sql, boolean requestProgress, InputSerialization inputSerialization, OutputSerialization outputSerialization) 构建对象检索请求（默认SQL检索）
SelectObjectContentRequest(java.lang.String bucket, java.lang.String cosPath, java.lang.String expressionType, java.lang.String expression, RequestProgress requestProgress, InputSerialization inputSerialization, OutputSerialization outputSerialization) 构建对象检索请求

方法概要

限定符和类型	方法和说明
java.lang.String	getMethod() 获取HTTP请求方法 RequestMethod
java.util.Map<java.lang.String,java.lang.String>	getQueryString() 获取url query集合
SelectObjectContentListener	getSelectObjectContentProgressListener() 获取检索进度监听器
java.lang.String	getSelectResponseFilePath() 获取响应保存文件路径
boolean	isNeedMD5() 针对有请求体的 PUT 和 POST 请求，此头部是必选项。
void	setSelectObjectContentProgressListener(SelectObjectContentListener selectObjectContentProgressListener) 设置检索进度监听器
void	setSelectResponseFilePath(java.lang.String selectResponseFilePath) 设置响应保存文件路径
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, 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

字段详细资料

EXPRESSION_TYPE_SQL

public static final java.lang.String EXPRESSION_TYPE_SQL

另请参阅:

常量字段值

构造器详细资料

SelectObjectContentRequest

public SelectObjectContentRequest(java.lang.String bucket,
                                  java.lang.String cosPath,
                                  java.lang.String expressionType,
                                  java.lang.String expression,
                                  RequestProgress requestProgress,
                                  InputSerialization inputSerialization,
                                  OutputSerialization outputSerialization)

构建对象检索请求

参数:

bucket - 存储桶名

cosPath - 对象cos路径

expressionType - 表达式类型，该项为扩展项，目前只支持 SQL 表达式，仅支持 SQL 参数

expression - SQL 表达式，代表您需要发起的检索操作 请参考：Select 命令

requestProgress - 是否需要返回查询进度 QueryProgress 信息，如果选中 COS Select 将周期性返回查询进度

inputSerialization - 描述待检索对象的格式

outputSerialization - 描述检索结果的输出格式

SelectObjectContentRequest

public SelectObjectContentRequest(java.lang.String bucket,
                                  java.lang.String cosPath,
                                  java.lang.String sql,
                                  boolean requestProgress,
                                  InputSerialization inputSerialization,
                                  OutputSerialization outputSerialization)

构建对象检索请求（默认SQL检索）

参数:

bucket - 存储桶名

cosPath - 对象cos路径

sql - SQL 表达式，代表您需要发起的检索操作 请参考：Select 命令

requestProgress - 是否需要返回查询进度 QueryProgress 信息，如果选中 COS Select 将周期性返回查询进度

inputSerialization - 描述待检索对象的格式

outputSerialization - 描述检索结果的输出格式

方法详细资料

getQueryString

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

从类复制的说明: CosXmlRequest

获取url query集合

覆盖:

getQueryString 在类中 CosXmlRequest

返回:

url query集合

getMethod

public java.lang.String getMethod()

从类复制的说明: CosXmlRequest

获取HTTP请求方法 RequestMethod

指定者:

getMethod 在类中 CosXmlRequest

返回:

HTTP请求方法

xmlBuilder

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

从类复制的说明: CosXmlRequest

收拢xml解析

覆盖:

xmlBuilder 在类中 CosXmlRequest

抛出:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

isNeedMD5

public boolean isNeedMD5()

从类复制的说明: CosXmlRequest

针对有请求体的 PUT 和 POST 请求，此头部是必选项。 针对 GET、HEAD、DELETE 和 OPTIONS 请求，不能指定此头部。 RFC 1864中定义的请求体内容的16字节二进制 MD5 哈希值的 Base64 编码形式，用于完整性检查， 验证请求体在传输过程中是否发生变化，最终的取值长度应为24个字符，请注意在编写代码时使用正确的方法和参数，例如ZzD3iDJdrMAAb00lgLLeig==

覆盖:

isNeedMD5 在类中 CosXmlRequest

setSelectObjectContentProgressListener

public void setSelectObjectContentProgressListener(SelectObjectContentListener selectObjectContentProgressListener)

设置检索进度监听器

参数:

selectObjectContentProgressListener - 检索进度监听器

getSelectObjectContentProgressListener

public SelectObjectContentListener getSelectObjectContentProgressListener()

获取检索进度监听器

返回:

检索进度监听器

setSelectResponseFilePath

public void setSelectResponseFilePath(java.lang.String selectResponseFilePath)

设置响应保存文件路径

参数:

selectResponseFilePath - 响应保存文件路径

getSelectResponseFilePath

public java.lang.String getSelectResponseFilePath()

获取响应保存文件路径

返回:

响应保存文件路径