| Qore GoogleDataProvider Module Reference 2.0

Loading...
Searching...
No Matches
GoogleApiDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
24
26 namespace GoogleDataProvider {
28 class GoogleApiDataProvider : public GoogleDataProviderBase {
29
30 public:
31 protected:
33 string api;
34
36 string resource_action;
37
39 *hash<string, softstring> path_args;
40
42 string name;
43
45 string desc;
46
48 string category;
49
51 string type;
52
53 public:
54
56 constructor(RestClient::RestClient rest, string api, string resource_action, *hash<auto> path_args) ;
57
58
60 string getName();
61
62
64 *string getDesc();
65
66
68 protected:
69 *hash<auto> prepareRequestForSchema(auto req);
70 public:
71
72
74
79 protected:
80 auto doRequestImpl(auto req, *hash<auto> request_options);
81 public:
82
83
85
87 protected:
88 *DataProvider::AbstractDataProviderType getRequestTypeImpl();
89 public:
90
91
93
95 protected:
96 *DataProvider::AbstractDataProviderType getResponseTypeImpl();
97 public:
98
99
101 protected:
102 bool needsBackfillRequestBody();
103 public:
104
105
107 protected:
108 hash<auto> backfillRequestBody(auto req);
109 public:
110
111
113 protected:
114 *hash<auto> prepareRequestForSchema(string api, string resource_action, auto req, *bool in_backfill);
115 public:
116
117
119 protected:
120 AbstractDataProviderType getGoogleRequestType();
121 public:
122
123
125 protected:
126 hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
127 public:
128
129};
130};
DataProvider::AbstractDataProviderType
GoogleDataProvider::GoogleApiDataProvider
The Google generic API data provider class.
Definition GoogleApiDataProvider.qc.dox.h:28
GoogleDataProvider::GoogleApiDataProvider::path_args
*hash< string, softstring > path_args
Any path args associated with this data provider.
Definition GoogleApiDataProvider.qc.dox.h:39
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::constructor
constructor(RestClient::RestClient rest, string api, string resource_action, *hash< auto > path_args)
Creates the object.
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::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::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
*RestClient::RestClient rest
The REST client object for API calls.
Definition GoogleDataProviderBase.qc.dox.h:39
RestClient::RestClient
GoogleDataProvider
Qore GoogleDataProvider module definition.
Definition GoogleApiDataProvider.qc.dox.h:26