CloudWatchRequest Class

(QtAws::CloudWatch::CloudWatchRequest)

The CloudWatchRequest class provides an interface for CloudWatch requests. More...

Public Types

enum Action { DeleteAlarmsAction, DeleteDashboardsAction, DescribeAlarmHistoryAction, DescribeAlarmsAction, ..., SetAlarmStateAction }
flags Actions

Public Functions

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

Protected Functions

CloudWatchRequest(CloudWatchRequestPrivate * 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 CloudWatchRequest class provides an interface for CloudWatch requests.

Member Type Documentation

enum CloudWatchRequest::Action
flags CloudWatchRequest::Actions

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

ConstantValueDescription
QtAws::CloudWatch::CloudWatchRequest::DeleteAlarmsAction0CloudWatch DeleteAlarms action.
QtAws::CloudWatch::CloudWatchRequest::DeleteDashboardsAction1CloudWatch DeleteDashboards action.
QtAws::CloudWatch::CloudWatchRequest::DescribeAlarmHistoryAction2CloudWatch DescribeAlarmHistory action.
QtAws::CloudWatch::CloudWatchRequest::DescribeAlarmsAction3CloudWatch DescribeAlarms action.
QtAws::CloudWatch::CloudWatchRequest::DescribeAlarmsForMetricAction4CloudWatch DescribeAlarmsForMetric action.
QtAws::CloudWatch::CloudWatchRequest::DisableAlarmActionsAction5CloudWatch DisableAlarmActions action.
QtAws::CloudWatch::CloudWatchRequest::EnableAlarmActionsAction6CloudWatch EnableAlarmActions action.
QtAws::CloudWatch::CloudWatchRequest::GetDashboardAction7CloudWatch GetDashboard action.
QtAws::CloudWatch::CloudWatchRequest::GetMetricDataAction8CloudWatch GetMetricData action.
QtAws::CloudWatch::CloudWatchRequest::GetMetricStatisticsAction9CloudWatch GetMetricStatistics action.
QtAws::CloudWatch::CloudWatchRequest::ListDashboardsAction10CloudWatch ListDashboards action.
QtAws::CloudWatch::CloudWatchRequest::ListMetricsAction11CloudWatch ListMetrics action.
QtAws::CloudWatch::CloudWatchRequest::PutDashboardAction12CloudWatch PutDashboard action.
QtAws::CloudWatch::CloudWatchRequest::PutMetricAlarmAction13CloudWatch PutMetricAlarm action.
QtAws::CloudWatch::CloudWatchRequest::PutMetricDataAction14CloudWatch PutMetricData action.
QtAws::CloudWatch::CloudWatchRequest::SetAlarmStateAction15CloudWatch SetAlarmState action.

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

Member Function Documentation

CloudWatchRequest::CloudWatchRequest(const Action action)

Constructs a CloudWatchRequest object for CloudWatch action.

CloudWatchRequest::CloudWatchRequest(const CloudWatchRequest &other)

Constructs a copy of other.

[protected] CloudWatchRequest::CloudWatchRequest(CloudWatchRequestPrivate * const d)

Constructs aa CloudWatchRequest object with private implementation d.

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

Action CloudWatchRequest::action() const

Returns the CloudWatch action to be performed by this request.

See also setAction().

QString CloudWatchRequest::actionString() const

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

QString CloudWatchRequest::apiVersion() const

Returns the CloudWatch API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void CloudWatchRequest::setAction(const Action action)

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

See also action().

void CloudWatchRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the CloudWatchRequest object to be equal to other.

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