Qore RestClientDataProvider Module Reference  1.0
RestClientOptionsDataProvider.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
26 namespace RestClientDataProvider {
28 class RestClientOptionsDataProvider : public AbstractDataProvider {
29 
30 public:
33 
35  const ProviderInfo = <DataProviderInfo>{
36  "name": "options",
37  "desc": "REST OPTIONS data provider; makes an `OPTIONS` request to a REST server and returns the "
38  "response",
39  "type": "RestClientOptionsDataProvider",
40  "constructor_options": RestClientDataProvider::ConstructorOptions,
41  "supports_request": True,
42  };
43 
45  const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
46  AbstractDataProvider::DataProviderSummaryInfoKeys
47  });
48 
51 
54 
56  constructor(*hash<auto> options);
57 
58 
61 
62 
64  string getName();
65 
66 
68 
73 protected:
74  auto doRequestImpl(auto req, *hash<auto> request_options);
75 public:
76 
77 
80 
82 protected:
83  *AbstractDataProviderType getRequestTypeImpl();
84 public:
85 
86 
88 
90 protected:
91  *AbstractDataProviderType getResponseTypeImpl();
92 public:
93 
94 
96  hash<DataProviderInfo> getStaticInfoImpl();
97 
98 };
99 };
Data type for REST call responses.
Definition: RestClientCallResponseDataType.qc.dox.h:27
Data type for REST client call requests with no message bodies.
Definition: RestClientCallWithoutBodyRequestDataType.qc.dox.h:27
const ConstructorOptions
Constructor arguments.
Definition: RestClientDataProvider.qc.dox.h:42
The REST client OPTIONS data provider class.
Definition: RestClientOptionsDataProvider.qc.dox.h:28
const RequestType
Request type.
Definition: RestClientOptionsDataProvider.qc.dox.h:50
*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.
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
RestClient rest
REST client connection.
Definition: RestClientOptionsDataProvider.qc.dox.h:32
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
const ProviderInfo
Provider info.
Definition: RestClientOptionsDataProvider.qc.dox.h:35
const ResponseType
Response type.
Definition: RestClientOptionsDataProvider.qc.dox.h:53
string getName()
Returns the data provider name.
constructor(*hash< auto > options)
Creates the object from constructor options.
const ProviderSummaryInfo
Provider summary info.
Definition: RestClientOptionsDataProvider.qc.dox.h:45
const True
Qore RestClientDataProvider module definition.
Definition: RestClientCallDataProvider.qc.dox.h:26