ResponseLite (service-api 3.40.0SP12 API)

java.lang.Object
- com.tencent.tcaplus.client.impl.ResponseLite

All Implemented Interfaces:: Response

public class ResponseLite
extends Object
implements Response

Constructor Summary

Constructors
Constructor and Description

ResponseLite()

Constructors
Constructor and Description
`ResponseLite()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`disassembly(TCaplusPkg pkg)`
`Record`	`fetchErrorRecord()` 从记录结果集中获取一条处理失败的记录
`Record`	`fetchRecord()` 从记录结果集中获取一条记录
`int`	`getAffectedRecordNum()` 获取list表受影响的元素记录条数
`int`	`getAppId()` 获得业务id
`long`	`getAsynId()`
`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()` 是否全部遍历结束
`void`	`reset()`
`void`	`setAsynId(long asynId)`
`void`	`setErrDetail(String msg)`
`void`	`setReqCmd(int cmd)`
`ResponseLite`	`setResult(int result)`
`void`	`setSeq(int seq)`
`void`	`setTraverseCompleted(boolean completed)`
`String`	`toString()` 可视化对象

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ResponseLite
```
public ResponseLite()
```
- Method Detail
  - getTableName
```
public String getTableName()
```
    Description copied from interface: Response
    
    获得响应表名
    
    Specified by:
    
    getTableName in interface Response
    
    Returns:
    
    响应表名
  - reset
```
public void reset()
```
  - disassembly
```
public void disassembly(TCaplusPkg pkg)
                 throws TCaplusException
```
    Throws:
    
    TCaplusException
  - getResult
```
public int getResult()
```
    Description copied from interface: Response
    
    获得响应结果
    
    Specified by:
    
    getResult in interface Response
    
    Returns:
    
    响应结果
  - setResult
```
public ResponseLite setResult(int result)
```
  - getResultFlag
```
public int getResultFlag()
```
    Description copied from interface: Response
    
    获得响应结果标志
    
    Specified by:
    
    getResultFlag in interface Response
    
    Returns:
    
    响应结果标志
  - getAppId
```
public int getAppId()
```
    Description copied from interface: Response
    
    获得业务id
    
    Specified by:
    
    getAppId in interface Response
    
    Returns:
    
    业务id
  - getZoneId
```
public int getZoneId()
```
    Description copied from interface: Response
    
    获得区id
    
    Specified by:
    
    getZoneId in interface Response
    
    Returns:
    
    区id
  - getCmd
```
public int getCmd()
```
    Description copied from interface: Response
    
    获得响应命令字
    
    Specified by:
    
    getCmd in interface Response
    
    Returns:
    
    响应命令字
  - getSequence
```
public int getSequence()
```
    Description copied from interface: Response
    
    获得请求流水号
    
    Specified by:
    
    getSequence in interface Response
    
    Returns:
    
    请求流水号
  - getUserData
```
public byte[] getUserData()
```
    Description copied from interface: Response
    
    获得用户附加数据
    
    Specified by:
    
    getUserData in interface Response
    
    Returns:
    
    用户附加数据
  - getRecordCount
```
public int getRecordCount()
```
    Description copied from interface: Response
    
    获得返回的记录数量
    
    Specified by:
    
    getRecordCount in interface Response
    
    Returns:
    
    记录数量
  - fetchRecord
```
public Record fetchRecord()
```
    Description copied from interface: Response
    
    从记录结果集中获取一条记录
    
    Specified by:
    
    fetchRecord in interface Response
    
    Returns:
    
    记录对象，如果没有后续记录了则返回null
  - fetchErrorRecord
```
public Record fetchErrorRecord()
```
    Description copied from interface: Response
    
    从记录结果集中获取一条处理失败的记录
    
    Specified by:
    
    fetchErrorRecord in interface Response
    
    Returns:
    
    记录对象，如果没有后续记录了则返回null
  - getRecordList
```
public List<Record> getRecordList()
                           throws TCaplusException
```
    Description copied from interface: Response
    
    返回记录结果集
    
    Specified by:
    
    getRecordList in interface Response
    
    Returns:
    
    记录结果集
    
    Throws:
    
    TCaplusException
  - getErrorRecords
```
public List<Record> getErrorRecords()
```
    Description copied from interface: Response
    
    获取结果中失败的记录仅适用于DeleteByPartkey
    
    Specified by:
    
    getErrorRecords in interface Response
    
    Returns:
    
    失败的记录
  - hasMore
```
public boolean hasMore()
```
    Description copied from interface: Response
    
    是否还有后续响应包
    
    Specified by:
    
    hasMore in interface Response
    
    Returns:
    
    后续响应包标志，返回true表示还有后续响应包
  - getTotalNum
```
public int getTotalNum()
```
    Description copied from interface: Response
    
    获取整个结果中的记录条数。既包括本响应返回的记录数，也包括本响应未返回的记录数，适用于partkeyget、listgetall、batchget, partkeydelete。
    该函数的作用是：
    (1) 当使用了SetResultLimit()来限制返回的记录时，使用该函数可以获取所有匹配记录的个数，包括本响应返回的记录数和本响应未返回的记录数，而GetRecordCount()函数只能获取本响应返回的记录的个数。
    (2) 当所返回的记录很多时，需要分包的时候，使用该函数可以获取总共的记录数，即多个分包所有记录数的总和，而GetRecordCount()函数只能返回单个分包中的(本响应中的)记录数。
    提示：如果只是想获取当前list的记录数，可结合Request.SetResultLimit(1, 0)查询参数设置，快速获取。同时（10000 - 当前list中的记录数） = list剩余空间大小
    
    Specified by:
    
    getTotalNum in interface Response
    
    Returns:
    
    匹配的记录条数
  - getFailNum
```
public int getFailNum()
```
    Description copied from interface: Response
    
    获取结果中失败的记录条数仅适用于DeleteByPartkey
    
    Specified by:
    
    getFailNum in interface Response
    
    Returns:
    
    失败的记录条数
  - getAffectedRecordNum
```
public int getAffectedRecordNum()
```
    Description copied from interface: Response
    
    获取list表受影响的元素记录条数
    
    Specified by:
    
    getAffectedRecordNum in interface Response
    
    Returns:
    
    受影响的元素记录条数
  - getShardList
```
public List<Integer> getShardList()
```
    Description copied from interface: Response
    
    获取需要 traverse 的 shard 列表
    
    Specified by:
    
    getShardList in interface Response
  - getTraverserOffset
```
public long getTraverserOffset()
```
    Description copied from interface: Response
    
    获取下次遍历的偏移位置
    
    Specified by:
    
    getTraverserOffset in interface Response
  - getTraversedCount
```
public long getTraversedCount()
```
    Description copied from interface: Response
    
    获取已遍历的记录数
    
    Specified by:
    
    getTraversedCount in interface Response
  - isShardCompleted
```
public boolean isShardCompleted()
```
    Description copied from interface: Response
    
    当前shard是否遍历结束
    
    Specified by:
    
    isShardCompleted in interface Response
  - setTraverseCompleted
```
public void setTraverseCompleted(boolean completed)
```
  - isTraverseCompleted
```
public boolean isTraverseCompleted()
```
    Description copied from interface: Response
    
    是否全部遍历结束
    
    Specified by:
    
    isTraverseCompleted in interface Response
  - getErrDetail
```
public String getErrDetail()
```
    Description copied from interface: Response
    
    获得错误描述信息
    
    Specified by:
    
    getErrDetail in interface Response
    
    Returns:
    
    错误描述信息
  - setErrDetail
```
public void setErrDetail(String msg)
```
  - getReqCmd
```
public int getReqCmd()
```
    Description copied from interface: Response
    
    获得请求命令字
    
    Specified by:
    
    getReqCmd in interface Response
    
    Returns:
    
    请求命令字
  - getSubCmd
```
public int getSubCmd()
```
    Description copied from interface: Response
    
    获取响应子命令字。如果后端版本高于3.73.0，且为GetByPartKey响应包或者遍历响应包时，该方法返回的是当前响应包的序号，业务可以通过该值判断是否有丢包的情况
    
    Specified by:
    
    getSubCmd in interface Response
    
    Returns:
    
    响应子命令字
  - setReqCmd
```
public void setReqCmd(int cmd)
```
  - setSeq
```
public void setSeq(int seq)
```
  - setAsynId
```
public void setAsynId(long asynId)
```
  - getAsynId
```
public long getAsynId()
```
  - getMetadata
```
public TableMetadata getMetadata()
```
    Description copied from interface: Response
    
    获取表的元数据信息
    
    Specified by:
    
    getMetadata in interface Response
  - toString
```
public String toString()
```
    Description copied from interface: Response
    
    可视化对象
    
    Specified by:
    
    toString in interface Response
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    可视化内容

Class ResponseLite

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ResponseLite

Method Detail

getTableName

reset

disassembly

getResult

setResult

getResultFlag

getAppId

getZoneId

getCmd

getSequence

getUserData

getRecordCount

fetchRecord

fetchErrorRecord

getRecordList

getErrorRecords

hasMore

getTotalNum

getFailNum

getAffectedRecordNum

getShardList

getTraverserOffset

getTraversedCount

isShardCompleted

setTraverseCompleted

isTraverseCompleted

getErrDetail

setErrDetail

getReqCmd

getSubCmd

setReqCmd

setSeq

setAsynId

getAsynId

getMetadata

toString