Qore ElasticSearchDataProvider Module Reference 1.1
Loading...
Searching...
No Matches
ElasticSearchDataProvider::ElasticSearchDocumentReadDataProvider Class Reference

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

#include <ElasticSearchDocumentReadDataProvider.qc.dox.h>

Inheritance diagram for ElasticSearchDataProvider::ElasticSearchDocumentReadDataProvider:
[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::DataProviderInfo > getStaticInfoImpl ()
 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 ElasticSearchDocumentReadRequestDataType()
 Request type.
 
const ResponseType = new ElasticSearchDocumentReadResponseDataType()
 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 document read API data provider.

This API allows the caller to read an ElasticSearch document

Member Function Documentation

◆ doRequestImpl()

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

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

Returns
the request type for this provider

◆ getResponseTypeImpl()

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

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

Returns
the response type for this response message