CostandUsageReportServiceRequest Class

(QtAws::CostandUsageReportService::CostandUsageReportServiceRequest)

The CostandUsageReportServiceRequest class provides an interface for CostandUsageReportService requests. More...

Public Types

enum Action { DeleteReportDefinitionAction, DescribeReportDefinitionsAction, PutReportDefinitionAction }
flags Actions

Public Functions

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

Protected Functions

CostandUsageReportServiceRequest(CostandUsageReportServiceRequestPrivate * 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 CostandUsageReportServiceRequest class provides an interface for CostandUsageReportService requests.

Member Type Documentation

enum CostandUsageReportServiceRequest::Action
flags CostandUsageReportServiceRequest::Actions

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

ConstantValueDescription
QtAws::CostandUsageReportService::CostandUsageReportServiceRequest::DeleteReportDefinitionAction0CostandUsageReportService DeleteReportDefinition action.
QtAws::CostandUsageReportService::CostandUsageReportServiceRequest::DescribeReportDefinitionsAction1CostandUsageReportService DescribeReportDefinitions action.
QtAws::CostandUsageReportService::CostandUsageReportServiceRequest::PutReportDefinitionAction2CostandUsageReportService PutReportDefinition action.

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

Member Function Documentation

CostandUsageReportServiceRequest::CostandUsageReportServiceRequest(const Action action)

Constructs a CostandUsageReportServiceRequest object for CostandUsageReportService action.

CostandUsageReportServiceRequest::CostandUsageReportServiceRequest(const CostandUsageReportServiceRequest &other)

Constructs a copy of other.

[protected] CostandUsageReportServiceRequest::CostandUsageReportServiceRequest(CostandUsageReportServiceRequestPrivate * const d)

Constructs aa CostandUsageReportServiceRequest object with private implementation d.

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

Action CostandUsageReportServiceRequest::action() const

Returns the CostandUsageReportService action to be performed by this request.

See also setAction().

QString CostandUsageReportServiceRequest::actionString() const

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

QString CostandUsageReportServiceRequest::apiVersion() const

Returns the CostandUsageReportService API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void CostandUsageReportServiceRequest::setAction(const Action action)

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

See also action().

void CostandUsageReportServiceRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the CostandUsageReportServiceRequest object to be equal to other.

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