BudgetsRequest Class

(QtAws::Budgets::BudgetsRequest)

The BudgetsRequest class provides an interface for Budgets requests. More...

Public Types

enum Action { CreateBudgetAction, CreateNotificationAction, CreateSubscriberAction, DeleteBudgetAction, ..., UpdateSubscriberAction }
flags Actions

Public Functions

BudgetsRequest(const Action action)
BudgetsRequest(const BudgetsRequest &other)
Action action() const
QString actionString() const
QString apiVersion() const
void setAction(const Action action)
void setApiVersion(const QString &version)
BudgetsRequest &operator=(const BudgetsRequest &other)
virtual bool operator==(const BudgetsRequest &other) const

Protected Functions

BudgetsRequest(BudgetsRequestPrivate * 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 &parameters)

Reimplemented Protected Functions

virtual QNetworkRequest unsignedRequest(const QUrl &endpoint) const override

Detailed Description

The BudgetsRequest class provides an interface for Budgets requests.

Member Type Documentation

enum BudgetsRequest::Action
flags BudgetsRequest::Actions

This enum describes the actions that can be performed as Budgets requests.

ConstantValueDescription
QtAws::Budgets::BudgetsRequest::CreateBudgetAction0Budgets CreateBudget action.
QtAws::Budgets::BudgetsRequest::CreateNotificationAction1Budgets CreateNotification action.
QtAws::Budgets::BudgetsRequest::CreateSubscriberAction2Budgets CreateSubscriber action.
QtAws::Budgets::BudgetsRequest::DeleteBudgetAction3Budgets DeleteBudget action.
QtAws::Budgets::BudgetsRequest::DeleteNotificationAction4Budgets DeleteNotification action.
QtAws::Budgets::BudgetsRequest::DeleteSubscriberAction5Budgets DeleteSubscriber action.
QtAws::Budgets::BudgetsRequest::DescribeBudgetAction6Budgets DescribeBudget action.
QtAws::Budgets::BudgetsRequest::DescribeBudgetsAction7Budgets DescribeBudgets action.
QtAws::Budgets::BudgetsRequest::DescribeNotificationsForBudgetAction8Budgets DescribeNotificationsForBudget action.
QtAws::Budgets::BudgetsRequest::DescribeSubscribersForNotificationAction9Budgets DescribeSubscribersForNotification action.
QtAws::Budgets::BudgetsRequest::UpdateBudgetAction10Budgets UpdateBudget action.
QtAws::Budgets::BudgetsRequest::UpdateNotificationAction11Budgets UpdateNotification action.
QtAws::Budgets::BudgetsRequest::UpdateSubscriberAction12Budgets UpdateSubscriber action.

The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.

Member Function Documentation

BudgetsRequest::BudgetsRequest(const Action action)

Constructs a BudgetsRequest object for Budgets action.

BudgetsRequest::BudgetsRequest(const BudgetsRequest &other)

Constructs a copy of other.

[protected] BudgetsRequest::BudgetsRequest(BudgetsRequestPrivate * const d)

Constructs aa BudgetsRequest object with private implementation d.

This overload allows derived classes to provide their own private class implementation that inherits from BudgetsRequestPrivate.

Action BudgetsRequest::action() const

Returns the Budgets action to be performed by this request.

See also setAction().

QString BudgetsRequest::actionString() const

Returns the name of the Budgets action to be performed by this request.

QString BudgetsRequest::apiVersion() const

Returns the Budgets API version implemented by this request.

See also setApiVersion().

[protected] int BudgetsRequest::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 BudgetsRequest::clearParameters()

Removes all parameters from the request.

[protected] QVariant BudgetsRequest::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 &BudgetsRequest::parameters() const

Returns the parameters included in this request.

See also setParameters().

void BudgetsRequest::setAction(const Action action)

Sets the Budgets action to be performed by this request to action.

See also action().

void BudgetsRequest::setApiVersion(const QString &version)

Sets the Budgets API version to include in this request to version.

See also apiVersion().

[protected] void BudgetsRequest::setParameter(const QString &name, const QVariant &value)

Sets the name parameter to value.

See also parameter().

[protected] void BudgetsRequest::setParameters(const QVariantMap &parameters)

Sets the paramters for this request to parameters. Any request parameters set previously will be discarded.

See also parameters().

[override virtual protected] QNetworkRequest BudgetsRequest::unsignedRequest(const QUrl &endpoint) const

Reimplemented from AwsAbstractRequest::unsignedRequest().

Returns a network request for the Budgets request using the given endpoint.

This Budgets 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.

BudgetsRequest &BudgetsRequest::operator=(const BudgetsRequest &other)

Sets the BudgetsRequest object to be equal to other.

[virtual] bool BudgetsRequest::operator==(const BudgetsRequest &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.