| Qore ElasticSearchDataProvider Module Reference 1.1

Loading...
Searching...
No Matches
ElasticSearchDocumentReadDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
24
26 namespace ElasticSearchDataProvider {
28
30 class ElasticSearchDocumentReadDataProvider : public ElasticSearchDataProviderBase {
31
32 public:
34 const ProviderInfo = ...;
35
36
38 const ProviderSummaryInfo = ...;
39
40
42 const RequestType = new ElasticSearchDocumentReadRequestDataType();
43
45 const ResponseType = new ElasticSearchDocumentReadResponseDataType();
46
48 const QueryArgs = ...;
49
50
52 constructor(*hash<auto> options);
53
54
56 constructor(RestClient::RestClient rest) ;
57
58
60 string getName();
61
62
64 *string getDesc();
65
66
68
73 protected:
74 auto doRequestImpl(auto req, *hash<auto> request_options);
75 public:
76
77
79
81 protected:
82 *DataProvider::AbstractDataProviderType getRequestTypeImpl();
83 public:
84
85
87
89 protected:
90 *DataProvider::AbstractDataProviderType getResponseTypeImpl();
91 public:
92
93
95 hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
96
97};
98
100 class ElasticSearchDocumentReadRequestDataType : public DataProvider::HashDataType {
101
102 public:
103 protected:
105 const Fields = ...;
106
107
108 public:
109
111 constructor();
112
113};
114
116 class ElasticSearchDocumentReadResponseDataType : public DataProvider::HashDataType {
117
118 public:
119 protected:
121 const Fields = ...;
122
123
124 public:
125
127 constructor();
128
129};
130};
DataProvider::AbstractDataProviderType
DataProvider::HashDataType
ElasticSearchDataProvider::ElasticSearchDataProviderBase
The ElasticSearch data provider base class.
Definition ElasticSearchDataProviderBase.qc.dox.h:28
ElasticSearchDataProvider::ElasticSearchDocumentReadDataProvider
The ElasticSearch document read API data provider.
Definition ElasticSearchDocumentReadDataProvider.qc.dox.h:30
ElasticSearchDataProvider::ElasticSearchDocumentReadDataProvider::ProviderSummaryInfo
const ProviderSummaryInfo
Provider summary info.
Definition ElasticSearchDocumentReadDataProvider.qc.dox.h:38
ElasticSearchDataProvider::ElasticSearchDocumentReadDataProvider::doRequestImpl
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
ElasticSearchDataProvider::ElasticSearchDocumentReadDataProvider::getRequestTypeImpl
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
ElasticSearchDataProvider::ElasticSearchDocumentReadDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
ElasticSearchDataProvider::ElasticSearchDocumentReadDataProvider::getStaticInfoImpl
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
ElasticSearchDataProvider::ElasticSearchDocumentReadDataProvider::getResponseTypeImpl
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
ElasticSearchDataProvider::ElasticSearchDocumentReadDataProvider::getName
string getName()
Returns the data provider name.
ElasticSearchDataProvider::ElasticSearchDocumentReadDataProvider::ResponseType
const ResponseType
Response type.
Definition ElasticSearchDocumentReadDataProvider.qc.dox.h:45
ElasticSearchDataProvider::ElasticSearchDocumentReadDataProvider::ProviderInfo
const ProviderInfo
Provider info.
Definition ElasticSearchDocumentReadDataProvider.qc.dox.h:34
ElasticSearchDataProvider::ElasticSearchDocumentReadDataProvider::RequestType
const RequestType
Request type.
Definition ElasticSearchDocumentReadDataProvider.qc.dox.h:42
ElasticSearchDataProvider::ElasticSearchDocumentReadDataProvider::QueryArgs
const QueryArgs
Query args.
Definition ElasticSearchDocumentReadDataProvider.qc.dox.h:48
ElasticSearchDataProvider::ElasticSearchDocumentReadDataProvider::constructor
constructor(RestClient::RestClient rest)
Creates the object from a REST connection.
ElasticSearchDataProvider::ElasticSearchDocumentReadDataProvider::getDesc
*string getDesc()
Returns the data provider description.
ElasticSearchDataProvider::ElasticSearchDocumentReadRequestDataType
Document read API request data type.
Definition ElasticSearchDocumentReadDataProvider.qc.dox.h:100
ElasticSearchDataProvider::ElasticSearchDocumentReadRequestDataType::constructor
constructor()
Creates the object.
ElasticSearchDataProvider::ElasticSearchDocumentReadRequestDataType::Fields
const Fields
Field descriptions.
Definition ElasticSearchDocumentReadDataProvider.qc.dox.h:105
ElasticSearchDataProvider::ElasticSearchDocumentReadResponseDataType
Document read API response.
Definition ElasticSearchDocumentReadDataProvider.qc.dox.h:116
ElasticSearchDataProvider::ElasticSearchDocumentReadResponseDataType::constructor
constructor()
Creates the object.
ElasticSearchDataProvider::ElasticSearchDocumentReadResponseDataType::Fields
const Fields
Field descriptions.
Definition ElasticSearchDocumentReadDataProvider.qc.dox.h:121
RestClient::RestClient
ElasticSearchDataProvider
Qore ElasticSearchDataProvider module definition.
Definition ElasticSearchAcknowledgedDataType.qc.dox.h:26