Cloud9Request Class

(QtAws::Cloud9::Cloud9Request)

The Cloud9Request class provides an interface for Cloud9 requests. More...

Header:	#include <Cloud9Request>
Inherits:	QtAws::Core::AwsAbstractRequest
Inherited By:	QtAws::Cloud9::CreateEnvironmentEC2Request, QtAws::Cloud9::CreateEnvironmentMembershipRequest, QtAws::Cloud9::DeleteEnvironmentMembershipRequest, QtAws::Cloud9::DeleteEnvironmentRequest, QtAws::Cloud9::DescribeEnvironmentMembershipsRequest, QtAws::Cloud9::DescribeEnvironmentsRequest, QtAws::Cloud9::DescribeEnvironmentStatusRequest, QtAws::Cloud9::ListEnvironmentsRequest, QtAws::Cloud9::UpdateEnvironmentMembershipRequest, and QtAws::Cloud9::UpdateEnvironmentRequest

List of all members, including inherited members

Public Types

enum	Action { CreateEnvironmentEC2Action, CreateEnvironmentMembershipAction, DeleteEnvironmentAction, DeleteEnvironmentMembershipAction, ..., UpdateEnvironmentMembershipAction }
flags	Actions

Public Functions

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

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

Protected Functions

	Cloud9Request(Cloud9RequestPrivate * 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 Cloud9Request class provides an interface for Cloud9 requests.

Member Type Documentation

enum Cloud9Request::Action
flags Cloud9Request::Actions

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

Constant	Value	Description
`QtAws::Cloud9::Cloud9Request::CreateEnvironmentEC2Action`	`0`	Cloud9 CreateEnvironmentEC2 action.
`QtAws::Cloud9::Cloud9Request::CreateEnvironmentMembershipAction`	`1`	Cloud9 CreateEnvironmentMembership action.
`QtAws::Cloud9::Cloud9Request::DeleteEnvironmentAction`	`2`	Cloud9 DeleteEnvironment action.
`QtAws::Cloud9::Cloud9Request::DeleteEnvironmentMembershipAction`	`3`	Cloud9 DeleteEnvironmentMembership action.
`QtAws::Cloud9::Cloud9Request::DescribeEnvironmentMembershipsAction`	`4`	Cloud9 DescribeEnvironmentMemberships action.
`QtAws::Cloud9::Cloud9Request::DescribeEnvironmentStatusAction`	`5`	Cloud9 DescribeEnvironmentStatus action.
`QtAws::Cloud9::Cloud9Request::DescribeEnvironmentsAction`	`6`	Cloud9 DescribeEnvironments action.
`QtAws::Cloud9::Cloud9Request::ListEnvironmentsAction`	`7`	Cloud9 ListEnvironments action.
`QtAws::Cloud9::Cloud9Request::UpdateEnvironmentAction`	`8`	Cloud9 UpdateEnvironment action.
`QtAws::Cloud9::Cloud9Request::UpdateEnvironmentMembershipAction`	`9`	Cloud9 UpdateEnvironmentMembership action.

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

Member Function Documentation

Cloud9Request::Cloud9Request(const Action action)

Constructs a Cloud9Request object for Cloud9 action.

Cloud9Request::Cloud9Request(const Cloud9Request &other)

Constructs a copy of other.

`[protected]` Cloud9Request::Cloud9Request(Cloud9RequestPrivate * const d)

Constructs aa Cloud9Request object with private implementation d.

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

Action Cloud9Request::action() const

Returns the Cloud9 action to be performed by this request.

See also setAction().

QString Cloud9Request::actionString() const

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

QString Cloud9Request::apiVersion() const

Returns the Cloud9 API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void Cloud9Request::setAction(const Action action)

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

See also action().

void Cloud9Request::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the Cloud9Request object to be equal to other.

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