CloudWatchEventsRequest Class

(QtAws::CloudWatchEvents::CloudWatchEventsRequest)

The CloudWatchEventsRequest class provides an interface for CloudWatchEvents requests. More...

Public Types

enum Action { DeleteRuleAction, DescribeEventBusAction, DescribeRuleAction, DisableRuleAction, ..., TestEventPatternAction }
flags Actions

Public Functions

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

Protected Functions

CloudWatchEventsRequest(CloudWatchEventsRequestPrivate * 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 CloudWatchEventsRequest class provides an interface for CloudWatchEvents requests.

Member Type Documentation

enum CloudWatchEventsRequest::Action
flags CloudWatchEventsRequest::Actions

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

ConstantValueDescription
QtAws::CloudWatchEvents::CloudWatchEventsRequest::DeleteRuleAction0CloudWatchEvents DeleteRule action.
QtAws::CloudWatchEvents::CloudWatchEventsRequest::DescribeEventBusAction1CloudWatchEvents DescribeEventBus action.
QtAws::CloudWatchEvents::CloudWatchEventsRequest::DescribeRuleAction2CloudWatchEvents DescribeRule action.
QtAws::CloudWatchEvents::CloudWatchEventsRequest::DisableRuleAction3CloudWatchEvents DisableRule action.
QtAws::CloudWatchEvents::CloudWatchEventsRequest::EnableRuleAction4CloudWatchEvents EnableRule action.
QtAws::CloudWatchEvents::CloudWatchEventsRequest::ListRuleNamesByTargetAction5CloudWatchEvents ListRuleNamesByTarget action.
QtAws::CloudWatchEvents::CloudWatchEventsRequest::ListRulesAction6CloudWatchEvents ListRules action.
QtAws::CloudWatchEvents::CloudWatchEventsRequest::ListTargetsByRuleAction7CloudWatchEvents ListTargetsByRule action.
QtAws::CloudWatchEvents::CloudWatchEventsRequest::PutEventsAction8CloudWatchEvents PutEvents action.
QtAws::CloudWatchEvents::CloudWatchEventsRequest::PutPermissionAction9CloudWatchEvents PutPermission action.
QtAws::CloudWatchEvents::CloudWatchEventsRequest::PutRuleAction10CloudWatchEvents PutRule action.
QtAws::CloudWatchEvents::CloudWatchEventsRequest::PutTargetsAction11CloudWatchEvents PutTargets action.
QtAws::CloudWatchEvents::CloudWatchEventsRequest::RemovePermissionAction12CloudWatchEvents RemovePermission action.
QtAws::CloudWatchEvents::CloudWatchEventsRequest::RemoveTargetsAction13CloudWatchEvents RemoveTargets action.
QtAws::CloudWatchEvents::CloudWatchEventsRequest::TestEventPatternAction14CloudWatchEvents TestEventPattern action.

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

Member Function Documentation

CloudWatchEventsRequest::CloudWatchEventsRequest(const Action action)

Constructs a CloudWatchEventsRequest object for CloudWatchEvents action.

CloudWatchEventsRequest::CloudWatchEventsRequest(const CloudWatchEventsRequest &other)

Constructs a copy of other.

[protected] CloudWatchEventsRequest::CloudWatchEventsRequest(CloudWatchEventsRequestPrivate * const d)

Constructs aa CloudWatchEventsRequest object with private implementation d.

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

Action CloudWatchEventsRequest::action() const

Returns the CloudWatchEvents action to be performed by this request.

See also setAction().

QString CloudWatchEventsRequest::actionString() const

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

QString CloudWatchEventsRequest::apiVersion() const

Returns the CloudWatchEvents API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void CloudWatchEventsRequest::setAction(const Action action)

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

See also action().

void CloudWatchEventsRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the CloudWatchEventsRequest object to be equal to other.

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