Qore ElasticSearchDataProvider Module Reference 1.0
Loading...
Searching...
No Matches
ElasticSearchPipelineReadDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
28
34
35public:
37 const ProviderInfo = <DataProviderInfo>{
38 "name": "read",
39 "desc": "ElasticSearch pipeline read API data provider",
40 "type": "ElasticSearchPipelineReadDataProvider",
42 "supports_request": True,
43 };
44
46 const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
47 AbstractDataProvider::DataProviderSummaryInfoKeys
48 });
49
52
55
57 const QueryArgs = ("master_timeout",);
58
60 constructor(*hash<auto> options);
61
62
65
66
68 string getName();
69
70
72 *string getDesc();
73
74
76
81protected:
82 auto doRequestImpl(auto req, *hash<auto> request_options);
83public:
84
85
87
89protected:
91public:
92
93
95
97protected:
99public:
100
101
103 hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
104
105};
106
109
110public:
111protected:
113 const Fields = {
114 // query parameters
115 "pipeline": {
116 "type": StringType,
117 "desc": "The name of the pipeline to read",
118 },
119 "master_timeout": {
120 "type": StringOrNothingType,
121 "desc": "Period to wait for a connection to the master node (default: `30s`). If no response is "
122 "received before the timeout expires, the request fails and returns an error",
123 },
124 };
125
126public:
127
130
131};
132
135
136public:
139
140};
141};
The acknowledged response type.
Definition: ElasticSearchAcknowledgedDataType.qc.dox.h:28
The AWS REST client base data provider class.
Definition: ElasticSearchDataProviderBase.qc.dox.h:28
const ConstructorOptions
Constructor options.
Definition: ElasticSearchDataProvider.qc.dox.h:61
The ElasticSearch pipeline read API data provider.
Definition: ElasticSearchPipelineReadDataProvider.qc.dox.h:33
const ResponseType
Response type.
Definition: ElasticSearchPipelineReadDataProvider.qc.dox.h:54
const QueryArgs
Query args.
Definition: ElasticSearchPipelineReadDataProvider.qc.dox.h:57
const ProviderSummaryInfo
Provider summary info.
Definition: ElasticSearchPipelineReadDataProvider.qc.dox.h:46
*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:37
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:51
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:108
const Fields
Field descriptions.
Definition: ElasticSearchPipelineReadDataProvider.qc.dox.h:113
ElasticSearch pipeline read API response.
Definition: ElasticSearchPipelineReadDataProvider.qc.dox.h:134
Qore ElasticSearchDataProvider module definition.
Definition: ElasticSearchAcknowledgedDataType.qc.dox.h:26