com.tencent.tcaplus.client

Interface Response

All Known Implementing Classes:

ResponseLite

public interface Response

响应对象接口

Version:

Version 1.0

Author:

yahuiwang, elviszhu

Method Summary

Modifier and Type	Method and Description
Record	fetchErrorRecord() 从记录结果集中获取一条处理失败的记录
Record	fetchRecord() 从记录结果集中获取一条记录
int	getAffectedRecordNum() 获取list表受影响的元素记录条数
int	getAppId() 获得业务id
int	getCmd() 获得响应命令字
String	getErrDetail() 获得错误描述信息
List<Record>	getErrorRecords() 获取结果中失败的记录 仅适用于DeleteByPartkey
int	getFailNum() 获取结果中失败的记录条数 仅适用于DeleteByPartkey
TableMetadata	getMetadata() 获取表的元数据信息
int	getRecordCount() 获得返回的记录数量
List<Record>	getRecordList() 返回记录结果集
int	getReqCmd() 获得请求命令字
int	getResult() 获得响应结果
int	getResultFlag() 获得响应结果标志
int	getSequence() 获得请求流水号
List<Integer>	getShardList() 获取需要 traverse 的 shard 列表
int	getSubCmd() 获取响应子命令字。 如果后端版本高于3.73.0，且为GetByPartKey响应包或者遍历响应包时，该方法返回的是当前响应包的序号，业务可以通过该值判断是否有丢包的情况
String	getTableName() 获得响应表名
int	getTotalNum() 获取整个结果中的记录条数。既包括本响应返回的记录数，也包括本响应未返回的记录数，适用于partkeyget、listgetall、batchget, partkeydelete。
long	getTraversedCount() 获取已遍历的记录数
long	getTraverserOffset() 获取下次遍历的偏移位置
byte[]	getUserData() 获得用户附加数据
int	getZoneId() 获得区id
boolean	hasMore() 是否还有后续响应包
boolean	isShardCompleted() 当前shard是否遍历结束
boolean	isTraverseCompleted() 是否全部遍历结束
String	toString() 可视化对象

Method Detail

getTableName

String getTableName()

获得响应表名

Returns:

响应表名

getResult

int getResult()

获得响应结果

Returns:

响应结果

getErrDetail

String getErrDetail()

获得错误描述信息

Returns:

错误描述信息

getAppId

int getAppId()

获得业务id

Returns:

业务id

getZoneId

int getZoneId()

获得区id

Returns:

区id

getCmd

int getCmd()

获得响应命令字

Returns:

响应命令字

getReqCmd

int getReqCmd()

获得请求命令字

Returns:

请求命令字

getSubCmd

int getSubCmd()

获取响应子命令字。 如果后端版本高于3.73.0，且为GetByPartKey响应包或者遍历响应包时，该方法返回的是当前响应包的序号，业务可以通过该值判断是否有丢包的情况

Returns:

响应子命令字

getSequence

int getSequence()

获得请求流水号

Returns:

请求流水号

getResultFlag

int getResultFlag()

获得响应结果标志

Returns:

响应结果标志

getUserData

byte[] getUserData()

获得用户附加数据

Returns:

用户附加数据

getRecordCount

int getRecordCount()

获得返回的记录数量

Returns:

记录数量

fetchRecord

Record fetchRecord()

从记录结果集中获取一条记录

Returns:

记录对象，如果没有后续记录了则返回null

fetchErrorRecord

Record fetchErrorRecord()

从记录结果集中获取一条处理失败的记录

Returns:

记录对象，如果没有后续记录了则返回null

getRecordList

List<Record> getRecordList()

返回记录结果集

Returns:

记录结果集

getErrorRecords

List<Record> getErrorRecords()

获取结果中失败的记录 仅适用于DeleteByPartkey

Returns:

失败的记录

hasMore

boolean hasMore()

是否还有后续响应包

Returns:

后续响应包标志，返回true表示还有后续响应包

getTotalNum

int getTotalNum()

获取整个结果中的记录条数。既包括本响应返回的记录数，也包括本响应未返回的记录数，适用于partkeyget、listgetall、batchget, partkeydelete。

该函数的作用是：
(1) 当使用了SetResultLimit()来限制返回的记录时， 使用该函数可以获取所有匹配记录的个数， 包括本响应返回的记录数和本响应未返回的记录数， 而GetRecordCount()函数只能获取本响应返回的记录的个数。
(2) 当所返回的记录很多时，需要分包的时候， 使用该函数可以获取总共的记录数， 即多个分包所有记录数的总和， 而GetRecordCount()函数只能返回单个分包中的(本响应中的)记录数。
提示：如果只是想获取当前list的记录数，可结合Request.SetResultLimit(1, 0)查询参数设置，快速获取。同时（10000 - 当前list中的记录数） = list剩余空间大小

Returns:

匹配的记录条数

getFailNum

int getFailNum()

获取结果中失败的记录条数 仅适用于DeleteByPartkey

Returns:

失败的记录条数

getAffectedRecordNum

int getAffectedRecordNum()

获取list表受影响的元素记录条数

Returns:

受影响的元素记录条数

getShardList

List<Integer> getShardList()

获取需要 traverse 的 shard 列表

getMetadata

TableMetadata getMetadata()

获取表的元数据信息

getTraverserOffset

long getTraverserOffset()

获取下次遍历的偏移位置

getTraversedCount

long getTraversedCount()

获取已遍历的记录数

isTraverseCompleted

boolean isTraverseCompleted()

是否全部遍历结束

isShardCompleted

boolean isShardCompleted()

当前shard是否遍历结束

toString

String toString()

可视化对象

Overrides:

toString in class Object

Returns:

可视化内容