#include <parameter_reader.h>
Definition at line 117 of file parameter_reader.h.
| virtual Aws::Client::ParameterReaderInterface::~ParameterReaderInterface |
( |
| ) |
|
|
virtualdefault |
| virtual AwsError Aws::Client::ParameterReaderInterface::ReadParam |
( |
const ParameterPath & |
param_path, |
|
|
std::vector< std::string > & |
out |
|
) |
| const |
|
pure virtual |
read a list from the provided parameter name
- Parameters
-
| name | the name of the parameter to be read |
| out | the output of 'double' type. |
- Returns
- AWS_ERR_OK if read was successful, AWS_ERR_NOT_FOUND if the parameter was not found
- Note
- if the return code is not AWS_ERR_OK, out remains unchanged.
| virtual AwsError Aws::Client::ParameterReaderInterface::ReadParam |
( |
const ParameterPath & |
param_path, |
|
|
double & |
out |
|
) |
| const |
|
pure virtual |
read a double value from the provided parameter name
- Parameters
-
| param_path | an object representing the path of the parameter to be read |
| out | the output of 'double' type |
- Returns
- AWS_ERR_OK if read was successful, AWS_ERR_NOT_FOUND if the parameter was not found
- Note
- if the return code is not AWS_ERR_OK, out remains unchanged.
| virtual AwsError Aws::Client::ParameterReaderInterface::ReadParam |
( |
const ParameterPath & |
param_path, |
|
|
int & |
out |
|
) |
| const |
|
pure virtual |
read an integer value from the provided parameter name
- Parameters
-
| param_path | an object representing the path of the parameter to be read |
| out | the output of 'int' type |
- Returns
- AWS_ERR_OK if read was successful, AWS_ERR_NOT_FOUND if the parameter was not found
- Note
- if the return code is not AWS_ERR_OK, out remains unchanged.
| virtual AwsError Aws::Client::ParameterReaderInterface::ReadParam |
( |
const ParameterPath & |
param_path, |
|
|
bool & |
out |
|
) |
| const |
|
pure virtual |
read a boolean value from the provided parameter name
- Parameters
-
| param_path | an object representing the path of the parameter to be read |
| out | the output of 'bool' type |
- Returns
- AWS_ERR_OK if read was successful, AWS_ERR_NOT_FOUND if the parameter was not found
- Note
- if the return code is not AWS_ERR_OK, out remains unchanged.
| virtual AwsError Aws::Client::ParameterReaderInterface::ReadParam |
( |
const ParameterPath & |
param_path, |
|
|
Aws::String & |
out |
|
) |
| const |
|
pure virtual |
read a string value from the provided parameter name
- Parameters
-
| param_path | an object representing the path of the parameter to be read |
| out | the output of 'Aws::String' type |
- Returns
- AWS_ERR_OK if read was successful, AWS_ERR_NOT_FOUND if the parameter was not found
- Note
- if the return code is not AWS_ERR_OK, out remains unchanged.
| virtual AwsError Aws::Client::ParameterReaderInterface::ReadParam |
( |
const ParameterPath & |
param_path, |
|
|
std::string & |
out |
|
) |
| const |
|
pure virtual |
read a string from the provided parameter name
- Parameters
-
| param_path | an object representing the path of the parameter to be read |
| out | the output of 'std::string' type |
- Returns
- AWS_ERR_OK if read was successful, AWS_ERR_NOT_FOUND if the parameter was not found
- Note
- if the return code is not AWS_ERR_OK, out remains unchanged.
| virtual AwsError Aws::Client::ParameterReaderInterface::ReadParam |
( |
const ParameterPath & |
param_path, |
|
|
std::map< std::string, std::string > & |
out |
|
) |
| const |
|
pure virtual |
read a map from the provided parameter name
- Parameters
-
| param_path | an object representing the path of the parameter to be read |
| out | the output of 'std::map' type |
- Returns
- AWS_ERR_OK if read was successful, AWS_ERR_NOT_FOUND if the parameter was not found
- Note
- if the return code is not AWS_ERR_OK, out remains unchanged.
The documentation for this class was generated from the following file:
