CloudHSMV2Request Class

(QtAws::CloudHSMV2::CloudHSMV2Request)

The CloudHSMV2Request class provides an interface for CloudHSMV2 requests. More...

Header:	#include <CloudHSMV2Request>
Inherits:	QtAws::Core::AwsAbstractRequest
Inherited By:	QtAws::CloudHSMV2::CreateClusterRequest, QtAws::CloudHSMV2::CreateHsmRequest, QtAws::CloudHSMV2::DeleteClusterRequest, QtAws::CloudHSMV2::DeleteHsmRequest, QtAws::CloudHSMV2::DescribeBackupsRequest, QtAws::CloudHSMV2::DescribeClustersRequest, QtAws::CloudHSMV2::InitializeClusterRequest, QtAws::CloudHSMV2::ListTagsRequest, QtAws::CloudHSMV2::TagResourceRequest, and QtAws::CloudHSMV2::UntagResourceRequest

List of all members, including inherited members

Public Types

enum	Action { CreateClusterAction, CreateHsmAction, DeleteClusterAction, DeleteHsmAction, ..., UntagResourceAction }
flags	Actions

Public Functions

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

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

Protected Functions

	CloudHSMV2Request(CloudHSMV2RequestPrivate * 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 CloudHSMV2Request class provides an interface for CloudHSMV2 requests.

Member Type Documentation

enum CloudHSMV2Request::Action
flags CloudHSMV2Request::Actions

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

Constant	Value	Description
`QtAws::CloudHSMV2::CloudHSMV2Request::CreateClusterAction`	`0`	CloudHSMV2 CreateCluster action.
`QtAws::CloudHSMV2::CloudHSMV2Request::CreateHsmAction`	`1`	CloudHSMV2 CreateHsm action.
`QtAws::CloudHSMV2::CloudHSMV2Request::DeleteClusterAction`	`2`	CloudHSMV2 DeleteCluster action.
`QtAws::CloudHSMV2::CloudHSMV2Request::DeleteHsmAction`	`3`	CloudHSMV2 DeleteHsm action.
`QtAws::CloudHSMV2::CloudHSMV2Request::DescribeBackupsAction`	`4`	CloudHSMV2 DescribeBackups action.
`QtAws::CloudHSMV2::CloudHSMV2Request::DescribeClustersAction`	`5`	CloudHSMV2 DescribeClusters action.
`QtAws::CloudHSMV2::CloudHSMV2Request::InitializeClusterAction`	`6`	CloudHSMV2 InitializeCluster action.
`QtAws::CloudHSMV2::CloudHSMV2Request::ListTagsAction`	`7`	CloudHSMV2 ListTags action.
`QtAws::CloudHSMV2::CloudHSMV2Request::TagResourceAction`	`8`	CloudHSMV2 TagResource action.
`QtAws::CloudHSMV2::CloudHSMV2Request::UntagResourceAction`	`9`	CloudHSMV2 UntagResource action.

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

Member Function Documentation

CloudHSMV2Request::CloudHSMV2Request(const Action action)

Constructs a CloudHSMV2Request object for CloudHSMV2 action.

CloudHSMV2Request::CloudHSMV2Request(const CloudHSMV2Request &other)

Constructs a copy of other.

`[protected]` CloudHSMV2Request::CloudHSMV2Request(CloudHSMV2RequestPrivate * const d)

Constructs aa CloudHSMV2Request object with private implementation d.

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

Action CloudHSMV2Request::action() const

Returns the CloudHSMV2 action to be performed by this request.

See also setAction().

QString CloudHSMV2Request::actionString() const

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

QString CloudHSMV2Request::apiVersion() const

Returns the CloudHSMV2 API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void CloudHSMV2Request::setAction(const Action action)

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

See also action().

void CloudHSMV2Request::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the CloudHSMV2Request object to be equal to other.

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