Qore ElasticSearchDataProvider Module Reference 1.0
Loading...
Searching...
No Matches
ElasticSearchPipelineCreateDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
28
31
32public:
34 const ProviderInfo = <DataProviderInfo>{
35 "name": "create",
36 "desc": "ElasticSearch pipeline create API data provider",
37 "type": "ElasticSearchPipelineCreateDataProvider",
39 "supports_request": True,
40 };
41
43 const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
44 AbstractDataProvider::DataProviderSummaryInfoKeys
45 });
46
49
52
54 const QueryArgs = ("if_version", "master_timeout", "timeout");
55
57 constructor(*hash<auto> options);
58
59
62
63
65 string getName();
66
67
69 *string getDesc();
70
71
73
78protected:
79 auto doRequestImpl(auto req, *hash<auto> request_options);
80public:
81
82
84
86protected:
88public:
89
90
92
94protected:
96public:
97
98
100 hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
101
102};
103
106
107public:
108protected:
110 const Fields = {
111 // query parameters
112 "pipeline": {
113 "type": StringType,
114 "desc": "The name of the pipeline to create",
115 },
116 "if_version": {
117 "type": IntOrNothingType,
118 "desc": "Perform the operation only if the pipeline has this version. If specified and the update is "
119 "successful, the pipeline’s version is incremented",
120 },
121 "master_timeout": {
122 "type": StringOrNothingType,
123 "desc": "Period to wait for a connection to the master node (default: `30s`). If no response is "
124 "received before the timeout expires, the request fails and returns an error",
125 },
126 "timeout": {
127 "type": StringOrNothingType,
128 "desc": "Period to wait for a response (default: `30s`). If no response is received before the "
129 "timeout expires, the request fails and returns an error",
130 },
131 };
132
133public:
134
137
138};
139};
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 create API data provider.
Definition: ElasticSearchPipelineCreateDataProvider.qc.dox.h:30
constructor(RestClient::RestClient rest)
Creates the object from a REST connection.
const ProviderSummaryInfo
Provider summary info.
Definition: ElasticSearchPipelineCreateDataProvider.qc.dox.h:43
const RequestType
Request type.
Definition: ElasticSearchPipelineCreateDataProvider.qc.dox.h:48
const ResponseType
Response type.
Definition: ElasticSearchPipelineCreateDataProvider.qc.dox.h:51
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
const ProviderInfo
Provider info.
Definition: ElasticSearchPipelineCreateDataProvider.qc.dox.h:34
*string getDesc()
Returns the data provider description.
constructor(*hash< auto > options)
Creates the object from constructor options.
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
const QueryArgs
Query args.
Definition: ElasticSearchPipelineCreateDataProvider.qc.dox.h:54
Create pipeline request data type.
Definition: ElasticSearchPipelineCreateDataProvider.qc.dox.h:105
const Fields
Field descriptions.
Definition: ElasticSearchPipelineCreateDataProvider.qc.dox.h:110
Base data type for pipeline types.
Definition: ElasticSearchPipelineDataTypeBase.qc.dox.h:28
Qore ElasticSearchDataProvider module definition.
Definition: ElasticSearchAcknowledgedDataType.qc.dox.h:26