CloudFrontRequest Class
(QtAws::CloudFront::CloudFrontRequest)The CloudFrontRequest class provides an interface for CloudFront requests. More...
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 |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
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 ¶meters) |
Reimplemented Protected Functions
| virtual QNetworkRequest | unsignedRequest(const QUrl &endpoint) const override |
- 4 protected functions inherited from QtAws::Core::AwsAbstractRequest
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.
| Constant | Value | Description |
|---|---|---|
QtAws::CloudFront::CloudFrontRequest::CreateCloudFrontOriginAccessIdentityAction | 0 | CloudFront CreateCloudFrontOriginAccessIdentity action. |
QtAws::CloudFront::CloudFrontRequest::CreateDistributionAction | 1 | CloudFront CreateDistribution action. |
QtAws::CloudFront::CloudFrontRequest::CreateDistributionWithTagsAction | 2 | CloudFront CreateDistributionWithTags action. |
QtAws::CloudFront::CloudFrontRequest::CreateFieldLevelEncryptionConfigAction | 3 | CloudFront CreateFieldLevelEncryptionConfig action. |
QtAws::CloudFront::CloudFrontRequest::CreateFieldLevelEncryptionProfileAction | 4 | CloudFront CreateFieldLevelEncryptionProfile action. |
QtAws::CloudFront::CloudFrontRequest::CreateInvalidationAction | 5 | CloudFront CreateInvalidation action. |
QtAws::CloudFront::CloudFrontRequest::CreatePublicKeyAction | 6 | CloudFront CreatePublicKey action. |
QtAws::CloudFront::CloudFrontRequest::CreateStreamingDistributionAction | 7 | CloudFront CreateStreamingDistribution action. |
QtAws::CloudFront::CloudFrontRequest::CreateStreamingDistributionWithTagsAction | 8 | CloudFront CreateStreamingDistributionWithTags action. |
QtAws::CloudFront::CloudFrontRequest::DeleteCloudFrontOriginAccessIdentityAction | 9 | CloudFront DeleteCloudFrontOriginAccessIdentity action. |
QtAws::CloudFront::CloudFrontRequest::DeleteDistributionAction | 10 | CloudFront DeleteDistribution action. |
QtAws::CloudFront::CloudFrontRequest::DeleteFieldLevelEncryptionConfigAction | 11 | CloudFront DeleteFieldLevelEncryptionConfig action. |
QtAws::CloudFront::CloudFrontRequest::DeleteFieldLevelEncryptionProfileAction | 12 | CloudFront DeleteFieldLevelEncryptionProfile action. |
QtAws::CloudFront::CloudFrontRequest::DeletePublicKeyAction | 13 | CloudFront DeletePublicKey action. |
QtAws::CloudFront::CloudFrontRequest::DeleteServiceLinkedRoleAction | 14 | CloudFront DeleteServiceLinkedRole action. |
QtAws::CloudFront::CloudFrontRequest::DeleteStreamingDistributionAction | 15 | CloudFront DeleteStreamingDistribution action. |
QtAws::CloudFront::CloudFrontRequest::GetCloudFrontOriginAccessIdentityAction | 16 | CloudFront GetCloudFrontOriginAccessIdentity action. |
QtAws::CloudFront::CloudFrontRequest::GetCloudFrontOriginAccessIdentityConfigAction | 17 | CloudFront GetCloudFrontOriginAccessIdentityConfig action. |
QtAws::CloudFront::CloudFrontRequest::GetDistributionAction | 18 | CloudFront GetDistribution action. |
QtAws::CloudFront::CloudFrontRequest::GetDistributionConfigAction | 19 | CloudFront GetDistributionConfig action. |
QtAws::CloudFront::CloudFrontRequest::GetFieldLevelEncryptionAction | 20 | CloudFront GetFieldLevelEncryption action. |
QtAws::CloudFront::CloudFrontRequest::GetFieldLevelEncryptionConfigAction | 21 | CloudFront GetFieldLevelEncryptionConfig action. |
QtAws::CloudFront::CloudFrontRequest::GetFieldLevelEncryptionProfileAction | 22 | CloudFront GetFieldLevelEncryptionProfile action. |
QtAws::CloudFront::CloudFrontRequest::GetFieldLevelEncryptionProfileConfigAction | 23 | CloudFront GetFieldLevelEncryptionProfileConfig action. |
QtAws::CloudFront::CloudFrontRequest::GetInvalidationAction | 24 | CloudFront GetInvalidation action. |
QtAws::CloudFront::CloudFrontRequest::GetPublicKeyAction | 25 | CloudFront GetPublicKey action. |
QtAws::CloudFront::CloudFrontRequest::GetPublicKeyConfigAction | 26 | CloudFront GetPublicKeyConfig action. |
QtAws::CloudFront::CloudFrontRequest::GetStreamingDistributionAction | 27 | CloudFront GetStreamingDistribution action. |
QtAws::CloudFront::CloudFrontRequest::GetStreamingDistributionConfigAction | 28 | CloudFront GetStreamingDistributionConfig action. |
QtAws::CloudFront::CloudFrontRequest::ListCloudFrontOriginAccessIdentitiesAction | 29 | CloudFront ListCloudFrontOriginAccessIdentities action. |
QtAws::CloudFront::CloudFrontRequest::ListDistributionsAction | 30 | CloudFront ListDistributions action. |
QtAws::CloudFront::CloudFrontRequest::ListDistributionsByWebACLIdAction | 31 | CloudFront ListDistributionsByWebACLId action. |
QtAws::CloudFront::CloudFrontRequest::ListFieldLevelEncryptionConfigsAction | 32 | CloudFront ListFieldLevelEncryptionConfigs action. |
QtAws::CloudFront::CloudFrontRequest::ListFieldLevelEncryptionProfilesAction | 33 | CloudFront ListFieldLevelEncryptionProfiles action. |
QtAws::CloudFront::CloudFrontRequest::ListInvalidationsAction | 34 | CloudFront ListInvalidations action. |
QtAws::CloudFront::CloudFrontRequest::ListPublicKeysAction | 35 | CloudFront ListPublicKeys action. |
QtAws::CloudFront::CloudFrontRequest::ListStreamingDistributionsAction | 36 | CloudFront ListStreamingDistributions action. |
QtAws::CloudFront::CloudFrontRequest::ListTagsForResourceAction | 37 | CloudFront ListTagsForResource action. |
QtAws::CloudFront::CloudFrontRequest::TagResourceAction | 38 | CloudFront TagResource action. |
QtAws::CloudFront::CloudFrontRequest::UntagResourceAction | 39 | CloudFront UntagResource action. |
QtAws::CloudFront::CloudFrontRequest::UpdateCloudFrontOriginAccessIdentityAction | 40 | CloudFront UpdateCloudFrontOriginAccessIdentity action. |
QtAws::CloudFront::CloudFrontRequest::UpdateDistributionAction | 41 | CloudFront UpdateDistribution action. |
QtAws::CloudFront::CloudFrontRequest::UpdateFieldLevelEncryptionConfigAction | 42 | CloudFront UpdateFieldLevelEncryptionConfig action. |
QtAws::CloudFront::CloudFrontRequest::UpdateFieldLevelEncryptionProfileAction | 43 | CloudFront UpdateFieldLevelEncryptionProfile action. |
QtAws::CloudFront::CloudFrontRequest::UpdatePublicKeyAction | 44 | CloudFront UpdatePublicKey action. |
QtAws::CloudFront::CloudFrontRequest::UpdateStreamingDistributionAction | 45 | CloudFront 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 ¶meters)
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.