Route53DomainsRequest Class
(QtAws::Route53Domains::Route53DomainsRequest)The Route53DomainsRequest class provides an interface for Route53Domains requests. More...
Public Types
| enum | Action { CheckDomainAvailabilityAction, CheckDomainTransferabilityAction, DeleteTagsForDomainAction, DisableDomainAutoRenewAction, ..., ViewBillingAction } |
| flags | Actions |
Public Functions
| Route53DomainsRequest(const Action action) | |
| Route53DomainsRequest(const Route53DomainsRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| Route53DomainsRequest & | operator=(const Route53DomainsRequest &other) |
| virtual bool | operator==(const Route53DomainsRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| Route53DomainsRequest(Route53DomainsRequestPrivate * 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 Route53DomainsRequest class provides an interface for Route53Domains requests.
Member Type Documentation
enum Route53DomainsRequest::Action
flags Route53DomainsRequest::Actions
This enum describes the actions that can be performed as Route53Domains requests.
| Constant | Value | Description |
|---|---|---|
QtAws::Route53Domains::Route53DomainsRequest::CheckDomainAvailabilityAction | 0 | Route53Domains CheckDomainAvailability action. |
QtAws::Route53Domains::Route53DomainsRequest::CheckDomainTransferabilityAction | 1 | Route53Domains CheckDomainTransferability action. |
QtAws::Route53Domains::Route53DomainsRequest::DeleteTagsForDomainAction | 2 | Route53Domains DeleteTagsForDomain action. |
QtAws::Route53Domains::Route53DomainsRequest::DisableDomainAutoRenewAction | 3 | Route53Domains DisableDomainAutoRenew action. |
QtAws::Route53Domains::Route53DomainsRequest::DisableDomainTransferLockAction | 4 | Route53Domains DisableDomainTransferLock action. |
QtAws::Route53Domains::Route53DomainsRequest::EnableDomainAutoRenewAction | 5 | Route53Domains EnableDomainAutoRenew action. |
QtAws::Route53Domains::Route53DomainsRequest::EnableDomainTransferLockAction | 6 | Route53Domains EnableDomainTransferLock action. |
QtAws::Route53Domains::Route53DomainsRequest::GetContactReachabilityStatusAction | 7 | Route53Domains GetContactReachabilityStatus action. |
QtAws::Route53Domains::Route53DomainsRequest::GetDomainDetailAction | 8 | Route53Domains GetDomainDetail action. |
QtAws::Route53Domains::Route53DomainsRequest::GetDomainSuggestionsAction | 9 | Route53Domains GetDomainSuggestions action. |
QtAws::Route53Domains::Route53DomainsRequest::GetOperationDetailAction | 10 | Route53Domains GetOperationDetail action. |
QtAws::Route53Domains::Route53DomainsRequest::ListDomainsAction | 11 | Route53Domains ListDomains action. |
QtAws::Route53Domains::Route53DomainsRequest::ListOperationsAction | 12 | Route53Domains ListOperations action. |
QtAws::Route53Domains::Route53DomainsRequest::ListTagsForDomainAction | 13 | Route53Domains ListTagsForDomain action. |
QtAws::Route53Domains::Route53DomainsRequest::RegisterDomainAction | 14 | Route53Domains RegisterDomain action. |
QtAws::Route53Domains::Route53DomainsRequest::RenewDomainAction | 15 | Route53Domains RenewDomain action. |
QtAws::Route53Domains::Route53DomainsRequest::ResendContactReachabilityEmailAction | 16 | Route53Domains ResendContactReachabilityEmail action. |
QtAws::Route53Domains::Route53DomainsRequest::RetrieveDomainAuthCodeAction | 17 | Route53Domains RetrieveDomainAuthCode action. |
QtAws::Route53Domains::Route53DomainsRequest::TransferDomainAction | 18 | Route53Domains TransferDomain action. |
QtAws::Route53Domains::Route53DomainsRequest::UpdateDomainContactAction | 19 | Route53Domains UpdateDomainContact action. |
QtAws::Route53Domains::Route53DomainsRequest::UpdateDomainContactPrivacyAction | 20 | Route53Domains UpdateDomainContactPrivacy action. |
QtAws::Route53Domains::Route53DomainsRequest::UpdateDomainNameserversAction | 21 | Route53Domains UpdateDomainNameservers action. |
QtAws::Route53Domains::Route53DomainsRequest::UpdateTagsForDomainAction | 22 | Route53Domains UpdateTagsForDomain action. |
QtAws::Route53Domains::Route53DomainsRequest::ViewBillingAction | 23 | Route53Domains ViewBilling action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
Route53DomainsRequest::Route53DomainsRequest(const Action action)
Constructs a Route53DomainsRequest object for Route53Domains action.
Route53DomainsRequest::Route53DomainsRequest(const Route53DomainsRequest &other)
Constructs a copy of other.
[protected] Route53DomainsRequest::Route53DomainsRequest(Route53DomainsRequestPrivate * const d)
Constructs aa Route53DomainsRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from Route53DomainsRequestPrivate.
Action Route53DomainsRequest::action() const
Returns the Route53Domains action to be performed by this request.
See also setAction().
QString Route53DomainsRequest::actionString() const
Returns the name of the Route53Domains action to be performed by this request.
QString Route53DomainsRequest::apiVersion() const
Returns the Route53Domains API version implemented by this request.
See also setApiVersion().
[protected] int Route53DomainsRequest::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 Route53DomainsRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant Route53DomainsRequest::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 &Route53DomainsRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void Route53DomainsRequest::setAction(const Action action)
Sets the Route53Domains action to be performed by this request to action.
See also action().
void Route53DomainsRequest::setApiVersion(const QString &version)
Sets the Route53Domains API version to include in this request to version.
See also apiVersion().
[protected] void Route53DomainsRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void Route53DomainsRequest::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 Route53DomainsRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the Route53Domains request using the given endpoint.
This Route53Domains 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.
Route53DomainsRequest &Route53DomainsRequest::operator=(const Route53DomainsRequest &other)
Sets the Route53DomainsRequest object to be equal to other.
[virtual] bool Route53DomainsRequest::operator==(const Route53DomainsRequest &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.