All Products
Search
Document Center

OpenSearch:Client class

Last Updated:Feb 22, 2023

Overview

This topic describes the Client class and its methods. The client is used to perform operations to push and search for data.

Class security

Non-thread-safe

Define a constructor

Client(Config config)

Parameters

Parameter

Type

Description

config

Config

The object of the Config class.

Push data

Syntax

PushDocumentsResponseModel pushDocuments(String dataSourceName, String keyField, PushDocumentsRequestModel request)

Parameters

Parameter

Type

Description

dataSourceName

String

The name of the index table.

keyField

String

The primary key field of the index table.

request

PushDocumentsRequestModel

The request structure to push the documents.

Exception description

  • Exception

Search for data

Syntax

SearchResponseModel Search(SearchRequestModel request)

Parameters

Parameter

Type

Description

request

SearchRequestModel

The SearchRequestModel type.

Exception description

  • Exception