全部产品
开放搜索

应用操作

更新时间:2017-06-07 13:26:11   分享:   


构造函数

接口描述

CloudsearchIndex类是非线程安全的,请每次使用时单独实例化一个实例使用

参数描述

参数名称 类型 描述
indexName String 指定操作的应用名
client CloudsearchClient 提交请求的client

接口定义

  1. CloudsearchIndex(String indexName, CloudsearchClient client)

查看当前应用的状态

返回结果

  • 返回API返回的正确或错误的结果

异常描述

  • IOException

  • ClientProtocolException

接口定义

  1. String status() throws ClientProtocolException, IOException

列出所有应用

参数描述

参数名称 类型 描述
page Integer 开始的页码
pageSize Integer 获取的记录数

返回结果

  • 返回API返回的正确或错误的结果

异常描述

  • IOException

  • ClientProtocolException

接口定义

  1. String listIndexes(Integer page, Integer pageSize) throws ClientProtocolException, IOException

获取当前应用的名称

返回结果

  • 应用名称

接口定义

  1. String getIndexName()

获取错误信息

参数描述

参数名称 类型 描述
page int 开始页数
pageSize int 每页的记录数

返回结果

  • API返回的错误信息

异常描述

  • IOException

  • ClientProtocolException

接口定义

  1. String getErrorMessage(int page, int pageSize) throws ClientProtocolException, IOException

获取上次请求的信息

返回结果

  • String

接口定义

  1. String getDebugInfo()

应用操作示例

通过OpenSearch控制台也可以完成应用创建、查看、修改等操作,在SDK中也提供了部分操作应用的接口。下面带大家逐一看一下各个接口的使用方式。首先我们实例化一个应用类,很简单

  1. CloudsearchIndex app = new CloudsearchIndex("sdk_user_demo",client);

其中client的实例化可以在CloudsearchClient类的示例中查看,这里不再重复。

删除应用

  1. String ret = app.delete();
  2. System.out.println(ret);

获取应用名称

  1. System.out.println(app.getIndexName());

查看应用详情

  1. System.out.println(app.status());

获取应用列表

获取您的所有的应用列表信息,该接口可以指定页码或者每页的条数。

  1. // 获取所有的应用信息,取第一页的数据,每页取10条。
  2. System.out.println(app.listIndexes(1, 10));

获取错误信息

错误信息一般情况下在您请求每个接口时实时返回,但是push 数据时如果数据已经到了后端发现错误,则此时这些接口已经拿不到这个数据的错误信息了。这个时候您可以:

  • 1、通过网站查看某个应用的push错误信息。
  • 2、通过sdk中getErrorMessage() 来获取错误信息的方式来获取某个应用在push的过程中出现了哪些错误信息。
    1. // 列出当前应用的所有错误信息。
    2. System.out.println(app.getErrorMessage());
    3. // 或者分页获取,例如列出第一页、每页10条:
    4. System.out.println(app.getErrorMessage(1, 10));

获取调试信息

CloudsearchIndex类内置了一个调试接口,通过调用调试接口可以获得操作发出的请求内容,当我们操作文档时发现与预期不符时可以通过此接口查看请求细节。

  1. debugInfo = app.getDebugInfo();
本文导读目录
本文导读目录
以上内容是否对您有帮助?