HealthRequest Class

(QtAws::Health::HealthRequest)

The HealthRequest class provides an interface for Health requests. More...

Header:	#include <HealthRequest>
Inherits:	QtAws::Core::AwsAbstractRequest
Inherited By:	QtAws::Health::DescribeAffectedEntitiesRequest, QtAws::Health::DescribeEntityAggregatesRequest, QtAws::Health::DescribeEventAggregatesRequest, QtAws::Health::DescribeEventDetailsRequest, QtAws::Health::DescribeEventsRequest, and QtAws::Health::DescribeEventTypesRequest

List of all members, including inherited members

Public Types

enum	Action { DescribeAffectedEntitiesAction, DescribeEntityAggregatesAction, DescribeEventAggregatesAction, DescribeEventDetailsAction, DescribeEventTypesAction, DescribeEventsAction }
flags	Actions

Public Functions

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

7 public functions inherited from QtAws::Core::AwsAbstractRequest

Protected Functions

	HealthRequest(HealthRequestPrivate * 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

4 protected functions inherited from QtAws::Core::AwsAbstractRequest

Detailed Description

The HealthRequest class provides an interface for Health requests.

Member Type Documentation

enum HealthRequest::Action
flags HealthRequest::Actions

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

Constant	Value	Description
`QtAws::Health::HealthRequest::DescribeAffectedEntitiesAction`	`0`	Health DescribeAffectedEntities action.
`QtAws::Health::HealthRequest::DescribeEntityAggregatesAction`	`1`	Health DescribeEntityAggregates action.
`QtAws::Health::HealthRequest::DescribeEventAggregatesAction`	`2`	Health DescribeEventAggregates action.
`QtAws::Health::HealthRequest::DescribeEventDetailsAction`	`3`	Health DescribeEventDetails action.
`QtAws::Health::HealthRequest::DescribeEventTypesAction`	`4`	Health DescribeEventTypes action.
`QtAws::Health::HealthRequest::DescribeEventsAction`	`5`	Health DescribeEvents action.

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

Member Function Documentation

HealthRequest::HealthRequest(const Action action)

Constructs a HealthRequest object for Health action.

HealthRequest::HealthRequest(const HealthRequest &other)

Constructs a copy of other.

`[protected]` HealthRequest::HealthRequest(HealthRequestPrivate * const d)

Constructs aa HealthRequest object with private implementation d.

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

Action HealthRequest::action() const

Returns the Health action to be performed by this request.

See also setAction().

QString HealthRequest::actionString() const

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

QString HealthRequest::apiVersion() const

Returns the Health API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void HealthRequest::setAction(const Action action)

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

See also action().

void HealthRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the HealthRequest object to be equal to other.

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

Contents