GlacierRequest Class
(QtAws::Glacier::GlacierRequest)The GlacierRequest class provides an interface for Glacier requests. More...
Public Types
| enum | Action { AbortMultipartUploadAction, AbortVaultLockAction, AddTagsToVaultAction, CompleteMultipartUploadAction, ..., UploadMultipartPartAction } |
| flags | Actions |
Public Functions
| GlacierRequest(const Action action) | |
| GlacierRequest(const GlacierRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| GlacierRequest & | operator=(const GlacierRequest &other) |
| virtual bool | operator==(const GlacierRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| GlacierRequest(GlacierRequestPrivate * 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 GlacierRequest class provides an interface for Glacier requests.
Member Type Documentation
enum GlacierRequest::Action
flags GlacierRequest::Actions
This enum describes the actions that can be performed as Glacier requests.
| Constant | Value | Description |
|---|---|---|
QtAws::Glacier::GlacierRequest::AbortMultipartUploadAction | 0 | Glacier AbortMultipartUpload action. |
QtAws::Glacier::GlacierRequest::AbortVaultLockAction | 1 | Glacier AbortVaultLock action. |
QtAws::Glacier::GlacierRequest::AddTagsToVaultAction | 2 | Glacier AddTagsToVault action. |
QtAws::Glacier::GlacierRequest::CompleteMultipartUploadAction | 3 | Glacier CompleteMultipartUpload action. |
QtAws::Glacier::GlacierRequest::CompleteVaultLockAction | 4 | Glacier CompleteVaultLock action. |
QtAws::Glacier::GlacierRequest::CreateVaultAction | 5 | Glacier CreateVault action. |
QtAws::Glacier::GlacierRequest::DeleteArchiveAction | 6 | Glacier DeleteArchive action. |
QtAws::Glacier::GlacierRequest::DeleteVaultAction | 7 | Glacier DeleteVault action. |
QtAws::Glacier::GlacierRequest::DeleteVaultAccessPolicyAction | 8 | Glacier DeleteVaultAccessPolicy action. |
QtAws::Glacier::GlacierRequest::DeleteVaultNotificationsAction | 9 | Glacier DeleteVaultNotifications action. |
QtAws::Glacier::GlacierRequest::DescribeJobAction | 10 | Glacier DescribeJob action. |
QtAws::Glacier::GlacierRequest::DescribeVaultAction | 11 | Glacier DescribeVault action. |
QtAws::Glacier::GlacierRequest::GetDataRetrievalPolicyAction | 12 | Glacier GetDataRetrievalPolicy action. |
QtAws::Glacier::GlacierRequest::GetJobOutputAction | 13 | Glacier GetJobOutput action. |
QtAws::Glacier::GlacierRequest::GetVaultAccessPolicyAction | 14 | Glacier GetVaultAccessPolicy action. |
QtAws::Glacier::GlacierRequest::GetVaultLockAction | 15 | Glacier GetVaultLock action. |
QtAws::Glacier::GlacierRequest::GetVaultNotificationsAction | 16 | Glacier GetVaultNotifications action. |
QtAws::Glacier::GlacierRequest::InitiateJobAction | 17 | Glacier InitiateJob action. |
QtAws::Glacier::GlacierRequest::InitiateMultipartUploadAction | 18 | Glacier InitiateMultipartUpload action. |
QtAws::Glacier::GlacierRequest::InitiateVaultLockAction | 19 | Glacier InitiateVaultLock action. |
QtAws::Glacier::GlacierRequest::ListJobsAction | 20 | Glacier ListJobs action. |
QtAws::Glacier::GlacierRequest::ListMultipartUploadsAction | 21 | Glacier ListMultipartUploads action. |
QtAws::Glacier::GlacierRequest::ListPartsAction | 22 | Glacier ListParts action. |
QtAws::Glacier::GlacierRequest::ListProvisionedCapacityAction | 23 | Glacier ListProvisionedCapacity action. |
QtAws::Glacier::GlacierRequest::ListTagsForVaultAction | 24 | Glacier ListTagsForVault action. |
QtAws::Glacier::GlacierRequest::ListVaultsAction | 25 | Glacier ListVaults action. |
QtAws::Glacier::GlacierRequest::PurchaseProvisionedCapacityAction | 26 | Glacier PurchaseProvisionedCapacity action. |
QtAws::Glacier::GlacierRequest::RemoveTagsFromVaultAction | 27 | Glacier RemoveTagsFromVault action. |
QtAws::Glacier::GlacierRequest::SetDataRetrievalPolicyAction | 28 | Glacier SetDataRetrievalPolicy action. |
QtAws::Glacier::GlacierRequest::SetVaultAccessPolicyAction | 29 | Glacier SetVaultAccessPolicy action. |
QtAws::Glacier::GlacierRequest::SetVaultNotificationsAction | 30 | Glacier SetVaultNotifications action. |
QtAws::Glacier::GlacierRequest::UploadArchiveAction | 31 | Glacier UploadArchive action. |
QtAws::Glacier::GlacierRequest::UploadMultipartPartAction | 32 | Glacier UploadMultipartPart action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
GlacierRequest::GlacierRequest(const Action action)
Constructs a GlacierRequest object for Glacier action.
GlacierRequest::GlacierRequest(const GlacierRequest &other)
Constructs a copy of other.
[protected] GlacierRequest::GlacierRequest(GlacierRequestPrivate * const d)
Constructs aa GlacierRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from GlacierRequestPrivate.
Action GlacierRequest::action() const
Returns the Glacier action to be performed by this request.
See also setAction().
QString GlacierRequest::actionString() const
Returns the name of the Glacier action to be performed by this request.
QString GlacierRequest::apiVersion() const
Returns the Glacier API version implemented by this request.
See also setApiVersion().
[protected] int GlacierRequest::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 GlacierRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant GlacierRequest::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 &GlacierRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void GlacierRequest::setAction(const Action action)
Sets the Glacier action to be performed by this request to action.
See also action().
void GlacierRequest::setApiVersion(const QString &version)
Sets the Glacier API version to include in this request to version.
See also apiVersion().
[protected] void GlacierRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void GlacierRequest::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 GlacierRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the Glacier request using the given endpoint.
This Glacier 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.
GlacierRequest &GlacierRequest::operator=(const GlacierRequest &other)
Sets the GlacierRequest object to be equal to other.
[virtual] bool GlacierRequest::operator==(const GlacierRequest &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.