$darkmode
Qore ElasticSearchDataProvider Module Reference 1.0
ElasticSearchDataProvider::ElasticSearchIndexSearchDataProvider Class Reference

The ElasticSearch index search API data provider. More...

#include <ElasticSearchIndexSearchDataProvider.qc.dox.h>

Inheritance diagram for ElasticSearchDataProvider::ElasticSearchIndexSearchDataProvider:

Public Member Functions

 constructor (*hash< auto > options)
 Creates the object from constructor options.
 
 constructor (RestClient::RestClient rest)
 Creates the object from a REST connection.
 
*string getDesc ()
 Returns the data provider description.
 
string getName ()
 Returns the data provider name.
 
hash< DataProvider::DataProviderInfogetStaticInfoImpl ()
 Returns data provider static info.
 

Public Attributes

const ProviderInfo
 Provider info.
 
const ProviderSummaryInfo
 Provider summary info.
 
const QueryArgs = ...
 Query args.
 
const RequestType = new ElasticSearchIndexSearchRequestDataType()
 Request type.
 
const ResponseType = new ElasticSearchAcknowledgedDataType()
 Response type.
 
RestClient::RestClient rest
 REST client connection.
 

Protected Member Functions

auto doRequestImpl (auto req, *hash< auto > request_options)
 Makes a request and returns the response. More...
 
*DataProvider::AbstractDataProviderType getRequestTypeImpl ()
 Returns the description of a successful request message, if any. More...
 
*DataProvider::AbstractDataProviderType getResponseTypeImpl ()
 Returns the description of a response message, if this object represents a response message. More...
 

Detailed Description

The ElasticSearch index search API data provider.

This class implements an API to search an index using ElasticSearch's index search API

The `query` API argument takes a data structure that corresponds to ElasticSearch's JSON Query DSL, for example.

Member Function Documentation

◆ doRequestImpl()

auto ElasticSearchDataProvider::ElasticSearchIndexSearchDataProvider::doRequestImpl ( auto  req,
*hash< auto >  request_options 
)
protected

Makes a request and returns the response.

Parameters
reqthe request to serialize and make according to the request type
request_optionsthe request options; will be processed by validateRequestOptions()
Returns
the response to the request

◆ getRequestTypeImpl()

*DataProvider::AbstractDataProviderType ElasticSearchDataProvider::ElasticSearchIndexSearchDataProvider::getRequestTypeImpl ( )
protected

Returns the description of a successful request message, if any.

Returns
the request type for this provider

◆ getResponseTypeImpl()

*DataProvider::AbstractDataProviderType ElasticSearchDataProvider::ElasticSearchIndexSearchDataProvider::getResponseTypeImpl ( )
protected

Returns the description of a response message, if this object represents a response message.

Returns
the response type for this response message