$darkmode
Qore ElasticSearchDataProvider Module Reference 1.0
ElasticSearchIndexReadDataProvider.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
26 namespace ElasticSearchDataProvider {
28 
34 
35 public:
37  const ProviderInfo = <DataProviderInfo>{
38  "name": "read",
39  "desc": "ElasticSearch index read API data provider",
40  "type": "ElasticSearchIndexReadDataProvider",
41  "constructor_options": ElasticSearchDataProvider::ConstructorOptions,
42  "supports_request": True,
43  };
44 
46  const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
47  AbstractDataProvider::DataProviderSummaryInfoKeys
48  });
49 
52 
55 
57  const QueryArgs = ...;
58 
59 
61  constructor(*hash<auto> options);
62 
63 
66 
67 
69  string getName();
70 
71 
73  *string getDesc();
74 
75 
77 
82 protected:
83  auto doRequestImpl(auto req, *hash<auto> request_options);
84 public:
85 
86 
88 
90 protected:
92 public:
93 
94 
96 
98 protected:
100 public:
101 
102 
104  hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
105 
106 };
107 
110 
111 public:
113  const Fields = {
114  // query parameters
115  "index": {
116  "type": StringType,
117  "desc": "The name of the index to read",
118  },
119  "allow_no_indices": {
120  "type": SoftBoolStringType,
121  "desc": "f `false`, the request returns an error if any wildcard expression, index alias, or `_all` "
122  "value targets only missing or closed indices. This behavior applies even if the request targets "
123  "other open indices. For example, a request targeting `foo*,bar*` returns an error if an index "
124  "starts with `foo` but no index starts with `bar`",
125  },
126  "expand_wildcards": {
127  "type": StringOrNothingType,
128  "desc": "Type of index that wildcard patterns can match. If the request can target data streams, "
129  "this argument determines whether wildcard expressions match hidden data streams. Supports "
130  "comma-separated values, such as open,hidden. Valid values are:\n"
131  "- `all`: Match any data stream or index, including hidden ones\n"
132  "- `open`: (default) Match open, non-hidden indices. Also matches any non-hidden data stream.\n"
133  "- `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data "
134  "streams cannot be closed\n"
135  "- `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, "
136  "`closed`, or both\n"
137  "- `none`: Wildcard patterns are not accepted",
138  },
139  "features": {
140  "type": StringOrNothingType,
141  "desc": "Return information about specific index features. Supports comma-separated values. Valid "
142  "values are: `aliases`, `mappings`, and `settings`.",
143  },
144  "flat_settings": {
145  "type": SoftBoolStringType,
146  "desc": "If `true`, returns settings in flat format",
147  },
148  "include_defaults": {
149  "type": SoftBoolStringType,
150  "desc": "If `true`, return all default settings in the response",
151  },
152  "ignore_unavailable": {
153  "type": SoftBoolStringType,
154  "desc": "If `false`, the request returns an error if it targets a missing or closed index",
155  },
156  "master_timeout": {
157  "type": StringOrNothingType,
158  "desc": "Period to wait for a connection to the master node. If no response is received before the "
159  "timeout expires, the request fails and returns an error",
160  },
161  };
162 
165 
166 };
167 
169 class ElasticSearchIndexReadResponseDataType : public HashDataType {
170 
171 public:
174 
175 };
176 };
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 index read API data provider.
Definition: ElasticSearchIndexReadDataProvider.qc.dox.h:33
*string getDesc()
Returns the data provider description.
constructor(*hash< auto > options)
Creates the object from constructor options.
const QueryArgs
Query args.
Definition: ElasticSearchIndexReadDataProvider.qc.dox.h:57
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
const ProviderSummaryInfo
Provider summary info.
Definition: ElasticSearchIndexReadDataProvider.qc.dox.h:46
const RequestType
Request type.
Definition: ElasticSearchIndexReadDataProvider.qc.dox.h:51
constructor(RestClient::RestClient rest)
Creates the object from a REST connection.
string getName()
Returns the data provider name.
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
const ResponseType
Response type.
Definition: ElasticSearchIndexReadDataProvider.qc.dox.h:54
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
const ProviderInfo
Provider info.
Definition: ElasticSearchIndexReadDataProvider.qc.dox.h:37
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
ElasticSearch index read API request.
Definition: ElasticSearchIndexReadDataProvider.qc.dox.h:109
const Fields
Field descriptions.
Definition: ElasticSearchIndexReadDataProvider.qc.dox.h:113
ElasticSearch index read API response.
Definition: ElasticSearchIndexReadDataProvider.qc.dox.h:169
const True
Qore ElasticSearchDataProvider module definition.
Definition: ElasticSearchAcknowledgedDataType.qc.dox.h:26
const SoftBoolStringType
Boolean string type for query parameters.
Definition: ElasticSearchDataProvider.qc.dox.h:135