Qore RestClientDataProvider Module Reference 1.1
Loading...
Searching...
No Matches
RestClientDataProvider::RestClientPostDataProvider Class Reference

The REST client POST data provider class. More...

#include <RestClientPostDataProvider.qc.dox.h>

Inheritance diagram for RestClientDataProvider::RestClientPostDataProvider:
[legend]

Public Member Methods

 constructor (*hash< auto > options)
 Creates the object from constructor options.
 
 constructor (RestClient rest)
 Creates the object from a REST connection.
 
string getName ()
 Returns the data provider name.
 
hash< DataProviderInfo > getStaticInfoImpl ()
 Returns data provider static info.
 
- Public Member Methods inherited from RestClientDataProvider::RestClientDataProviderBase
 constructor ()
 Creates the object.
 
 constructor (RestClient::RestClient rest)
 Creates the object.
 
 setLogger (*LoggerInterface logger)
 Accepts a LoggerInterface object for logging (or clears it)
 

Public Attributes

const ProviderInfo
 Provider info.
 
const ProviderSummaryInfo
 Provider summary info.
 
const RequestType = new RestClientCallRequestDataType()
 Request type.
 
const ResponseType = new RestClientCallResponseDataType()
 Response type.
 

Private Member Methods

auto doRequestImpl (auto req, *hash< auto > request_options)
 Makes a request and returns the response. More...
 
*AbstractDataProviderType getRequestTypeImpl ()
 Returns the description of a successful request message, if any. More...
 
*AbstractDataProviderType getResponseTypeImpl ()
 Returns the description of a response message, if this object represents a response message. More...
 

Additional Inherited Members

- Private Attributes inherited from RestClientDataProvider::RestClientDataProviderBase
RestClient::RestClient rest
 The REST client object.
 

Detailed Description

The REST client POST data provider class.

Member Function Documentation

◆ doRequestImpl()

auto RestClientDataProvider::RestClientPostDataProvider::doRequestImpl ( auto  req,
*hash< auto >  request_options 
)
private

Makes a request and returns the response.

Parameters
reqthe request info
request_optionsthe request options after processing by validateRequestOptions()
Returns
the response to the request

◆ getRequestTypeImpl()

*AbstractDataProviderType RestClientDataProvider::RestClientPostDataProvider::getRequestTypeImpl ( )
private

Returns the description of a successful request message, if any.

Returns
the request type for this provider

◆ getResponseTypeImpl()

*AbstractDataProviderType RestClientDataProvider::RestClientPostDataProvider::getResponseTypeImpl ( )
private

Returns the description of a response message, if this object represents a response message.

Returns
the response type for this response message