AutoScalingRequest Class

(QtAws::AutoScaling::AutoScalingRequest)

The AutoScalingRequest class provides an interface for AutoScaling requests. More...

Header: #include <AutoScalingRequest>
Inherits: QtAws::Core::AwsAbstractRequest
Inherited By:

QtAws::AutoScaling::AttachInstancesRequest, QtAws::AutoScaling::AttachLoadBalancersRequest, QtAws::AutoScaling::AttachLoadBalancerTargetGroupsRequest, QtAws::AutoScaling::CompleteLifecycleActionRequest, QtAws::AutoScaling::CreateAutoScalingGroupRequest, QtAws::AutoScaling::CreateLaunchConfigurationRequest, QtAws::AutoScaling::CreateOrUpdateTagsRequest, QtAws::AutoScaling::DeleteAutoScalingGroupRequest, QtAws::AutoScaling::DeleteLaunchConfigurationRequest, QtAws::AutoScaling::DeleteLifecycleHookRequest, QtAws::AutoScaling::DeleteNotificationConfigurationRequest, QtAws::AutoScaling::DeletePolicyRequest, QtAws::AutoScaling::DeleteScheduledActionRequest, QtAws::AutoScaling::DeleteTagsRequest, QtAws::AutoScaling::DescribeAutoScalingGroupsRequest, QtAws::AutoScaling::DescribeAutoScalingInstancesRequest, QtAws::AutoScaling::DescribeLaunchConfigurationsRequest, QtAws::AutoScaling::DescribeLifecycleHooksRequest, QtAws::AutoScaling::DescribeLoadBalancersRequest, QtAws::AutoScaling::DescribeLoadBalancerTargetGroupsRequest, QtAws::AutoScaling::DescribeNotificationConfigurationsRequest, QtAws::AutoScaling::DescribePoliciesRequest, QtAws::AutoScaling::DescribeScalingActivitiesRequest, QtAws::AutoScaling::DescribeScheduledActionsRequest, QtAws::AutoScaling::DescribeTagsRequest, QtAws::AutoScaling::DetachInstancesRequest, QtAws::AutoScaling::DetachLoadBalancersRequest, QtAws::AutoScaling::DetachLoadBalancerTargetGroupsRequest, QtAws::AutoScaling::DisableMetricsCollectionRequest, QtAws::AutoScaling::EnableMetricsCollectionRequest, QtAws::AutoScaling::EnterStandbyRequest, QtAws::AutoScaling::ExecutePolicyRequest, QtAws::AutoScaling::ExitStandbyRequest, QtAws::AutoScaling::PutLifecycleHookRequest, QtAws::AutoScaling::PutNotificationConfigurationRequest, QtAws::AutoScaling::PutScalingPolicyRequest, QtAws::AutoScaling::PutScheduledUpdateGroupActionRequest, QtAws::AutoScaling::RecordLifecycleActionHeartbeatRequest, QtAws::AutoScaling::ResumeProcessesRequest, QtAws::AutoScaling::SetDesiredCapacityRequest, QtAws::AutoScaling::SetInstanceHealthRequest, QtAws::AutoScaling::SetInstanceProtectionRequest, QtAws::AutoScaling::SuspendProcessesRequest, QtAws::AutoScaling::TerminateInstanceInAutoScalingGroupRequest, and QtAws::AutoScaling::UpdateAutoScalingGroupRequest

Public Types

enum Action { AttachInstancesAction, AttachLoadBalancerTargetGroupsAction, AttachLoadBalancersAction, CompleteLifecycleActionAction, ..., UpdateAutoScalingGroupAction }
flags Actions

Public Functions

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

Protected Functions

AutoScalingRequest(AutoScalingRequestPrivate * 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 AutoScalingRequest class provides an interface for AutoScaling requests.

Member Type Documentation

enum AutoScalingRequest::Action
flags AutoScalingRequest::Actions

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

ConstantValueDescription
QtAws::AutoScaling::AutoScalingRequest::AttachInstancesAction0AutoScaling AttachInstances action.
QtAws::AutoScaling::AutoScalingRequest::AttachLoadBalancerTargetGroupsAction1AutoScaling AttachLoadBalancerTargetGroups action.
QtAws::AutoScaling::AutoScalingRequest::AttachLoadBalancersAction2AutoScaling AttachLoadBalancers action.
QtAws::AutoScaling::AutoScalingRequest::CompleteLifecycleActionAction3AutoScaling CompleteLifecycleAction action.
QtAws::AutoScaling::AutoScalingRequest::CreateAutoScalingGroupAction4AutoScaling CreateAutoScalingGroup action.
QtAws::AutoScaling::AutoScalingRequest::CreateLaunchConfigurationAction5AutoScaling CreateLaunchConfiguration action.
QtAws::AutoScaling::AutoScalingRequest::CreateOrUpdateTagsAction6AutoScaling CreateOrUpdateTags action.
QtAws::AutoScaling::AutoScalingRequest::DeleteAutoScalingGroupAction7AutoScaling DeleteAutoScalingGroup action.
QtAws::AutoScaling::AutoScalingRequest::DeleteLaunchConfigurationAction8AutoScaling DeleteLaunchConfiguration action.
QtAws::AutoScaling::AutoScalingRequest::DeleteLifecycleHookAction9AutoScaling DeleteLifecycleHook action.
QtAws::AutoScaling::AutoScalingRequest::DeleteNotificationConfigurationAction10AutoScaling DeleteNotificationConfiguration action.
QtAws::AutoScaling::AutoScalingRequest::DeletePolicyAction11AutoScaling DeletePolicy action.
QtAws::AutoScaling::AutoScalingRequest::DeleteScheduledActionAction12AutoScaling DeleteScheduledAction action.
QtAws::AutoScaling::AutoScalingRequest::DeleteTagsAction13AutoScaling DeleteTags action.
QtAws::AutoScaling::AutoScalingRequest::DescribeAccountLimitsAction14AutoScaling DescribeAccountLimits action.
QtAws::AutoScaling::AutoScalingRequest::DescribeAdjustmentTypesAction15AutoScaling DescribeAdjustmentTypes action.
QtAws::AutoScaling::AutoScalingRequest::DescribeAutoScalingGroupsAction16AutoScaling DescribeAutoScalingGroups action.
QtAws::AutoScaling::AutoScalingRequest::DescribeAutoScalingInstancesAction17AutoScaling DescribeAutoScalingInstances action.
QtAws::AutoScaling::AutoScalingRequest::DescribeAutoScalingNotificationTypesAction18AutoScaling DescribeAutoScalingNotificationTypes action.
QtAws::AutoScaling::AutoScalingRequest::DescribeLaunchConfigurationsAction19AutoScaling DescribeLaunchConfigurations action.
QtAws::AutoScaling::AutoScalingRequest::DescribeLifecycleHookTypesAction20AutoScaling DescribeLifecycleHookTypes action.
QtAws::AutoScaling::AutoScalingRequest::DescribeLifecycleHooksAction21AutoScaling DescribeLifecycleHooks action.
QtAws::AutoScaling::AutoScalingRequest::DescribeLoadBalancerTargetGroupsAction22AutoScaling DescribeLoadBalancerTargetGroups action.
QtAws::AutoScaling::AutoScalingRequest::DescribeLoadBalancersAction23AutoScaling DescribeLoadBalancers action.
QtAws::AutoScaling::AutoScalingRequest::DescribeMetricCollectionTypesAction24AutoScaling DescribeMetricCollectionTypes action.
QtAws::AutoScaling::AutoScalingRequest::DescribeNotificationConfigurationsAction25AutoScaling DescribeNotificationConfigurations action.
QtAws::AutoScaling::AutoScalingRequest::DescribePoliciesAction26AutoScaling DescribePolicies action.
QtAws::AutoScaling::AutoScalingRequest::DescribeScalingActivitiesAction27AutoScaling DescribeScalingActivities action.
QtAws::AutoScaling::AutoScalingRequest::DescribeScalingProcessTypesAction28AutoScaling DescribeScalingProcessTypes action.
QtAws::AutoScaling::AutoScalingRequest::DescribeScheduledActionsAction29AutoScaling DescribeScheduledActions action.
QtAws::AutoScaling::AutoScalingRequest::DescribeTagsAction30AutoScaling DescribeTags action.
QtAws::AutoScaling::AutoScalingRequest::DescribeTerminationPolicyTypesAction31AutoScaling DescribeTerminationPolicyTypes action.
QtAws::AutoScaling::AutoScalingRequest::DetachInstancesAction32AutoScaling DetachInstances action.
QtAws::AutoScaling::AutoScalingRequest::DetachLoadBalancerTargetGroupsAction33AutoScaling DetachLoadBalancerTargetGroups action.
QtAws::AutoScaling::AutoScalingRequest::DetachLoadBalancersAction34AutoScaling DetachLoadBalancers action.
QtAws::AutoScaling::AutoScalingRequest::DisableMetricsCollectionAction35AutoScaling DisableMetricsCollection action.
QtAws::AutoScaling::AutoScalingRequest::EnableMetricsCollectionAction36AutoScaling EnableMetricsCollection action.
QtAws::AutoScaling::AutoScalingRequest::EnterStandbyAction37AutoScaling EnterStandby action.
QtAws::AutoScaling::AutoScalingRequest::ExecutePolicyAction38AutoScaling ExecutePolicy action.
QtAws::AutoScaling::AutoScalingRequest::ExitStandbyAction39AutoScaling ExitStandby action.
QtAws::AutoScaling::AutoScalingRequest::PutLifecycleHookAction40AutoScaling PutLifecycleHook action.
QtAws::AutoScaling::AutoScalingRequest::PutNotificationConfigurationAction41AutoScaling PutNotificationConfiguration action.
QtAws::AutoScaling::AutoScalingRequest::PutScalingPolicyAction42AutoScaling PutScalingPolicy action.
QtAws::AutoScaling::AutoScalingRequest::PutScheduledUpdateGroupActionAction43AutoScaling PutScheduledUpdateGroupAction action.
QtAws::AutoScaling::AutoScalingRequest::RecordLifecycleActionHeartbeatAction44AutoScaling RecordLifecycleActionHeartbeat action.
QtAws::AutoScaling::AutoScalingRequest::ResumeProcessesAction45AutoScaling ResumeProcesses action.
QtAws::AutoScaling::AutoScalingRequest::SetDesiredCapacityAction46AutoScaling SetDesiredCapacity action.
QtAws::AutoScaling::AutoScalingRequest::SetInstanceHealthAction47AutoScaling SetInstanceHealth action.
QtAws::AutoScaling::AutoScalingRequest::SetInstanceProtectionAction48AutoScaling SetInstanceProtection action.
QtAws::AutoScaling::AutoScalingRequest::SuspendProcessesAction49AutoScaling SuspendProcesses action.
QtAws::AutoScaling::AutoScalingRequest::TerminateInstanceInAutoScalingGroupAction50AutoScaling TerminateInstanceInAutoScalingGroup action.
QtAws::AutoScaling::AutoScalingRequest::UpdateAutoScalingGroupAction51AutoScaling UpdateAutoScalingGroup action.

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

Member Function Documentation

AutoScalingRequest::AutoScalingRequest(const Action action)

Constructs a AutoScalingRequest object for AutoScaling action.

AutoScalingRequest::AutoScalingRequest(const AutoScalingRequest &other)

Constructs a copy of other.

[protected] AutoScalingRequest::AutoScalingRequest(AutoScalingRequestPrivate * const d)

Constructs aa AutoScalingRequest object with private implementation d.

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

Action AutoScalingRequest::action() const

Returns the AutoScaling action to be performed by this request.

See also setAction().

QString AutoScalingRequest::actionString() const

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

QString AutoScalingRequest::apiVersion() const

Returns the AutoScaling API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void AutoScalingRequest::setAction(const Action action)

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

See also action().

void AutoScalingRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the AutoScalingRequest object to be equal to other.

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