| Qore ElasticSearchDataProvider Module Reference 1.1

Loading...
Searching...
No Matches
ElasticSearchIndexReadDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
24
26 namespace ElasticSearchDataProvider {
28
33 class ElasticSearchIndexReadDataProvider : public ElasticSearchDataProviderBase {
34
35 public:
37 const ProviderInfo = ...;
38
39
41 const ProviderSummaryInfo = ...;
42
43
45 const RequestType = new ElasticSearchIndexReadRequestDataType();
46
48 const ResponseType = new ElasticSearchIndexReadResponseDataType();
49
51 const QueryArgs = ...;
52
53
55 constructor(*hash<auto> options);
56
57
59 constructor(RestClient::RestClient rest) ;
60
61
63 string getName();
64
65
67 *string getDesc();
68
69
71
76 protected:
77 auto doRequestImpl(auto req, *hash<auto> request_options);
78 public:
79
80
82
84 protected:
85 *DataProvider::AbstractDataProviderType getRequestTypeImpl();
86 public:
87
88
90
92 protected:
93 *DataProvider::AbstractDataProviderType getResponseTypeImpl();
94 public:
95
96
98 hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
99
100};
101
103 class ElasticSearchIndexReadRequestDataType : public DataProvider::HashDataType {
104
105 public:
107 const Fields = ...;
108
109
111 constructor();
112
113};
114
116 class ElasticSearchIndexReadResponseDataType : public HashDataType {
117
118 public:
120 constructor();
121
122};
123};
DataProvider::AbstractDataProviderType
DataProvider::HashDataType
ElasticSearchDataProvider::ElasticSearchDataProviderBase
The ElasticSearch data provider base class.
Definition ElasticSearchDataProviderBase.qc.dox.h:28
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider
The ElasticSearch index read API data provider.
Definition ElasticSearchIndexReadDataProvider.qc.dox.h:33
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::getDesc
*string getDesc()
Returns the data provider description.
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::QueryArgs
const QueryArgs
Query args.
Definition ElasticSearchIndexReadDataProvider.qc.dox.h:51
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::ProviderSummaryInfo
const ProviderSummaryInfo
Provider summary info.
Definition ElasticSearchIndexReadDataProvider.qc.dox.h:41
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::RequestType
const RequestType
Request type.
Definition ElasticSearchIndexReadDataProvider.qc.dox.h:45
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::getStaticInfoImpl
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::constructor
constructor(RestClient::RestClient rest)
Creates the object from a REST connection.
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::getName
string getName()
Returns the data provider name.
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::getRequestTypeImpl
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::ResponseType
const ResponseType
Response type.
Definition ElasticSearchIndexReadDataProvider.qc.dox.h:48
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::getResponseTypeImpl
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::ProviderInfo
const ProviderInfo
Provider info.
Definition ElasticSearchIndexReadDataProvider.qc.dox.h:37
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::doRequestImpl
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
ElasticSearchDataProvider::ElasticSearchIndexReadRequestDataType
ElasticSearch index read API request.
Definition ElasticSearchIndexReadDataProvider.qc.dox.h:103
ElasticSearchDataProvider::ElasticSearchIndexReadRequestDataType::constructor
constructor()
Creates the object.
ElasticSearchDataProvider::ElasticSearchIndexReadRequestDataType::Fields
const Fields
Field descriptions.
Definition ElasticSearchIndexReadDataProvider.qc.dox.h:107
ElasticSearchDataProvider::ElasticSearchIndexReadResponseDataType
ElasticSearch index read API response.
Definition ElasticSearchIndexReadDataProvider.qc.dox.h:116
ElasticSearchDataProvider::ElasticSearchIndexReadResponseDataType::constructor
constructor()
Creates the object.
RestClient::RestClient
ElasticSearchDataProvider
Qore ElasticSearchDataProvider module definition.
Definition ElasticSearchAcknowledgedDataType.qc.dox.h:26