类 ScanRequest
- java.lang.Object
-
- com.baidubce.model.AbstractBceRequest
-
- com.baidubce.services.tablestorage.model.AbstractTableStorageRequest
-
- com.baidubce.services.tablestorage.model.ScanRequest
-
public class ScanRequest extends AbstractTableStorageRequest
Represent the request for Scan operation.
-
-
构造器概要
构造器 构造器 说明 ScanRequest(String tableName)Constructs a scan request with target table name.
-
方法概要
所有方法 静态方法 实例方法 具体方法 修饰符和类型 方法 说明 ScanRequestaddSelector(String column)Add a cell with column name to this get object.protected static voidcheckScanRequest(ScanRequest request)Check this table storage row objectintgetLimit()Get the limit number of returned records corresponding to this request.intgetMaxVersions()Get the maxVersions of this scan request.List<TableStorageCell>getSelectors()Get all cell objects in this requestStringgetStartRowkey()Get the start rowkey of this scan request.StringgetStopRowkey()Get the stop rowkey of this scan request.booleanisIncludeStart()Whether this scan request includes start rowkey.booleanisIncludeStop()Whether this scan request includes stop rowkey.voidsetLimit(int limit)Set the limit number of returned records corresponding to this request.voidsetMaxVersions(int maxVersions)Set the maxVersions to this scan request.voidsetStartRowkey(String startRowkey, boolean includeStart)Set the start rowkey and include start rowkey to this scan request.voidsetStopRowkey(String stopRowkey, boolean includeStop)Set the stop rowkey and include stop rowkey to this scan request.StringtoJsonString()Convert this scan request to json string.-
从类继承的方法 com.baidubce.services.tablestorage.model.AbstractTableStorageRequest
getTableName, withRequestCredentials
-
从类继承的方法 com.baidubce.model.AbstractBceRequest
getRequestCredentials, setRequestCredentials
-
-
-
-
构造器详细资料
-
ScanRequest
public ScanRequest(String tableName)
Constructs a scan request with target table name.- 参数:
tableName- The target table name.
-
-
方法详细资料
-
getStartRowkey
public String getStartRowkey()
Get the start rowkey of this scan request.- 返回:
- The start rowkey of this scan request.
-
setStartRowkey
public void setStartRowkey(String startRowkey, boolean includeStart)
Set the start rowkey and include start rowkey to this scan request.- 参数:
startRowkey- The start rowkey set to this scan request.includeStart- Set true if want this scan request include start rowkey, otherwise false.
-
isIncludeStart
public boolean isIncludeStart()
Whether this scan request includes start rowkey.- 返回:
- Return true if this scan request includes start rowkey, otherwise false.
-
getStopRowkey
public String getStopRowkey()
Get the stop rowkey of this scan request.- 返回:
- The stop rowkey of this scan request.
-
setStopRowkey
public void setStopRowkey(String stopRowkey, boolean includeStop)
Set the stop rowkey and include stop rowkey to this scan request.- 参数:
stopRowkey- The stop rowkey set to this scan request.includeStop- Set true if want this scan request include stop rowkey, otherwise false.
-
isIncludeStop
public boolean isIncludeStop()
Whether this scan request includes stop rowkey.- 返回:
- Return true if this scan request includes stop rowkey, otherwise false.
-
getLimit
public int getLimit()
Get the limit number of returned records corresponding to this request.- 返回:
- The value of the limit.
-
setLimit
public void setLimit(int limit)
Set the limit number of returned records corresponding to this request.- 参数:
limit- The value set to the limit.
-
getMaxVersions
public int getMaxVersions()
Get the maxVersions of this scan request. Multiple versions is a advance function of TableStorage, which will release to public in the future.
-
setMaxVersions
public void setMaxVersions(int maxVersions)
Set the maxVersions to this scan request. Multiple versions is a advance feature of TableStorage, which will release to public in the future.- 参数:
maxVersions- The value set to maxVersions.
-
getSelectors
public List<TableStorageCell> getSelectors()
Get all cell objects in this request- 返回:
- Return the list of all cell objects
-
addSelector
public ScanRequest addSelector(String column)
Add a cell with column name to this get object.- 参数:
column- The column name of this cell.- 返回:
- This scan request object.
-
checkScanRequest
protected static void checkScanRequest(ScanRequest request)
Check this table storage row object
-
toJsonString
public String toJsonString()
Convert this scan request to json string.- 指定者:
toJsonString在类中AbstractTableStorageRequest- 返回:
- The json string represent this scan request.
-
-