$darkmode
Qore ElasticSearchDataProvider Module Reference 1.0
ElasticSearchIndexDeleteDataProvider.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
26 namespace ElasticSearchDataProvider {
28 
31 
32 public:
34  const ProviderInfo = <DataProviderInfo>{
35  "name": "delete",
36  "desc": "ElasticSearch index delete API data provider",
37  "type": "ElasticSearchIndexDeleteDataProvider",
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 = ("allow_no_indices", "expand_wildcards", "ignore_unavailable", "master_timeout", "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  "index": {
113  "type": StringType,
114  "desc": "The name of the index to delete",
115  },
116  "allow_no_indices": {
117  "type": SoftBoolStringType,
118  "desc": "If `false` (default `true`), the request returns an error if any wildcard expression, index "
119  "alias, or `_all` value targets only missing or closed indices. This behavior applies even if "
120  "the request targets other open indices. For example, a request targeting `foo*,bar*` returns an "
121  "error if an index starts with `foo` but no index starts with `bar`",
122  },
123  "expand_wildcards": {
124  "type": StringOrNothingType,
125  "desc": "Type of index that wildcard patterns can match. If the request can target data streams, "
126  "this argument determines whether wildcard expressions match hidden data streams. Supports "
127  "comma-separated values, such as `open,hidden` (default `open,closed`). Valid values are:\n"
128  "- `all`: Match any data stream or index, including hidden ones\n"
129  "- `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n"
130  "- `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data "
131  "streams cannot be closed\n"
132  "- `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, "
133  "`closed`, or both\n"
134  "- `none`: Wildcard patterns are not accepted",
135  },
136  "ignore_unavailable": {
137  "type": SoftBoolStringType,
138  "desc": "If `false, the request returns an error if it targets a missing or closed "
139  "index. Defaults to `false`",
140  },
141  "master_timeout": {
142  "type": StringOrNothingType,
143  "desc": "Period to wait for a connection to the master node (default `30s`). If no response is "
144  "received before the timeout expires, the request fails and returns an error",
145  },
146  "timeout": {
147  "type": StringOrNothingType,
148  "desc": "Period to wait for a response (default `30s`). If no response is received before the "
149  "timeout expires, the request fails and returns an error",
150  },
151  };
152 
153 public:
154 
157 
158 };
159 };
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 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:51
*string getDesc()
Returns the data provider description.
const ProviderSummaryInfo
Provider summary info.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:43
const QueryArgs
Query args.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:54
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
const RequestType
Request type.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:48
const ProviderInfo
Provider info.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:34
Index delete API request data type.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:105
const Fields
Field descriptions.
Definition: ElasticSearchIndexDeleteDataProvider.qc.dox.h:110
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