| Qore ElasticSearchDataProvider Module Reference 1.1

Loading...
Searching...
No Matches
ElasticSearchIndexReadAllDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
24
26 namespace ElasticSearchDataProvider {
28
30 class ElasticSearchIndexReadAllDataProvider : public ElasticSearchDataProviderBase {
31
32 public:
34 const ProviderInfo = ...;
35
36
38 const ProviderSummaryInfo = ...;
39
40
42 const RequestType = new ElasticSearchIndexReadAllRequestDataType();
43
45 const ResponseType = new ElasticSearchIndexReadResponseDataType();
46
48 const QueryArgs = ElasticSearchIndexReadDataProvider::QueryArgs;
49
51 constructor(*hash<auto> options);
52
53
55 constructor(RestClient::RestClient rest) ;
56
57
59 string getName();
60
61
63 *string getDesc();
64
65
67
72 protected:
73 auto doRequestImpl(auto req, *hash<auto> request_options);
74 public:
75
76
78
80 protected:
81 *DataProvider::AbstractDataProviderType getRequestTypeImpl();
82 public:
83
84
86
88 protected:
89 *DataProvider::AbstractDataProviderType getResponseTypeImpl();
90 public:
91
92
94 hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
95
96};
97
99 class ElasticSearchIndexReadAllRequestDataType : public DataProvider::HashDataType {
100
101 public:
102 protected:
104 const Fields = ElasticSearchIndexReadRequestDataType::Fields - "name";
105
106 public:
107
109 constructor();
110
111};
112};
DataProvider::AbstractDataProviderType
DataProvider::HashDataType
ElasticSearchDataProvider::ElasticSearchDataProviderBase
The ElasticSearch data provider base class.
Definition ElasticSearchDataProviderBase.qc.dox.h:28
ElasticSearchDataProvider::ElasticSearchIndexReadAllDataProvider
The ElasticSearch read all indices API data provider.
Definition ElasticSearchIndexReadAllDataProvider.qc.dox.h:30
ElasticSearchDataProvider::ElasticSearchIndexReadAllDataProvider::ProviderSummaryInfo
const ProviderSummaryInfo
Provider summary info.
Definition ElasticSearchIndexReadAllDataProvider.qc.dox.h:38
ElasticSearchDataProvider::ElasticSearchIndexReadAllDataProvider::QueryArgs
const QueryArgs
Query args.
Definition ElasticSearchIndexReadAllDataProvider.qc.dox.h:48
ElasticSearchDataProvider::ElasticSearchIndexReadAllDataProvider::getName
string getName()
Returns the data provider name.
ElasticSearchDataProvider::ElasticSearchIndexReadAllDataProvider::constructor
constructor(RestClient::RestClient rest)
Creates the object from a REST connection.
ElasticSearchDataProvider::ElasticSearchIndexReadAllDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
ElasticSearchDataProvider::ElasticSearchIndexReadAllDataProvider::ProviderInfo
const ProviderInfo
Provider info.
Definition ElasticSearchIndexReadAllDataProvider.qc.dox.h:34
ElasticSearchDataProvider::ElasticSearchIndexReadAllDataProvider::getResponseTypeImpl
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
ElasticSearchDataProvider::ElasticSearchIndexReadAllDataProvider::doRequestImpl
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
ElasticSearchDataProvider::ElasticSearchIndexReadAllDataProvider::getStaticInfoImpl
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
ElasticSearchDataProvider::ElasticSearchIndexReadAllDataProvider::RequestType
const RequestType
Request type.
Definition ElasticSearchIndexReadAllDataProvider.qc.dox.h:42
ElasticSearchDataProvider::ElasticSearchIndexReadAllDataProvider::getRequestTypeImpl
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
ElasticSearchDataProvider::ElasticSearchIndexReadAllDataProvider::getDesc
*string getDesc()
Returns the data provider description.
ElasticSearchDataProvider::ElasticSearchIndexReadAllDataProvider::ResponseType
const ResponseType
Response type.
Definition ElasticSearchIndexReadAllDataProvider.qc.dox.h:45
ElasticSearchDataProvider::ElasticSearchIndexReadAllRequestDataType
ElasticSearch index read-all API request.
Definition ElasticSearchIndexReadAllDataProvider.qc.dox.h:99
ElasticSearchDataProvider::ElasticSearchIndexReadAllRequestDataType::constructor
constructor()
Creates the object.
ElasticSearchDataProvider::ElasticSearchIndexReadAllRequestDataType::Fields
const Fields
Field descriptions.
Definition ElasticSearchIndexReadAllDataProvider.qc.dox.h:104
ElasticSearchDataProvider::ElasticSearchIndexReadDataProvider::QueryArgs
const QueryArgs
Query args.
Definition ElasticSearchIndexReadDataProvider.qc.dox.h:51
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
RestClient::RestClient
ElasticSearchDataProvider
Qore ElasticSearchDataProvider module definition.
Definition ElasticSearchAcknowledgedDataType.qc.dox.h:26