$darkmode
Qore ElasticSearchDataProvider Module Reference 1.0
ElasticSearchPipelineDeleteDataProvider.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 pipeline delete API data provider",
37  "type": "ElasticSearchPipelineDeleteDataProvider",
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 = ("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 
105 class ElasticSearchPipelineDeleteRequestDataType : public HashDataType {
106 
107 public:
108 protected:
110  const Fields = {
111  // query parameters
112  "pipeline": {
113  "type": StringType,
114  "desc": "The name of the pipeline to delete",
115  },
116  "master_timeout": {
117  "type": StringOrNothingType,
118  "desc": "Period to wait for a connection to the master node (default: `30s`). If no response is "
119  "received before the timeout expires, the request fails and returns an error",
120  },
121  "timeout": {
122  "type": StringOrNothingType,
123  "desc": "Period to wait for a response (default: `30s`). If no response is received before the "
124  "timeout expires, the request fails and returns an error",
125  },
126  };
127 
128 public:
129 
132 
133 };
134 };
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 pipeline delete API data provider.
Definition: ElasticSearchPipelineDeleteDataProvider.qc.dox.h:30
constructor(*hash< auto > options)
Creates the object from constructor options.
const ProviderInfo
Provider info.
Definition: ElasticSearchPipelineDeleteDataProvider.qc.dox.h:34
*string getDesc()
Returns the data provider description.
const ProviderSummaryInfo
Provider summary info.
Definition: ElasticSearchPipelineDeleteDataProvider.qc.dox.h:43
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
const ResponseType
Response type.
Definition: ElasticSearchPipelineDeleteDataProvider.qc.dox.h:51
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
const RequestType
Request type.
Definition: ElasticSearchPipelineDeleteDataProvider.qc.dox.h:48
constructor(RestClient::RestClient rest)
Creates the object from a REST connection.
*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 QueryArgs
Query args.
Definition: ElasticSearchPipelineDeleteDataProvider.qc.dox.h:54
Pipeline delete API response.
Definition: ElasticSearchPipelineDeleteDataProvider.qc.dox.h:105
const Fields
Field descriptions.
Definition: ElasticSearchPipelineDeleteDataProvider.qc.dox.h:110
const True
Qore ElasticSearchDataProvider module definition.
Definition: ElasticSearchAcknowledgedDataType.qc.dox.h:26