Qore RestClientDataProvider Module Reference  1.0
RestClientDataProvider::RestClientCallDataProvider Class Reference

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

Inherits AbstractDataProvider.

Public Member Functions

 constructor (__7_ 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 Attributes

const ProviderInfo
 Provider info.
 
const ProviderSummaryInfo
 Provider summary info.
 
const RequestType = new RestClientCallWithMethodRequestDataType()
 Request type.
 
const ResponseType = new RestClientCallResponseDataType()
 Response type.
 
RestClient rest
 REST client connection.
 

Protected Member Functions

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

Detailed Description

The REST client call data provider class.

Member Function Documentation

◆ doRequestImpl()

auto RestClientDataProvider::RestClientCallDataProvider::doRequestImpl ( auto  req,
__7_ hash< auto >  request_options 
)
protected

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()

__7_ AbstractDataProviderType RestClientDataProvider::RestClientCallDataProvider::getRequestTypeImpl ( )
protected

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

Returns
the request type for this provider

◆ getResponseTypeImpl()

__7_ AbstractDataProviderType RestClientDataProvider::RestClientCallDataProvider::getResponseTypeImpl ( )
protected

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

Returns
the response type for this response message