All Products
Search
Document Center

OpenSearch:SearcherClient

Last Updated:Oct 10, 2023

Overview

This topic describes the SearcherClient class and its methods. This class is used by clients to send query requests.

Class security

Thread-safe

Constructor

This constructor requires you to specify a ServiceClient object as a parameter.
SearcherClient(ServiceClient serviceclient)

Parameter description

Parameter

Type

Description

serviceclient

ServiceClient

The ServiceClient object.


execute (1)

Method definition

Runs a query that is specified by a SearchParams object and returns the results in a SearchResult object.
SearchResult    execute(SearchParams searchParams)

Parameter description

Parameter

Type

Description

searchParams

SearchParams

The SearchParams object that specifies the query to be run.


execute (2)

Method definition

Runs a query that is specified by a SearchParamsBuilder object and returns the results in a SearchResult object.
SearchResult    execute(SearchParamsBuilder paramsBuilder)

Parameter description

Parameter

Type

Description

paramsBuilder

SearchParamsBuilder

The SearchParamsBuilder object that specifies the query to be run.


executeDebug

Method definition

Runs a query that is specified by a SearchParams object and returns the results in a SearchResultDebug object. The SearchResultDebug object allows you to obtain the request string of the last query or push.
SearchResultDebug    executeDebug(SearchParams searchParams)

Parameter description

Parameter

Type

Description

searchParams

SearchParams

The SearchParams object that specifies the query to be run.