MarketplaceCommerceAnalyticsRequest Class
(QtAws::MarketplaceCommerceAnalytics::MarketplaceCommerceAnalyticsRequest)The MarketplaceCommerceAnalyticsRequest class provides an interface for MarketplaceCommerceAnalytics requests. More...
| Header: | #include <MarketplaceCommerceAnalyticsRequest> |
| Inherits: | QtAws::Core::AwsAbstractRequest |
| Inherited By: | QtAws::MarketplaceCommerceAnalytics::GenerateDataSetRequest and QtAws::MarketplaceCommerceAnalytics::StartSupportDataExportRequest |
Public Types
Public Functions
| MarketplaceCommerceAnalyticsRequest(const Action action) | |
| MarketplaceCommerceAnalyticsRequest(const MarketplaceCommerceAnalyticsRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| MarketplaceCommerceAnalyticsRequest & | operator=(const MarketplaceCommerceAnalyticsRequest &other) |
| virtual bool | operator==(const MarketplaceCommerceAnalyticsRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| MarketplaceCommerceAnalyticsRequest(MarketplaceCommerceAnalyticsRequestPrivate * 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 MarketplaceCommerceAnalyticsRequest class provides an interface for MarketplaceCommerceAnalytics requests.
Member Type Documentation
enum MarketplaceCommerceAnalyticsRequest::Action
flags MarketplaceCommerceAnalyticsRequest::Actions
This enum describes the actions that can be performed as MarketplaceCommerceAnalytics requests.
| Constant | Value | Description |
|---|---|---|
QtAws::MarketplaceCommerceAnalytics::MarketplaceCommerceAnalyticsRequest::GenerateDataSetAction | 0 | MarketplaceCommerceAnalytics GenerateDataSet action. |
QtAws::MarketplaceCommerceAnalytics::MarketplaceCommerceAnalyticsRequest::StartSupportDataExportAction | 1 | MarketplaceCommerceAnalytics StartSupportDataExport action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
MarketplaceCommerceAnalyticsRequest::MarketplaceCommerceAnalyticsRequest(const Action action)
Constructs a MarketplaceCommerceAnalyticsRequest object for MarketplaceCommerceAnalytics action.
MarketplaceCommerceAnalyticsRequest::MarketplaceCommerceAnalyticsRequest(const MarketplaceCommerceAnalyticsRequest &other)
Constructs a copy of other.
[protected] MarketplaceCommerceAnalyticsRequest::MarketplaceCommerceAnalyticsRequest(MarketplaceCommerceAnalyticsRequestPrivate * const d)
Constructs aa MarketplaceCommerceAnalyticsRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from MarketplaceCommerceAnalyticsRequestPrivate.
Action MarketplaceCommerceAnalyticsRequest::action() const
Returns the MarketplaceCommerceAnalytics action to be performed by this request.
See also setAction().
QString MarketplaceCommerceAnalyticsRequest::actionString() const
Returns the name of the MarketplaceCommerceAnalytics action to be performed by this request.
QString MarketplaceCommerceAnalyticsRequest::apiVersion() const
Returns the MarketplaceCommerceAnalytics API version implemented by this request.
See also setApiVersion().
[protected] int MarketplaceCommerceAnalyticsRequest::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 MarketplaceCommerceAnalyticsRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant MarketplaceCommerceAnalyticsRequest::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 &MarketplaceCommerceAnalyticsRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void MarketplaceCommerceAnalyticsRequest::setAction(const Action action)
Sets the MarketplaceCommerceAnalytics action to be performed by this request to action.
See also action().
void MarketplaceCommerceAnalyticsRequest::setApiVersion(const QString &version)
Sets the MarketplaceCommerceAnalytics API version to include in this request to version.
See also apiVersion().
[protected] void MarketplaceCommerceAnalyticsRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void MarketplaceCommerceAnalyticsRequest::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 MarketplaceCommerceAnalyticsRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the MarketplaceCommerceAnalytics request using the given endpoint.
This MarketplaceCommerceAnalytics 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.
MarketplaceCommerceAnalyticsRequest &MarketplaceCommerceAnalyticsRequest::operator=(const MarketplaceCommerceAnalyticsRequest &other)
Sets the MarketplaceCommerceAnalyticsRequest object to be equal to other.
[virtual] bool MarketplaceCommerceAnalyticsRequest::operator==(const MarketplaceCommerceAnalyticsRequest &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.