com.aliyun.openservices.ots
类 OTSClient

java.lang.Object
  继承者 com.aliyun.openservices.ots.OTSClient
所有已实现的接口:
OTS

public class OTSClient
extends Object
implements OTS

访问阿里云开放结构化数据服务(Open Table Service, OTS)的入口类。


构造方法摘要
OTSClient(String endpoint, String accessKeyId, String accessKeySecret, String instanceName)
          使用指定的OTS Endpoint和默认配置构造一个新的OTSClient实例。
OTSClient(String endpoint, String accessKeyId, String accessKeySecret, String instanceName, ClientConfiguration config)
          使用指定的OTS Endpoint和配置构造一个新的OTSClient实例。
OTSClient(String endpoint, String accessKeyId, String accessKeySecret, String instanceName, ClientConfiguration config, OTSServiceConfiguration otsConfig)
          使用指定的OTS Endpoint和配置构造一个新的OTSClient实例。
 
方法摘要
 BatchGetRowResult batchGetRow(BatchGetRowRequest batchGetRowRequest)
          从多张表(Table)中获取多行数据。
 BatchWriteRowResult batchWriteRow(BatchWriteRowRequest batchWriteRowRequest)
          对多张表(Table)中的多行数据进行增加、删除或者更改操作。
 Iterator<Row> createRangeIterator(RangeIteratorParameter rangeIteratorParameter)
           
 CreateTableResult createTable(CreateTableRequest createTableRequest)
          创建表(Table)。
 DeleteRowResult deleteRow(DeleteRowRequest deleteRowRequest)
          删除表(Table)中的一行数据。
 DeleteTableResult deleteTable(DeleteTableRequest deleteTableRequest)
          删除表(Table)。
 DescribeTableResult describeTable(DescribeTableRequest describeTableRequest)
          返回表(Table)的结构信息。
 URI getEndpoint()
          返回访问的OTS Endpoint。
 String getInstanceName()
          返回访问的实例的名称
 GetRangeResult getRange(GetRangeRequest getRangeRequest)
          从表(Table)中查询一个范围内的多行数据。
 GetRowResult getRow(GetRowRequest getRowRequest)
          返回表(Table)中的一行数据。
 ListTableResult listTable()
          返回表(Table)名的列表。
 PutRowResult putRow(PutRowRequest putRowRequest)
          向表(Table)中插入或覆盖一行数据。
 UpdateRowResult updateRow(UpdateRowRequest updateRowRequest)
          更改表(Table)中的一行数据。
 UpdateTableResult updateTable(UpdateTableRequest updateTableRequest)
          更新表的读或写CapacityUnit。
 
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

构造方法详细信息

OTSClient

public OTSClient(String endpoint,
                 String accessKeyId,
                 String accessKeySecret,
                 String instanceName)
使用指定的OTS Endpoint和默认配置构造一个新的OTSClient实例。

参数:
endpoint - OTS服务的endpoint。
accessKeyId - 访问OTS服务的Access ID。
accessKeySecret - 访问OTS服务的Access Key。

OTSClient

public OTSClient(String endpoint,
                 String accessKeyId,
                 String accessKeySecret,
                 String instanceName,
                 ClientConfiguration config)
使用指定的OTS Endpoint和配置构造一个新的OTSClient实例。

参数:
endpoint - OTS服务的endpoint。
accessKeyId - 访问OTS服务的Access ID。
accessKeySecret - 访问OTS服务的Access Key。
config - 客户端配置信息(ClientConfiguration)。 如果传入null则使用默认配置。

OTSClient

public OTSClient(String endpoint,
                 String accessKeyId,
                 String accessKeySecret,
                 String instanceName,
                 ClientConfiguration config,
                 OTSServiceConfiguration otsConfig)
使用指定的OTS Endpoint和配置构造一个新的OTSClient实例。

参数:
endpoint - OTS服务的endpoint。
accessKeyId - 访问OTS服务的Access ID。
accessKeySecret - 访问OTS服务的Access Key。
config - 客户端配置信息(ClientConfiguration)。 如果传入null则使用默认配置。
otsConfig - OTS服务相关配置信息(OTSServiceConfiguration)。 如果传入null则使用默认配置。
方法详细信息

getEndpoint

public URI getEndpoint()
返回访问的OTS Endpoint。

返回:
OTS Endpoint。

getInstanceName

public String getInstanceName()
返回访问的实例的名称

返回:
instance name

createTable

public CreateTableResult createTable(CreateTableRequest createTableRequest)
                              throws OTSException,
                                     ClientException
从接口 OTS 复制的描述
创建表(Table)。

此方法为非查询操作,SDK不会对其进行重试(即使设置最大重试次数大于0也不会重试)

指定者:
接口 OTS 中的 createTable
参数:
createTableRequest - 执行CreateTable操作所需参数的封装。
返回:
CreateTable操作的响应内容。
抛出:
OTSException - OTS访问返回错误消息
ClientException - 请求的返回结果无效, 或由于网络原因请求失败, 或访问超时。

listTable

public ListTableResult listTable()
                          throws OTSException,
                                 ClientException
从接口 OTS 复制的描述
返回表(Table)名的列表。

指定者:
接口 OTS 中的 listTable
返回:
ListTable操作的响应内容。
抛出:
OTSException - OTS访问返回错误消息
ClientException - 请求的返回结果无效, 或由于网络原因请求失败, 或访问超时。

describeTable

public DescribeTableResult describeTable(DescribeTableRequest describeTableRequest)
                                  throws OTSException,
                                         ClientException
从接口 OTS 复制的描述
返回表(Table)的结构信息。

指定者:
接口 OTS 中的 describeTable
参数:
describeTableRequest - 执行DescribeTable操作所需参数的封装。
返回:
DescribeTable操作的响应内容。
抛出:
OTSException - OTS访问返回错误消息
ClientException - 请求的返回结果无效, 或由于网络原因请求失败, 或访问超时。

deleteTable

public DeleteTableResult deleteTable(DeleteTableRequest deleteTableRequest)
                              throws OTSException,
                                     ClientException
从接口 OTS 复制的描述
删除表(Table)。

此方法为非查询操作,SDK不会对其进行重试(即使设置最大重试次数大于0也不会重试)

指定者:
接口 OTS 中的 deleteTable
参数:
deleteTableRequest - 执行DeleteTable操作所需参数的封装。
返回:
DeleteTable操作的响应内容。
抛出:
OTSException - OTS访问返回错误消息
ClientException - 请求的返回结果无效, 或由于网络原因请求失败, 或访问超时。

updateTable

public UpdateTableResult updateTable(UpdateTableRequest updateTableRequest)
                              throws OTSException,
                                     ClientException
从接口 OTS 复制的描述
更新表的读或写CapacityUnit。

指定者:
接口 OTS 中的 updateTable
参数:
updateTableRequest - 执行UpdateTable操作所需参数的封装。
返回:
UpdateTable操作的响应内容。
抛出:
OTSException - OTS访问返回错误消息
ClientException - 请求的返回结果无效, 或由于网络原因请求失败, 或访问超时。

getRow

public GetRowResult getRow(GetRowRequest getRowRequest)
                    throws OTSException,
                           ClientException
从接口 OTS 复制的描述
返回表(Table)中的一行数据。

指定者:
接口 OTS 中的 getRow
参数:
getRowRequest - 执行GetRow操作所需参数的封装。
返回:
GetRow操作的响应内容。
抛出:
OTSException - OTS访问返回错误消息
ClientException - 请求的返回结果无效, 或由于网络原因请求失败, 或访问超时。

putRow

public PutRowResult putRow(PutRowRequest putRowRequest)
                    throws OTSException,
                           ClientException
从接口 OTS 复制的描述
向表(Table)中插入或覆盖一行数据。

指定者:
接口 OTS 中的 putRow
参数:
putRowRequest - 执行PutRow操作所需参数的封装。
返回:
PutRow操作的响应内容。
抛出:
OTSException - OTS访问返回错误消息
ClientException - 请求的返回结果无效, 或由于网络原因请求失败, 或访问超时。

updateRow

public UpdateRowResult updateRow(UpdateRowRequest updateRowRequest)
                          throws OTSException,
                                 ClientException
从接口 OTS 复制的描述
更改表(Table)中的一行数据。

指定者:
接口 OTS 中的 updateRow
参数:
updateRowRequest - 执行UpdateRow操作所需参数的封装。
返回:
UpdateRow操作的响应内容。
抛出:
OTSException - OTS访问返回错误消息
ClientException - 请求的返回结果无效, 或由于网络原因请求失败, 或访问超时。

deleteRow

public DeleteRowResult deleteRow(DeleteRowRequest deleteRowRequest)
                          throws OTSException,
                                 ClientException
从接口 OTS 复制的描述
删除表(Table)中的一行数据。

指定者:
接口 OTS 中的 deleteRow
参数:
deleteRowRequest - 执行DeleteRow操作所需参数的封装。
返回:
DeleteRow操作的响应内容。
抛出:
OTSException - OTS访问返回错误消息
ClientException - 请求的返回结果无效, 或由于网络原因请求失败, 或访问超时。

batchGetRow

public BatchGetRowResult batchGetRow(BatchGetRowRequest batchGetRowRequest)
                              throws OTSException,
                                     ClientException
从接口 OTS 复制的描述
从多张表(Table)中获取多行数据。

指定者:
接口 OTS 中的 batchGetRow
参数:
batchGetRowRequest - 执行BatchGetRow操作所需参数的封装。
返回:
BatchGetRow操作的响应内容。
抛出:
OTSException - OTS访问返回错误消息
ClientException - 请求的返回结果无效, 或由于网络原因请求失败, 或访问超时。

batchWriteRow

public BatchWriteRowResult batchWriteRow(BatchWriteRowRequest batchWriteRowRequest)
                                  throws OTSException,
                                         ClientException
从接口 OTS 复制的描述
对多张表(Table)中的多行数据进行增加、删除或者更改操作。

指定者:
接口 OTS 中的 batchWriteRow
参数:
batchWriteRowRequest - 执行BatchWriteRow操作所需参数的封装。
返回:
BatchWriteRow操作的响应内容。
抛出:
OTSException - OTS访问返回错误消息
ClientException - 请求的返回结果无效, 或由于网络原因请求失败, 或访问超时。

getRange

public GetRangeResult getRange(GetRangeRequest getRangeRequest)
                        throws OTSException,
                               ClientException
从接口 OTS 复制的描述
从表(Table)中查询一个范围内的多行数据。

指定者:
接口 OTS 中的 getRange
参数:
getRangeRequest - 执行GetRange操作所需参数的封装。
返回:
GetRange操作的响应内容。
抛出:
OTSException - OTS访问返回错误消息
ClientException - 请求的返回结果无效, 或由于网络原因请求失败, 或访问超时。

createRangeIterator

public Iterator<Row> createRangeIterator(RangeIteratorParameter rangeIteratorParameter)
                                  throws OTSException,
                                         ClientException
指定者:
接口 OTS 中的 createRangeIterator
抛出:
OTSException
ClientException


Copyright © 2014. All Rights Reserved.