$darkmode
Qore ElasticSearchDataProvider Module Reference 1.0
ElasticSearchIndexDeleteDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
28
31
32public:
35
37 const ProviderInfo = <DataProviderInfo>{
38 "name": "delete",
39 "desc": "ElasticSearch index delete API data provider",
40 "type": "ElasticSearchIndexDeleteDataProvider",
42 "supports_request": True,
43 };
44
46 const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
47 AbstractDataProvider::DataProviderSummaryInfoKeys
48 });
49
52
55
57 const QueryArgs = ("allow_no_indices", "expand_wildcards", "ignore_unavailable", "master_timeout", "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 "index": {
116 "type": StringType,
117 "desc": "The name of the index to delete",
118 },
119 "allow_no_indices": {
120 "type": SoftBoolStringType,
121 "desc": "If `false` (default `true`), the request returns an error if any wildcard expression, index "
122 "alias, or `_all` value targets only missing or closed indices. This behavior applies even if "
123 "the request targets other open indices. For example, a request targeting `foo*,bar*` returns an "
124 "error if an index 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` (default `open,closed`). Valid values are:\n"
131 "- `all`: Match any data stream or index, including hidden ones\n"
132 "- `open`: 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 "ignore_unavailable": {
140 "type": SoftBoolStringType,
141 "desc": "If `false, the request returns an error if it targets a missing or closed "
142 "index. Defaults to `false`",
143 },
144 "master_timeout": {
145 "type": StringOrNothingType,
146 "desc": "Period to wait for a connection to the master node (default `30s`). If no response is "
147 "received before the timeout expires, the request fails and returns an error",
148 },
149 "timeout": {
150 "type": StringOrNothingType,
151 "desc": "Period to wait for a response (default `30s`). If no response is received before the "
152 "timeout expires, the request fails and returns an error",
153 },
154 };
155
156public:
157
160
161};
162};
The acknowledged response type.
Definition: ElasticSearchAcknowledgedDataType.qc.dox.h:28
const ConstructorOptions
Constructor options.
Definition: ElasticSearchDataProvider.qc.dox.h:64
The ElasticSearch index delete API data provider.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:30
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
constructor(RestClient::RestClient rest)
Creates the object from a REST connection.
constructor(*hash< auto > options)
Creates the object from constructor options.
const ResponseType
Response type.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:54
*string getDesc()
Returns the data provider description.
const ProviderSummaryInfo
Provider summary info.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:46
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
RestClient::RestClient rest
REST client connection.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:34
const QueryArgs
Query args.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:57
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
const RequestType
Request type.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:51
const ProviderInfo
Provider info.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:37
Index delete API request data type.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:108
const Fields
Field descriptions.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:113
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:134