com.aliyun.opensearch

Class DocumentClient

java.lang.Object

com.aliyun.opensearch.DocumentClient

All Implemented Interfaces:

com.aliyun.opensearch.sdk.generated.document.DocumentService.Iface

public class DocumentClient
extends java.lang.Object
implements com.aliyun.opensearch.sdk.generated.document.DocumentService.Iface

Constructor Summary

Constructors

Constructor and Description
DocumentClient(OpenSearchClient client) 构造函数

Method Summary

Modifier and Type	Method and Description
void	add(java.util.Map<java.lang.String,java.lang.Object> fields) 添加文档 设置需要添加的属性名称和属性值，用于生成符合文档格式的数据，所有更新结束之后需要调用push(String tableName)方法
com.aliyun.opensearch.sdk.generated.commons.OpenSearchResult	commit(java.lang.String appName, java.lang.String tableName) 执行文档变更操作(1) 针对文档的操作add、update和remove会生成符合文档格式的数据，通过调用此接口用户提交的文档变更才会真正生效。
com.aliyun.opensearch.sdk.generated.commons.OpenSearchResult	push(java.lang.String docsJson, java.lang.String appName, java.lang.String tableName) 执行文档变更操作(2) 通过此接口可以直接将符合文档格式的数据直接推送到指定的表中
void	remove(java.util.Map<java.lang.String,java.lang.Object> fields) 删除文档 设置需要删除的属性名称和属性值，用于生成符合文档格式的数据，所有更新结束之后需要调用push(String tableName)方法
void	update(java.util.Map<java.lang.String,java.lang.Object> fields) 更新文档 设置需要更新的属性名称和属性值，用于生成符合文档格式的数据，所有更新结束之后需要调用push(String tableName)方法 标准版不支持update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentClient

public DocumentClient(OpenSearchClient client)

构造函数

Parameters:

client - CloudsearchClient实例。

Method Detail

add

public void add(java.util.Map<java.lang.String,java.lang.Object> fields)

添加文档 设置需要添加的属性名称和属性值，用于生成符合文档格式的数据，所有更新结束之后需要调用push(String tableName)方法

Parameters:

fields - 字段名和字段值的map

update

public void update(java.util.Map<java.lang.String,java.lang.Object> fields)

更新文档 设置需要更新的属性名称和属性值，用于生成符合文档格式的数据，所有更新结束之后需要调用push(String tableName)方法 标准版不支持update

Parameters:

fields - 字段名和字段值的map

remove

public void remove(java.util.Map<java.lang.String,java.lang.Object> fields)

删除文档 设置需要删除的属性名称和属性值，用于生成符合文档格式的数据，所有更新结束之后需要调用push(String tableName)方法

Parameters:

fields - 字段名和字段值的map

commit

public com.aliyun.opensearch.sdk.generated.commons.OpenSearchResult commit(java.lang.String appName,
                                                                           java.lang.String tableName)
                                                                    throws com.aliyun.opensearch.sdk.generated.commons.OpenSearchException,
                                                                           com.aliyun.opensearch.sdk.generated.commons.OpenSearchClientException

执行文档变更操作(1) 针对文档的操作add、update和remove会生成符合文档格式的数据，通过调用此接口用户提交的文档变更才会真正生效。

Parameters:

appName - 应用名

tableName - 表名称

Returns:

返回的数据

Throws:

com.aliyun.opensearch.sdk.generated.commons.OpenSearchException - OpenSearchException

com.aliyun.opensearch.sdk.generated.commons.OpenSearchClientException - OpenSearchClientException

push

public com.aliyun.opensearch.sdk.generated.commons.OpenSearchResult push(java.lang.String docsJson,
                                                                         java.lang.String appName,
                                                                         java.lang.String tableName)
                                                                  throws com.aliyun.opensearch.sdk.generated.commons.OpenSearchException,
                                                                         com.aliyun.opensearch.sdk.generated.commons.OpenSearchClientException

执行文档变更操作(2) 通过此接口可以直接将符合文档格式的数据直接推送到指定的表中

Specified by:

push in interface com.aliyun.opensearch.sdk.generated.document.DocumentService.Iface

Parameters:

docsJson - 此docs为用户push的数据，此字段为json类型的字符串。

appName - 应用名

tableName - 操作的表名。

Returns:

请求API并返回相应的结果。

Throws:

com.aliyun.opensearch.sdk.generated.commons.OpenSearchException

com.aliyun.opensearch.sdk.generated.commons.OpenSearchClientException