$darkmode
Qore ElasticSearchDataProvider Module Reference 1.0
ElasticSearchPipelineReadAllDataProvider.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
26 namespace ElasticSearchDataProvider {
28 
31 
32 public:
34  const ProviderInfo = <DataProviderInfo>{
35  "name": "read-all",
36  "desc": "ElasticSearch pipeline read all API data provider",
37  "type": "ElasticSearchPipelineReadAllDataProvider",
38  "constructor_options": ElasticSearchDataProvider::ConstructorOptions,
39  "supports_request": True,
40  };
41 
43  const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
44  AbstractDataProvider::DataProviderSummaryInfoKeys
45  });
46 
49 
52 
54  const QueryArgs = ("master_timeout");
55 
57  constructor(*hash<auto> options);
58 
59 
62 
63 
65  string getName();
66 
67 
69  *string getDesc();
70 
71 
73 
78 protected:
79  auto doRequestImpl(auto req, *hash<auto> request_options);
80 public:
81 
82 
84 
86 protected:
88 public:
89 
90 
92 
94 protected:
96 public:
97 
98 
100  hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
101 
102 };
103 
106 
107 public:
108 protected:
110  const Fields = {
111  // query parameters
112  "master_timeout": {
113  "type": StringOrNothingType,
114  "desc": "Period to wait for a connection to the master node (default: `30s`). If no response is "
115  "received before the timeout expires, the request fails and returns an error",
116  },
117  };
118 
119 public:
120 
123 
124 };
125 };
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 read all pipelines API data provider.
Definition: ElasticSearchPipelineReadAllDataProvider.qc.dox.h:30
const QueryArgs
Query args.
Definition: ElasticSearchPipelineReadAllDataProvider.qc.dox.h:54
const ResponseType
Response type.
Definition: ElasticSearchPipelineReadAllDataProvider.qc.dox.h:51
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
const ProviderInfo
Provider info.
Definition: ElasticSearchPipelineReadAllDataProvider.qc.dox.h:34
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
const ProviderSummaryInfo
Provider summary info.
Definition: ElasticSearchPipelineReadAllDataProvider.qc.dox.h:43
const RequestType
Request type.
Definition: ElasticSearchPipelineReadAllDataProvider.qc.dox.h:48
constructor(*hash< auto > options)
Creates the object from constructor options.
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
*string getDesc()
Returns the data provider description.
constructor(RestClient::RestClient rest)
Creates the object from a REST connection.
ElasticSearch pipeline read API request.
Definition: ElasticSearchPipelineReadAllDataProvider.qc.dox.h:105
const Fields
Field descriptions.
Definition: ElasticSearchPipelineReadAllDataProvider.qc.dox.h:110
ElasticSearch pipeline read API response.
Definition: ElasticSearchPipelineReadDataProvider.qc.dox.h:134
const True
Qore ElasticSearchDataProvider module definition.
Definition: ElasticSearchAcknowledgedDataType.qc.dox.h:26