Qore SwaggerDataProvider Module Reference 1.3
Loading...
Searching...
No Matches
SwaggerDataProvider::SwaggerDataProvider Class Reference

The Swagger data provider class. More...

#include <SwaggerDataProvider.qc.dox.h>

Inheritance diagram for SwaggerDataProvider::SwaggerDataProvider:
[legend]

Public Member Functions

 constructor (*hash< auto > options)
 Creates the object from constructor options.
 
 constructor (SwaggerSchema schema, *RestClient rest)
 Creates the object from the arguments.
 
*string getDesc ()
 Returns the data provider description.
 
string getName ()
 Returns the data provider name.
 
- Public Member Functions inherited from SwaggerDataProvider::SwaggerDataProviderCommon
 constructor ()
 Creates the object.
 
 constructor (RestClient::RestClient rest)
 Creates the object.
 
SwaggerSchema getSchema ()
 Returns the Swagger schema.
 
 setLogger (*LoggerInterface logger)
 Accepts a LoggerInterface object for logging (or clears it)
 
 setRestClient (RestClient::RestClient rest)
 Sets the RestClient.
 
*RestClient::RestClient tryGetRestClient ()
 Returns the RestClient.
 

Public Attributes

const ConstructorOptions = ...
 Constructor options.
 
string display_name
 The value to returns as the name of the object.
 
const HttpMethods = ...
 Hash of HTTP Methods.
 
const ProviderInfo = ...
 Provider info.
 
string uri_path = "/"
 current URI path
 

Protected Member Functions

 checkRestClient (RestClient rest)
 Checks the REST client.
 
 constructor (hash< auto > path_tree, string uri_path, SwaggerSchema schema, *RestClient rest)
 Private constructor; used when traversing the tree.
 
AbstractDataProvider getChildIntern (string name, *string real_name)
 Returns the child provider for the given path component.
 
*AbstractDataProvider getChildProviderImpl (string name)
 Returns the given child provider or nothing if the given child is unknown.
 
*list< string > getChildProviderNamesImpl ()
 Returns a list of child data provider names, if any.
 
object getSchemaObjectImpl ()
 Returns the schema supporting this data provider.
 
hash< DataProviderInfo > getStaticInfoImpl ()
 Returns data provider static info.
 
 setSchema (SwaggerSchema schema)
 Sets the schema and display name.
 

Protected Attributes

hash< auto > path_tree
 hash of valid paths
 
- Protected Attributes inherited from SwaggerDataProvider::SwaggerDataProviderCommon
*RestClient::RestClient rest
 The REST client object for API calls.
 
SwaggerSchema schema
 The Swagger schema.
 

Detailed Description

The Swagger data provider class.

Member Function Documentation

◆ getChildProviderImpl()

*AbstractDataProvider SwaggerDataProvider::SwaggerDataProvider::getChildProviderImpl ( string name)
protected

Returns the given child provider or nothing if the given child is unknown.

Returns
the given child provider or nothing if the given child is unknown
See also
getChildProviderEx()

◆ getChildProviderNamesImpl()

*list< string > SwaggerDataProvider::SwaggerDataProvider::getChildProviderNamesImpl ( )
protected

Returns a list of child data provider names, if any.

Returns
a list of child data provider names, if any