Qore RestClientDataProvider Module Reference 1.1
Loading...
Searching...
No Matches
RestClientPutDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
26namespace RestClientDataProvider {
29
30public:
32 const ProviderInfo = <DataProviderInfo>{
33 "name": "put",
34 "desc": "REST PUT data provider; makes a `PUT` request to a REST server and returns the response",
35 "type": "RestClientPutDataProvider",
36 "constructor_options": RestClientDataProvider::ConstructorOptions,
37 "supports_request": True,
38 };
39
41 const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
42 AbstractDataProvider::DataProviderSummaryInfoKeys
43 });
44
47
50
52 constructor(*hash<auto> options);
53
54
57
58
60 string getName();
61
62
64
69protected:
70 auto doRequestImpl(auto req, *hash<auto> request_options);
71public:
72
73
75
77protected:
78 *AbstractDataProviderType getRequestTypeImpl();
79public:
80
81
83
85protected:
86 *AbstractDataProviderType getResponseTypeImpl();
87public:
88
89
91 hash<DataProviderInfo> getStaticInfoImpl();
92
93};
94};
Data type for REST call requests.
Definition: RestClientCallRequestDataType.qc.dox.h:27
Data type for REST call responses.
Definition: RestClientCallResponseDataType.qc.dox.h:27
The REST client data provider class, provides API classes as children.
Definition: RestClientDataProviderBase.qc.dox.h:28
RestClient::RestClient rest
The REST client object.
Definition: RestClientDataProviderBase.qc.dox.h:33
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:49
const RequestType
Request type.
Definition: RestClientPutDataProvider.qc.dox.h:46
const ProviderInfo
Provider info.
Definition: RestClientPutDataProvider.qc.dox.h:32
constructor(RestClient rest)
Creates the object from a REST connection.
*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:41
Qore RestClientDataProvider module definition.
Definition: RestClientCallDataProvider.qc.dox.h:26