Loading...
Searching...
No Matches
GoogleApiDataProvider.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
namespace GoogleDataProvider {
class GoogleApiDataProvider : public GoogleDataProviderBase {
public:
protected:
string api;
string resource_action;
*hash<auto> path_args;
string name;
string desc;
string category;
string type;
public:
constructor(GoogleRestClient::GoogleRestClient rest, string api, string resource_action, *hash<auto> path_args) ;
string getName();
*string getDesc();
protected:
*hash<auto> prepareRequestForSchema(auto req);
public:
protected:
auto doRequestImpl(auto req, *hash<auto> request_options);
public:
protected:
*DataProvider::AbstractDataProviderType getRequestTypeImpl();
public:
protected:
*DataProvider::AbstractDataProviderType getResponseTypeImpl();
public:
protected:
bool needsBackfillRequestBody();
public:
protected:
hash<auto> backfillRequestBody(auto req);
public:
protected:
*hash<auto> prepareRequestForSchema(string api, string resource_action, auto req, *bool in_backfill);
public:
protected:
AbstractDataProviderType getGoogleRequestType();
public:
protected:
hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
public:
};
};
GoogleDataProvider::GoogleApiDataProvider
The Google generic API data provider class.
Definition GoogleApiDataProvider.qc.dox.h:28
GoogleDataProvider::GoogleApiDataProvider::getResponseTypeImpl
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
GoogleDataProvider::GoogleApiDataProvider::resource_action
string resource_action
resource and action (ex: "events/get")
Definition GoogleApiDataProvider.qc.dox.h:36
GoogleDataProvider::GoogleApiDataProvider::doRequestImpl
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
GoogleDataProvider::GoogleApiDataProvider::getRequestTypeImpl
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
GoogleDataProvider::GoogleApiDataProvider::api
string api
The Google API name (ex: "calendar")
Definition GoogleApiDataProvider.qc.dox.h:33
GoogleDataProvider::GoogleApiDataProvider::getGoogleRequestType
AbstractDataProviderType getGoogleRequestType()
Returns the Google request type for the operation.
GoogleDataProvider::GoogleApiDataProvider::needsBackfillRequestBody
bool needsBackfillRequestBody()
If the request body should be populated with missing values.
GoogleDataProvider::GoogleApiDataProvider::getName
string getName()
Returns the data provider name.
GoogleDataProvider::GoogleApiDataProvider::getStaticInfoImpl
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
GoogleDataProvider::GoogleApiDataProvider::path_args
*hash< auto > path_args
Any path args associated with this data provider.
Definition GoogleApiDataProvider.qc.dox.h:39
GoogleDataProvider::GoogleApiDataProvider::prepareRequestForSchema
*hash< auto > prepareRequestForSchema(auto req)
Prepares information for an API request.
GoogleDataProvider::GoogleApiDataProvider::type
string type
Data provider type name.
Definition GoogleApiDataProvider.qc.dox.h:51
GoogleDataProvider::GoogleApiDataProvider::desc
string desc
Data provider description.
Definition GoogleApiDataProvider.qc.dox.h:45
GoogleDataProvider::GoogleApiDataProvider::constructor
constructor(GoogleRestClient::GoogleRestClient rest, string api, string resource_action, *hash< auto > path_args)
Creates the object.
GoogleDataProvider::GoogleApiDataProvider::prepareRequestForSchema
*hash< auto > prepareRequestForSchema(string api, string resource_action, auto req, *bool in_backfill)
Prepares information for an API request.
GoogleDataProvider::GoogleApiDataProvider::backfillRequestBody
hash< auto > backfillRequestBody(auto req)
Used to set attributes in the request body that are not set in the request.
GoogleDataProvider::GoogleApiDataProvider::getDesc
*string getDesc()
Returns the data provider description.
GoogleDataProvider::GoogleApiDataProvider::category
string category
The resource name.
Definition GoogleApiDataProvider.qc.dox.h:48
GoogleDataProvider::GoogleApiDataProvider::name
string name
The action name.
Definition GoogleApiDataProvider.qc.dox.h:42
GoogleDataProvider::GoogleDataProviderBase
The Google data provider base class.
Definition GoogleDataProviderBase.qc.dox.h:28
GoogleDataProvider::GoogleDataProviderBase::rest
*GoogleRestClient::GoogleRestClient rest
The REST client object for API calls.
Definition GoogleDataProviderBase.qc.dox.h:39
GoogleDataProvider
Qore GoogleDataProvider module definition.
Definition GoogleApiDataProvider.qc.dox.h:26