CloudFrontRequest Class

(QtAws::CloudFront::CloudFrontRequest)

The CloudFrontRequest class provides an interface for CloudFront requests. More...

Header: #include <CloudFrontRequest>
Inherits: QtAws::Core::AwsAbstractRequest
Inherited By:

QtAws::CloudFront::CreateCloudFrontOriginAccessIdentityRequest, QtAws::CloudFront::CreateDistributionRequest, QtAws::CloudFront::CreateDistributionWithTagsRequest, QtAws::CloudFront::CreateFieldLevelEncryptionConfigRequest, QtAws::CloudFront::CreateFieldLevelEncryptionProfileRequest, QtAws::CloudFront::CreateInvalidationRequest, QtAws::CloudFront::CreatePublicKeyRequest, QtAws::CloudFront::CreateStreamingDistributionRequest, QtAws::CloudFront::CreateStreamingDistributionWithTagsRequest, QtAws::CloudFront::DeleteCloudFrontOriginAccessIdentityRequest, QtAws::CloudFront::DeleteDistributionRequest, QtAws::CloudFront::DeleteFieldLevelEncryptionConfigRequest, QtAws::CloudFront::DeleteFieldLevelEncryptionProfileRequest, QtAws::CloudFront::DeletePublicKeyRequest, QtAws::CloudFront::DeleteServiceLinkedRoleRequest, QtAws::CloudFront::DeleteStreamingDistributionRequest, QtAws::CloudFront::GetCloudFrontOriginAccessIdentityConfigRequest, QtAws::CloudFront::GetCloudFrontOriginAccessIdentityRequest, QtAws::CloudFront::GetDistributionConfigRequest, QtAws::CloudFront::GetDistributionRequest, QtAws::CloudFront::GetFieldLevelEncryptionConfigRequest, QtAws::CloudFront::GetFieldLevelEncryptionProfileConfigRequest, QtAws::CloudFront::GetFieldLevelEncryptionProfileRequest, QtAws::CloudFront::GetFieldLevelEncryptionRequest, QtAws::CloudFront::GetInvalidationRequest, QtAws::CloudFront::GetPublicKeyConfigRequest, QtAws::CloudFront::GetPublicKeyRequest, QtAws::CloudFront::GetStreamingDistributionConfigRequest, QtAws::CloudFront::GetStreamingDistributionRequest, QtAws::CloudFront::ListCloudFrontOriginAccessIdentitiesRequest, QtAws::CloudFront::ListDistributionsByWebACLIdRequest, QtAws::CloudFront::ListDistributionsRequest, QtAws::CloudFront::ListFieldLevelEncryptionConfigsRequest, QtAws::CloudFront::ListFieldLevelEncryptionProfilesRequest, QtAws::CloudFront::ListInvalidationsRequest, QtAws::CloudFront::ListPublicKeysRequest, QtAws::CloudFront::ListStreamingDistributionsRequest, QtAws::CloudFront::ListTagsForResourceRequest, QtAws::CloudFront::TagResourceRequest, QtAws::CloudFront::UntagResourceRequest, QtAws::CloudFront::UpdateCloudFrontOriginAccessIdentityRequest, QtAws::CloudFront::UpdateDistributionRequest, QtAws::CloudFront::UpdateFieldLevelEncryptionConfigRequest, QtAws::CloudFront::UpdateFieldLevelEncryptionProfileRequest, QtAws::CloudFront::UpdatePublicKeyRequest, and QtAws::CloudFront::UpdateStreamingDistributionRequest

Public Types

enum Action { CreateCloudFrontOriginAccessIdentityAction, CreateDistributionAction, CreateDistributionWithTagsAction, CreateFieldLevelEncryptionConfigAction, ..., UpdateStreamingDistributionAction }
flags Actions

Public Functions

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

Protected Functions

CloudFrontRequest(CloudFrontRequestPrivate * 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 CloudFrontRequest class provides an interface for CloudFront requests.

Member Type Documentation

enum CloudFrontRequest::Action
flags CloudFrontRequest::Actions

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

ConstantValueDescription
QtAws::CloudFront::CloudFrontRequest::CreateCloudFrontOriginAccessIdentityAction0CloudFront CreateCloudFrontOriginAccessIdentity action.
QtAws::CloudFront::CloudFrontRequest::CreateDistributionAction1CloudFront CreateDistribution action.
QtAws::CloudFront::CloudFrontRequest::CreateDistributionWithTagsAction2CloudFront CreateDistributionWithTags action.
QtAws::CloudFront::CloudFrontRequest::CreateFieldLevelEncryptionConfigAction3CloudFront CreateFieldLevelEncryptionConfig action.
QtAws::CloudFront::CloudFrontRequest::CreateFieldLevelEncryptionProfileAction4CloudFront CreateFieldLevelEncryptionProfile action.
QtAws::CloudFront::CloudFrontRequest::CreateInvalidationAction5CloudFront CreateInvalidation action.
QtAws::CloudFront::CloudFrontRequest::CreatePublicKeyAction6CloudFront CreatePublicKey action.
QtAws::CloudFront::CloudFrontRequest::CreateStreamingDistributionAction7CloudFront CreateStreamingDistribution action.
QtAws::CloudFront::CloudFrontRequest::CreateStreamingDistributionWithTagsAction8CloudFront CreateStreamingDistributionWithTags action.
QtAws::CloudFront::CloudFrontRequest::DeleteCloudFrontOriginAccessIdentityAction9CloudFront DeleteCloudFrontOriginAccessIdentity action.
QtAws::CloudFront::CloudFrontRequest::DeleteDistributionAction10CloudFront DeleteDistribution action.
QtAws::CloudFront::CloudFrontRequest::DeleteFieldLevelEncryptionConfigAction11CloudFront DeleteFieldLevelEncryptionConfig action.
QtAws::CloudFront::CloudFrontRequest::DeleteFieldLevelEncryptionProfileAction12CloudFront DeleteFieldLevelEncryptionProfile action.
QtAws::CloudFront::CloudFrontRequest::DeletePublicKeyAction13CloudFront DeletePublicKey action.
QtAws::CloudFront::CloudFrontRequest::DeleteServiceLinkedRoleAction14CloudFront DeleteServiceLinkedRole action.
QtAws::CloudFront::CloudFrontRequest::DeleteStreamingDistributionAction15CloudFront DeleteStreamingDistribution action.
QtAws::CloudFront::CloudFrontRequest::GetCloudFrontOriginAccessIdentityAction16CloudFront GetCloudFrontOriginAccessIdentity action.
QtAws::CloudFront::CloudFrontRequest::GetCloudFrontOriginAccessIdentityConfigAction17CloudFront GetCloudFrontOriginAccessIdentityConfig action.
QtAws::CloudFront::CloudFrontRequest::GetDistributionAction18CloudFront GetDistribution action.
QtAws::CloudFront::CloudFrontRequest::GetDistributionConfigAction19CloudFront GetDistributionConfig action.
QtAws::CloudFront::CloudFrontRequest::GetFieldLevelEncryptionAction20CloudFront GetFieldLevelEncryption action.
QtAws::CloudFront::CloudFrontRequest::GetFieldLevelEncryptionConfigAction21CloudFront GetFieldLevelEncryptionConfig action.
QtAws::CloudFront::CloudFrontRequest::GetFieldLevelEncryptionProfileAction22CloudFront GetFieldLevelEncryptionProfile action.
QtAws::CloudFront::CloudFrontRequest::GetFieldLevelEncryptionProfileConfigAction23CloudFront GetFieldLevelEncryptionProfileConfig action.
QtAws::CloudFront::CloudFrontRequest::GetInvalidationAction24CloudFront GetInvalidation action.
QtAws::CloudFront::CloudFrontRequest::GetPublicKeyAction25CloudFront GetPublicKey action.
QtAws::CloudFront::CloudFrontRequest::GetPublicKeyConfigAction26CloudFront GetPublicKeyConfig action.
QtAws::CloudFront::CloudFrontRequest::GetStreamingDistributionAction27CloudFront GetStreamingDistribution action.
QtAws::CloudFront::CloudFrontRequest::GetStreamingDistributionConfigAction28CloudFront GetStreamingDistributionConfig action.
QtAws::CloudFront::CloudFrontRequest::ListCloudFrontOriginAccessIdentitiesAction29CloudFront ListCloudFrontOriginAccessIdentities action.
QtAws::CloudFront::CloudFrontRequest::ListDistributionsAction30CloudFront ListDistributions action.
QtAws::CloudFront::CloudFrontRequest::ListDistributionsByWebACLIdAction31CloudFront ListDistributionsByWebACLId action.
QtAws::CloudFront::CloudFrontRequest::ListFieldLevelEncryptionConfigsAction32CloudFront ListFieldLevelEncryptionConfigs action.
QtAws::CloudFront::CloudFrontRequest::ListFieldLevelEncryptionProfilesAction33CloudFront ListFieldLevelEncryptionProfiles action.
QtAws::CloudFront::CloudFrontRequest::ListInvalidationsAction34CloudFront ListInvalidations action.
QtAws::CloudFront::CloudFrontRequest::ListPublicKeysAction35CloudFront ListPublicKeys action.
QtAws::CloudFront::CloudFrontRequest::ListStreamingDistributionsAction36CloudFront ListStreamingDistributions action.
QtAws::CloudFront::CloudFrontRequest::ListTagsForResourceAction37CloudFront ListTagsForResource action.
QtAws::CloudFront::CloudFrontRequest::TagResourceAction38CloudFront TagResource action.
QtAws::CloudFront::CloudFrontRequest::UntagResourceAction39CloudFront UntagResource action.
QtAws::CloudFront::CloudFrontRequest::UpdateCloudFrontOriginAccessIdentityAction40CloudFront UpdateCloudFrontOriginAccessIdentity action.
QtAws::CloudFront::CloudFrontRequest::UpdateDistributionAction41CloudFront UpdateDistribution action.
QtAws::CloudFront::CloudFrontRequest::UpdateFieldLevelEncryptionConfigAction42CloudFront UpdateFieldLevelEncryptionConfig action.
QtAws::CloudFront::CloudFrontRequest::UpdateFieldLevelEncryptionProfileAction43CloudFront UpdateFieldLevelEncryptionProfile action.
QtAws::CloudFront::CloudFrontRequest::UpdatePublicKeyAction44CloudFront UpdatePublicKey action.
QtAws::CloudFront::CloudFrontRequest::UpdateStreamingDistributionAction45CloudFront UpdateStreamingDistribution action.

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

Member Function Documentation

CloudFrontRequest::CloudFrontRequest(const Action action)

Constructs a CloudFrontRequest object for CloudFront action.

CloudFrontRequest::CloudFrontRequest(const CloudFrontRequest &other)

Constructs a copy of other.

[protected] CloudFrontRequest::CloudFrontRequest(CloudFrontRequestPrivate * const d)

Constructs aa CloudFrontRequest object with private implementation d.

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

Action CloudFrontRequest::action() const

Returns the CloudFront action to be performed by this request.

See also setAction().

QString CloudFrontRequest::actionString() const

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

QString CloudFrontRequest::apiVersion() const

Returns the CloudFront API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void CloudFrontRequest::setAction(const Action action)

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

See also action().

void CloudFrontRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the CloudFrontRequest object to be equal to other.

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