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