Loading...
Searching...
No Matches
AwsRestClientDataProvider.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
namespace AwsRestClientDataProvider {
class AwsRestClientDataProvider : public AbstractDataProvider {
public:
const ProviderInfo = <DataProviderInfo>{
"type": "AwsRestClientDataProvider",
"constructor_options": ConstructorOptions,
"supports_children": True,
"children_can_support_apis": True,
"children_can_support_records": False,
"children_can_support_observers": False,
};
const ConstructorOptions = RestClientDataProvider::ConstructorOptions + {
"data": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(StringType),
"desc": "Data serialization options are limited to `json` with this object",
"allowed_values": (
<AllowedValueInfo>{
"value": "json",
"desc": "use JSON serialization",
},
),
"default_value": "json",
},
"aws_keyid": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(StringType),
"desc": "AWS key ID",
},
"aws_secret": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(StringType),
"desc": "The AWS secret access key value",
"sensitive": True,
},
"aws_region": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(StringType),
"desc": "The AWS region to use (ex: `us-east-1`)",
},
"aws_service": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(StringType),
"desc": "The AWS service to use (ex: `iam`)",
},
"aws_s3": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(BoolType),
"desc": "Set to `True` to flag this object for use with AWS S3, which requires special "
"message encoding",
"default_value": False,
},
"aws_token": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(StringType),
"desc": "A temporary session token from AWS Security Token Service for this HTTP session",
},
};
AwsRestClient rest;
protected:
const ChildMap = {
"call": Class::forName("AwsRestClientDataProvider::AwsRestClientCallDataProvider"),
"delete": Class::forName("AwsRestClientDataProvider::AwsRestClientDeleteDataProvider"),
"get": Class::forName("AwsRestClientDataProvider::AwsRestClientGetDataProvider"),
"head": Class::forName("AwsRestClientDataProvider::AwsRestClientHeadDataProvider"),
"options": Class::forName("AwsRestClientDataProvider::AwsRestClientOptionsDataProvider"),
"path": Class::forName("AwsRestClientDataProvider::AwsRestClientPatchDataProvider"),
"post": Class::forName("AwsRestClientDataProvider::AwsRestClientPostDataProvider"),
"put": Class::forName("AwsRestClientDataProvider::AwsRestClientPutDataProvider"),
};
public:
constructor(*hash<auto> options);
constructor(AwsRestClient rest);
string getName();
*string getDesc();
*list<hash<DataProviderSummaryInfo>> getChildProviderSummaryInfo();
static AwsRestClient getAwsRestConnection(hash<auto> options);
protected:
*list<string> getChildProviderNamesImpl();
public:
protected:
*AbstractDataProvider getChildProviderImpl(string name);
public:
protected:
hash<DataProviderInfo> getStaticInfoImpl();
public:
};
};
AwsRestClientDataProvider::AwsRestClientDataProvider::getAwsRestConnection
static AwsRestClient getAwsRestConnection(hash< auto > options)
Returns a REST connection.
AwsRestClientDataProvider::AwsRestClientDataProvider::constructor
constructor(AwsRestClient rest)
Creates the object from a REST connection.
AwsRestClientDataProvider::AwsRestClientDataProvider::getName
string getName()
Returns the data provider name.
AwsRestClientDataProvider::AwsRestClientDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
AwsRestClientDataProvider::AwsRestClientDataProvider::getChildProviderImpl
*AbstractDataProvider getChildProviderImpl(string name)
Returns the given child provider or NOTHING if the given child is unknown.
AwsRestClientDataProvider::AwsRestClientDataProvider::getChildProviderNamesImpl
*list< string > getChildProviderNamesImpl()
Returns a list of child data provider names, if any.
AwsRestClientDataProvider::AwsRestClientDataProvider::getChildProviderSummaryInfo
*list< hash< DataProviderSummaryInfo > > getChildProviderSummaryInfo()
Return data provider summary info.
AwsRestClientDataProvider::AwsRestClientDataProvider::getStaticInfoImpl
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
AwsRestClientDataProvider::AwsRestClientDataProvider::getDesc
*string getDesc()
Returns the data provider description.
AwsRestClientDataProvider
Qore AwsRestClientDataProvider module definition.
Definition: AwsRestClientCallDataProvider.qc.dox.h:26