Qore ElasticSearchDataProvider Module Reference 1.0
Loading...
Searching...
No Matches
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider Class Reference

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

#include <ElasticSearchIndexReadDataProvider.qc.dox.h>

Inheritance diagram for ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider:
[legend]

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 Member Functions inherited from ElasticSearchDataProvider::ElasticSearchDataProviderBase
 constructor ()
 Creates the object.
 
 constructor (RestClient rest)
 Creates the object from a REST connection.
 
 setLogger (*LoggerInterface logger)
 Accepts a LoggerInterface object for logging (or clears it)
 

Public Attributes

const ProviderInfo
 Provider info.
 
const ProviderSummaryInfo
 Provider summary info.
 
const QueryArgs = ...
 Query args.
 
const RequestType = new ElasticSearchIndexReadRequestDataType()
 Request type.
 
const ResponseType = new ElasticSearchIndexReadResponseDataType()
 Response type.
 

Protected Member Functions

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

Detailed Description

The ElasticSearch index read API data provider.

This class implements an API that reads index data given the index name as an argument; the response is the description of the index as returned by the ElasticSearch server.

Note that wildcards can be used, in which case multiple indices can be returned in the return value.

Member Function Documentation

◆ doRequestImpl()

auto ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::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::ElasticSearchIndexReadDataProvider::getRequestTypeImpl ( )
protected

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

Returns
the request type for this provider

◆ getResponseTypeImpl()

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

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

Returns
the response type for this response message