MarketplaceMeteringRequest Class
(QtAws::MarketplaceMetering::MarketplaceMeteringRequest)The MarketplaceMeteringRequest class provides an interface for MarketplaceMetering requests. More...
| Header: | #include <MarketplaceMeteringRequest> |
| Inherits: | QtAws::Core::AwsAbstractRequest |
| Inherited By: | QtAws::MarketplaceMetering::BatchMeterUsageRequest, QtAws::MarketplaceMetering::MeterUsageRequest, and QtAws::MarketplaceMetering::ResolveCustomerRequest |
Public Types
Public Functions
| MarketplaceMeteringRequest(const Action action) | |
| MarketplaceMeteringRequest(const MarketplaceMeteringRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| MarketplaceMeteringRequest & | operator=(const MarketplaceMeteringRequest &other) |
| virtual bool | operator==(const MarketplaceMeteringRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| MarketplaceMeteringRequest(MarketplaceMeteringRequestPrivate * const d) | |
| int | clearParameter(const QString &name) |
| void | clearParameters() |
| QVariant | parameter(const QString &name, const QVariant &defaultValue = QVariant()) const |
| const QVariantMap & | parameters() const |
| void | setParameter(const QString &name, const QVariant &value) |
| void | setParameters(const QVariantMap ¶meters) |
Reimplemented Protected Functions
| virtual QNetworkRequest | unsignedRequest(const QUrl &endpoint) const override |
- 4 protected functions inherited from QtAws::Core::AwsAbstractRequest
Detailed Description
The MarketplaceMeteringRequest class provides an interface for MarketplaceMetering requests.
Member Type Documentation
enum MarketplaceMeteringRequest::Action
flags MarketplaceMeteringRequest::Actions
This enum describes the actions that can be performed as MarketplaceMetering requests.
| Constant | Value | Description |
|---|---|---|
QtAws::MarketplaceMetering::MarketplaceMeteringRequest::BatchMeterUsageAction | 0 | MarketplaceMetering BatchMeterUsage action. |
QtAws::MarketplaceMetering::MarketplaceMeteringRequest::MeterUsageAction | 1 | MarketplaceMetering MeterUsage action. |
QtAws::MarketplaceMetering::MarketplaceMeteringRequest::ResolveCustomerAction | 2 | MarketplaceMetering ResolveCustomer action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
MarketplaceMeteringRequest::MarketplaceMeteringRequest(const Action action)
Constructs a MarketplaceMeteringRequest object for MarketplaceMetering action.
MarketplaceMeteringRequest::MarketplaceMeteringRequest(const MarketplaceMeteringRequest &other)
Constructs a copy of other.
[protected] MarketplaceMeteringRequest::MarketplaceMeteringRequest(MarketplaceMeteringRequestPrivate * const d)
Constructs aa MarketplaceMeteringRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from MarketplaceMeteringRequestPrivate.
Action MarketplaceMeteringRequest::action() const
Returns the MarketplaceMetering action to be performed by this request.
See also setAction().
QString MarketplaceMeteringRequest::actionString() const
Returns the name of the MarketplaceMetering action to be performed by this request.
QString MarketplaceMeteringRequest::apiVersion() const
Returns the MarketplaceMetering API version implemented by this request.
See also setApiVersion().
[protected] int MarketplaceMeteringRequest::clearParameter(const QString &name)
Removes the a name parameter from the request, then returns the number of paramters removed (typically 0 or 1).
[protected] void MarketplaceMeteringRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant MarketplaceMeteringRequest::parameter(const QString &name, const QVariant &defaultValue = QVariant()) const
Returns the value of the name pararemter if set; defaultValue otherwise.
See also setParameter().
[protected] const QVariantMap &MarketplaceMeteringRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void MarketplaceMeteringRequest::setAction(const Action action)
Sets the MarketplaceMetering action to be performed by this request to action.
See also action().
void MarketplaceMeteringRequest::setApiVersion(const QString &version)
Sets the MarketplaceMetering API version to include in this request to version.
See also apiVersion().
[protected] void MarketplaceMeteringRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void MarketplaceMeteringRequest::setParameters(const QVariantMap ¶meters)
Sets the paramters for this request to parameters. Any request parameters set previously will be discarded.
See also parameters().
[override virtual protected] QNetworkRequest MarketplaceMeteringRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the MarketplaceMetering request using the given endpoint.
This MarketplaceMetering implementation builds request URLs by combining the common query parameters (such as Action and Version), with any that have been added (via setParameter) by child classes.
MarketplaceMeteringRequest &MarketplaceMeteringRequest::operator=(const MarketplaceMeteringRequest &other)
Sets the MarketplaceMeteringRequest object to be equal to other.
[virtual] bool MarketplaceMeteringRequest::operator==(const MarketplaceMeteringRequest &other) const
Returns true if this request is equal to other; false otherwise.
Note, most derived *Request classes do not need to provider their own implementations of this function, since most such request classes rely on this class' parameters functionality for all request parameters, and that parameters map is already checked via this implementation.
© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.