SearcherClient

Updated at:

This topic describes the features and methods of the SearcherClient class.

Overview

The SearcherClient class is a query client that sends query requests.

Class security

The SearcherClient class is thread-safe.

Constructor

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

Parameter description

Parameter name

Type

Description

serviceclient

ServiceClient

The ServiceClient object.


Execute a query and return the results (1)

API Description

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 name

Type

Description

searchParams

SearchParams

The SearchParams object.


Execute a query and obtain the query results (2)

Description

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 name

Type

Description

paramsBuilder

SearchParamsBuilder

The SearchParamsBuilder object.


Execute a query and view the results (3)

API description

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

Parameter description

Parameter

Type

Description

searchParams

SearchParams

The SearchParams object.