$darkmode
Qore RestClientDataProvider Module Reference 1.1
RestClientPatchDataProvider.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
26 namespace RestClientDataProvider {
29 
30 public:
32  const ProviderInfo = <DataProviderInfo>{
33  "name": "patch",
34  "desc": "REST PATCH data provider; makes a `PATCH` request to a REST server and returns the response",
35  "type": "RestClientPatchDataProvider",
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 
69 protected:
70  auto doRequestImpl(auto req, *hash<auto> request_options);
71 public:
72 
73 
75 
77 protected:
78  *AbstractDataProviderType getRequestTypeImpl();
79 public:
80 
81 
83 
85 protected:
86  *AbstractDataProviderType getResponseTypeImpl();
87 public:
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 PATCH data provider class.
Definition: RestClientPatchDataProvider.qc.dox.h:28
const ProviderInfo
Provider info.
Definition: RestClientPatchDataProvider.qc.dox.h:32
string getName()
Returns the data provider name.
const ProviderSummaryInfo
Provider summary info.
Definition: RestClientPatchDataProvider.qc.dox.h:41
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
const ResponseType
Response type.
Definition: RestClientPatchDataProvider.qc.dox.h:49
const RequestType
Request type.
Definition: RestClientPatchDataProvider.qc.dox.h:46
*AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
constructor(RestClient rest)
Creates the object from a REST connection.
constructor(*hash< auto > options)
Creates the object from constructor options.
*AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
const True
Qore RestClientDataProvider module definition.
Definition: RestClientCallDataProvider.qc.dox.h:26