开发者社区> 问答> 正文

AppClient的客户端包括什么?



功能简介


管理应用的基本信息,包括 创建应用(save)、修改应用(updateById)、删除应用(removeById)、获取应用的基本详情(getById)、获取应用列表(listAll)、给应用导入全量数据(reindexById)等方法。




构造函数



函数定义


  1. void  OpenSearch\Client\AppClient::__construct( $openSearchClient)


参数描述

参数名称类型描述
$openSearchClient\OpenSearch\Client\OpenSearchClient基础类,负责计算签名,和服务端进行交互和返回结果。



创新应用 或 创建新版本


创建一个新的应用或者创建一个新的版本,如果在$app中指定了name,则会创建一个新版本,否则会创建一个新应用。

创建版本的个数依赖服务端的限制。


函数定义


  1. \OpenSearch\Generated\Common\OpenSearchResult     OpenSearch\Client\AppClient::save( $app)


参数描述

参数名称类型描述
$appstring要创建的应用主体JSON,包含name、type、schema、quota、first_ranks、second_ranks、summary、data_sources、suggest、fetch_fields、query_processors等信息。



获取应用信息


通过应用名称或者应用ID获取一个应用的详情信息。

函数定义


  1. \OpenSearch\Generated\Common\OpenSearchResult     OpenSearch\Client\AppClient::getById( $identity)


参数描述

参数名称类型描述
$identitystring要查询的应用名称或者应用ID,如果应用有多个版本,则指定应用名称为当前应用的在线版本。



获取应用列表


获取当前账号下的应用列表。

函数定义


  1. \OpenSearch\Generated\Common\OpenSearchResult     OpenSearch\Client\AppClient::listAll( $pageable)


参数描述

参数名称类型描述
$pageable\OpenSearch\Generated\Common\Pageable分页信息,包含页码和每页展示条数。



删除应用(根据应用名或应用ID)

  • 根据指定的应用id或名称删除应用版本或者应用;
  • 当指定的为应用名称,则表示指定的为当前应用分组中的在线的应用;
  • 如果当前应用只有一个版本,则会删除这个应用的整个分组;
  • 如果当前应用分组有多个应用,则需要当前要删除的版本不能处于在线状态;


函数定义


  1. \OpenSearch\Generated\Common\OpenSearchResult     OpenSearch\Client\AppClient::removeById( $identity)


参数描述

参数名称类型描述
$identitystring指定的应用ID或者应用名称。



更新应用信息(根据应用名或应用ID)


通过调用该函数,并指定需更新应用名称或者应用ID更新应用信息。

函数定义


  1. \OpenSearch\Generated\Common\OpenSearchResult     OpenSearch\Client\AppClient::updateById( $identity,  $app)


参数描述

参数名称类型描述
$identitystring指定的应用ID或者应用名称;当指定的为应用名称,则表示指定的为当前应用分组中的在线的应用。
$appstring修改一个应用的应用结构json,包含name、type、schema、quota、first_ranks、second_ranks、summary、data_sources、suggest、fetch_fields、query_processors等信息。



触发索引重建(根据应用名或应用ID)


触发指定应用索引重建,配有数据源,会做带全量数据导入的索引重建。

函数定义


  1. \OpenSearch\Generated\Common\OpenSearchResult     OpenSearch\Client\AppClient::reindexById( $identity)


参数描述

参数名称类型描述
[tr=rgb(239, 251, 255)][td]$identity string指定的应用ID或者应用名称;当指定的为应用名称,则表示指定的为当前应用分组中的在线的应用。

展开
收起
轩墨 2017-10-25 16:32:19 2528 0
0 条回答
写回答
取消 提交回答
问答排行榜
最热
最新

相关电子书

更多
低代码开发师(初级)实战教程 立即下载
冬季实战营第三期:MySQL数据库进阶实战 立即下载
阿里巴巴DevOps 最佳实践手册 立即下载