AutoScalingPlansRequest Class

(QtAws::AutoScalingPlans::AutoScalingPlansRequest)

The AutoScalingPlansRequest class provides an interface for AutoScalingPlans requests. More...

Public Types

enum Action { CreateScalingPlanAction, DeleteScalingPlanAction, DescribeScalingPlanResourcesAction, DescribeScalingPlansAction, UpdateScalingPlanAction }
flags Actions

Public Functions

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

Protected Functions

AutoScalingPlansRequest(AutoScalingPlansRequestPrivate * 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 AutoScalingPlansRequest class provides an interface for AutoScalingPlans requests.

Member Type Documentation

enum AutoScalingPlansRequest::Action
flags AutoScalingPlansRequest::Actions

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

ConstantValueDescription
QtAws::AutoScalingPlans::AutoScalingPlansRequest::CreateScalingPlanAction0AutoScalingPlans CreateScalingPlan action.
QtAws::AutoScalingPlans::AutoScalingPlansRequest::DeleteScalingPlanAction1AutoScalingPlans DeleteScalingPlan action.
QtAws::AutoScalingPlans::AutoScalingPlansRequest::DescribeScalingPlanResourcesAction2AutoScalingPlans DescribeScalingPlanResources action.
QtAws::AutoScalingPlans::AutoScalingPlansRequest::DescribeScalingPlansAction3AutoScalingPlans DescribeScalingPlans action.
QtAws::AutoScalingPlans::AutoScalingPlansRequest::UpdateScalingPlanAction4AutoScalingPlans UpdateScalingPlan action.

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

Member Function Documentation

AutoScalingPlansRequest::AutoScalingPlansRequest(const Action action)

Constructs a AutoScalingPlansRequest object for AutoScalingPlans action.

AutoScalingPlansRequest::AutoScalingPlansRequest(const AutoScalingPlansRequest &other)

Constructs a copy of other.

[protected] AutoScalingPlansRequest::AutoScalingPlansRequest(AutoScalingPlansRequestPrivate * const d)

Constructs aa AutoScalingPlansRequest object with private implementation d.

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

Action AutoScalingPlansRequest::action() const

Returns the AutoScalingPlans action to be performed by this request.

See also setAction().

QString AutoScalingPlansRequest::actionString() const

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

QString AutoScalingPlansRequest::apiVersion() const

Returns the AutoScalingPlans API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void AutoScalingPlansRequest::setAction(const Action action)

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

See also action().

void AutoScalingPlansRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

[protected] void AutoScalingPlansRequest::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 AutoScalingPlansRequest::unsignedRequest(const QUrl &endpoint) const

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the AutoScalingPlansRequest object to be equal to other.

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