$darkmode
Qore ElasticSearchDataProvider Module Reference 1.0
ElasticSearchPipelineReadDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
28
34
35public:
38
40 const ProviderInfo = <DataProviderInfo>{
41 "name": "read",
42 "desc": "ElasticSearch pipeline read API data provider",
43 "type": "ElasticSearchPipelineReadDataProvider",
45 "supports_request": True,
46 };
47
49 const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
50 AbstractDataProvider::DataProviderSummaryInfoKeys
51 });
52
55
58
60 const QueryArgs = ("master_timeout",);
61
63 constructor(*hash<auto> options);
64
65
68
69
71 string getName();
72
73
75 *string getDesc();
76
77
79
84protected:
85 auto doRequestImpl(auto req, *hash<auto> request_options);
86public:
87
88
90
92protected:
94public:
95
96
98
100protected:
102public:
103
104
106 hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
107
108};
109
112
113public:
114protected:
116 const Fields = {
117 // query parameters
118 "pipeline": {
119 "type": StringType,
120 "desc": "The name of the pipeline to read",
121 },
122 "master_timeout": {
123 "type": StringOrNothingType,
124 "desc": "Period to wait for a connection to the master node (default: `30s`). If no response is "
125 "received before the timeout expires, the request fails and returns an error",
126 },
127 };
128
129public:
130
133
134};
135
138
139public:
142
143};
144};
The acknowledged response type.
Definition: ElasticSearchAcknowledgedDataType.qc.dox.h:28
const ConstructorOptions
Constructor options.
Definition: ElasticSearchDataProvider.qc.dox.h:64
The ElasticSearch pipeline read API data provider.
Definition: ElasticSearchPipelineReadDataProvider.qc.dox.h:33
const ResponseType
Response type.
Definition: ElasticSearchPipelineReadDataProvider.qc.dox.h:57
const QueryArgs
Query args.
Definition: ElasticSearchPipelineReadDataProvider.qc.dox.h:60
const ProviderSummaryInfo
Provider summary info.
Definition: ElasticSearchPipelineReadDataProvider.qc.dox.h:49
*string getDesc()
Returns the data provider description.
constructor(*hash< auto > options)
Creates the object from constructor options.
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
const ProviderInfo
Provider info.
Definition: ElasticSearchPipelineReadDataProvider.qc.dox.h:40
constructor(RestClient::RestClient rest)
Creates the object from a REST connection.
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
const RequestType
Request type.
Definition: ElasticSearchPipelineReadDataProvider.qc.dox.h:54
RestClient::RestClient rest
REST client connection.
Definition: ElasticSearchPipelineReadDataProvider.qc.dox.h:37
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
ElasticSearch pipeline read API request.
Definition: ElasticSearchPipelineReadDataProvider.qc.dox.h:111
const Fields
Field descriptions.
Definition: ElasticSearchPipelineReadDataProvider.qc.dox.h:116
ElasticSearch pipeline read API response.
Definition: ElasticSearchPipelineReadDataProvider.qc.dox.h:137
const True
Qore ElasticSearchDataProvider module definition.
Definition: ElasticSearchAcknowledgedDataType.qc.dox.h:26