$darkmode
Qore ElasticSearchDataProvider Module Reference 1.0
ElasticSearchDocumentDeleteDataProvider.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 document delete API data provider",
40 "type": "ElasticSearchDocumentDeleteDataProvider",
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
82protected:
83 auto doRequestImpl(auto req, *hash<auto> request_options);
84public:
85
86
88
90protected:
92public:
93
94
96
98protected:
100public:
101
102
104 hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
105
106};
107
110
111public:
112protected:
114 const Fields = {
115 // query parameters
116 "index": {
117 "type": StringType,
118 "desc": "The name of the index holding the document to delete",
119 },
120 "id": {
121 "type": StringType,
122 "desc": "The ID of the document to delete",
123 },
124 "if_seq_no": {
125 "type": IntOrNothingType,
126 "desc": "Only perform the operation if the document has this sequence number",
127 },
128 "if_primary_term": {
129 "type": IntOrNothingType,
130 "desc": "Only perform the operation if the document has this primary term",
131 },
132 "refresh": {
133 "type": StringOrNothingType,
134 "desc": "If `true` (default `false`), Elasticsearch refreshes the affected shards to make this "
135 "operation visible to search, if `wait_for` then wait for a refresh to make this operation "
136 "visible to search, if `false` do nothing with refreshes. Valid values: `true`, `false`, "
137 "`wait_for`",
138 },
139 "routing": {
140 "type": StringOrNothingType,
141 "desc": "Custom value used to route operations to a specific shard",
142 },
143 "timeout": {
144 "type": StringOrNothingType,
145 "desc": "Period to wait for a response (default `1m`). If no response is received before the "
146 "timeout expires, the request fails and returns an error",
147 },
148 "version": {
149 "type": IntOrNothingType,
150 "desc": "Explicit version number for concurrency control. The specified version must match the "
151 "current version of the document for the request to succeed",
152 },
153 "version_type": {
154 "type": StringOrNothingType,
155 "desc": "Specific version type: `external`, `external_gte`",
156 },
157 "wait_for_active_shards": {
158 "type": StringOrNothingType,
159 "desc": "The number of shard copies that must be active before proceeding with the operation "
160 "(default `1`). Set to `all` or any positive integer up to the total number of shards in the "
161 "index (number_of_replicas+1)",
162 },
163 };
164
165public:
166
169
170};
171
174
175public:
176protected:
178 const Fields = {
179 "_index": {
180 "type": StringType,
181 "desc": "The name of the index the document was added to",
182 },
183 "_id": {
184 "type": StringType,
185 "desc": "The unique identifier for the added document",
186 },
187 "_version": {
188 "type": IntType,
189 "desc": "The document version. Incremented each time the document is updated",
190 },
191 "result": {
192 "type": StringType,
193 "desc": "The result of the indexing operation: `deleted`",
194 },
195 "_shards": {
197 "desc": "Provides information about the replication process of the index operation",
198 },
199 "_seq_no": {
200 "type": IntType,
201 "desc": "The sequence number assigned to the document for the indexing operation. Sequence numbers "
202 "are used to ensure an older version of a document doesn’t overwrite a newer version",
203 },
204 "_primary_term": {
205 "type": IntType,
206 "desc": "The primary term assigned to the document for the indexing operation",
207 },
208 "_type": {
209 "type": StringOrNothingType,
210 "desc": "The document type. Elasticsearch indices now support a single document type, `_doc`"
211 },
212 };
213
214public:
215
218
219};
220};
const ConstructorOptions
Constructor options.
Definition: ElasticSearchDataProvider.qc.dox.h:64
Shard data type.
Definition: ElasticSearchDocumentCreateDataProvider.qc.dox.h:188
The ElasticSearch document delete API data provider.
Definition: ElasticSearchDocumentDeleteDataProvider.qc.dox.h:30
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
const ProviderSummaryInfo
Provider summary info.
Definition: ElasticSearchDocumentDeleteDataProvider.qc.dox.h:46
const ProviderInfo
Provider info.
Definition: ElasticSearchDocumentDeleteDataProvider.qc.dox.h:37
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
constructor(RestClient::RestClient rest)
Creates the object from a REST connection.
*string getDesc()
Returns the data provider description.
const QueryArgs
Query args.
Definition: ElasticSearchDocumentDeleteDataProvider.qc.dox.h:57
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
constructor(*hash< auto > options)
Creates the object from constructor options.
const ResponseType
Response type.
Definition: ElasticSearchDocumentDeleteDataProvider.qc.dox.h:54
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
RestClient::RestClient rest
REST client connection.
Definition: ElasticSearchDocumentDeleteDataProvider.qc.dox.h:34
const RequestType
Request type.
Definition: ElasticSearchDocumentDeleteDataProvider.qc.dox.h:51
Document delete API request data type.
Definition: ElasticSearchDocumentDeleteDataProvider.qc.dox.h:109
const Fields
Field descriptions.
Definition: ElasticSearchDocumentDeleteDataProvider.qc.dox.h:114
Document delete API response.
Definition: ElasticSearchDocumentDeleteDataProvider.qc.dox.h:173
const Fields
Field descriptions.
Definition: ElasticSearchDocumentDeleteDataProvider.qc.dox.h:178
const True
Qore ElasticSearchDataProvider module definition.
Definition: ElasticSearchAcknowledgedDataType.qc.dox.h:26