Qore RestClientDataProvider Module Reference 1.0.1
Loading...
Searching...
No Matches
RestClientPutDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
26namespace RestClientDataProvider {
28class RestClientPutDataProvider : public AbstractDataProvider {
29
30public:
33
35 const ProviderInfo = <DataProviderInfo>{
36 "name": "put",
37 "desc": "REST PUT data provider; makes a `PUT` request to a REST server and returns the response",
38 "type": "RestClientPutDataProvider",
39 "constructor_options": RestClientDataProvider::ConstructorOptions,
40 "supports_request": True,
41 };
42
44 const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
45 AbstractDataProvider::DataProviderSummaryInfoKeys
46 });
47
50
53
55 constructor(*hash<auto> options);
56
57
60
61
63 string getName();
64
65
67
72protected:
73 auto doRequestImpl(auto req, *hash<auto> request_options);
74public:
75
76
78
80protected:
81 *AbstractDataProviderType getRequestTypeImpl();
82public:
83
84
86
88protected:
89 *AbstractDataProviderType getResponseTypeImpl();
90public:
91
92
94 hash<DataProviderInfo> getStaticInfoImpl();
95
96};
97};
Data type for REST call requests.
Definition: RestClientCallRequestDataType.qc.dox.h:27
Data type for REST call responses.
Definition: RestClientCallResponseDataType.qc.dox.h:27
const ConstructorOptions
Constructor arguments.
Definition: RestClientDataProvider.qc.dox.h:42
The REST client PUT data provider class.
Definition: RestClientPutDataProvider.qc.dox.h:28
constructor(*hash< auto > options)
Creates the object from constructor options.
const ResponseType
Response type.
Definition: RestClientPutDataProvider.qc.dox.h:52
const RequestType
Request type.
Definition: RestClientPutDataProvider.qc.dox.h:49
const ProviderInfo
Provider info.
Definition: RestClientPutDataProvider.qc.dox.h:35
constructor(RestClient rest)
Creates the object from a REST connection.
RestClient rest
REST client connection.
Definition: RestClientPutDataProvider.qc.dox.h:32
*AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
*AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
string getName()
Returns the data provider name.
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
const ProviderSummaryInfo
Provider summary info.
Definition: RestClientPutDataProvider.qc.dox.h:44
Qore RestClientDataProvider module definition.
Definition: RestClientCallDataProvider.qc.dox.h:26