StorageGatewayRequest Class
(QtAws::StorageGateway::StorageGatewayRequest)The StorageGatewayRequest class provides an interface for StorageGateway requests. More...
Public Types
| enum | Action { ActivateGatewayAction, AddCacheAction, AddTagsToResourceAction, AddUploadBufferAction, ..., UpdateVTLDeviceTypeAction } |
| flags | Actions |
Public Functions
| StorageGatewayRequest(const Action action) | |
| StorageGatewayRequest(const StorageGatewayRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| StorageGatewayRequest & | operator=(const StorageGatewayRequest &other) |
| virtual bool | operator==(const StorageGatewayRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| StorageGatewayRequest(StorageGatewayRequestPrivate * 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 StorageGatewayRequest class provides an interface for StorageGateway requests.
Member Type Documentation
enum StorageGatewayRequest::Action
flags StorageGatewayRequest::Actions
This enum describes the actions that can be performed as StorageGateway requests.
| Constant | Value | Description |
|---|---|---|
QtAws::StorageGateway::StorageGatewayRequest::ActivateGatewayAction | 0 | StorageGateway ActivateGateway action. |
QtAws::StorageGateway::StorageGatewayRequest::AddCacheAction | 1 | StorageGateway AddCache action. |
QtAws::StorageGateway::StorageGatewayRequest::AddTagsToResourceAction | 2 | StorageGateway AddTagsToResource action. |
QtAws::StorageGateway::StorageGatewayRequest::AddUploadBufferAction | 3 | StorageGateway AddUploadBuffer action. |
QtAws::StorageGateway::StorageGatewayRequest::AddWorkingStorageAction | 4 | StorageGateway AddWorkingStorage action. |
QtAws::StorageGateway::StorageGatewayRequest::CancelArchivalAction | 5 | StorageGateway CancelArchival action. |
QtAws::StorageGateway::StorageGatewayRequest::CancelRetrievalAction | 6 | StorageGateway CancelRetrieval action. |
QtAws::StorageGateway::StorageGatewayRequest::CreateCachediSCSIVolumeAction | 7 | StorageGateway CreateCachediSCSIVolume action. |
QtAws::StorageGateway::StorageGatewayRequest::CreateNFSFileShareAction | 8 | StorageGateway CreateNFSFileShare action. |
QtAws::StorageGateway::StorageGatewayRequest::CreateSnapshotAction | 9 | StorageGateway CreateSnapshot action. |
QtAws::StorageGateway::StorageGatewayRequest::CreateSnapshotFromVolumeRecoveryPointAction | 10 | StorageGateway CreateSnapshotFromVolumeRecoveryPoint action. |
QtAws::StorageGateway::StorageGatewayRequest::CreateStorediSCSIVolumeAction | 11 | StorageGateway CreateStorediSCSIVolume action. |
QtAws::StorageGateway::StorageGatewayRequest::CreateTapeWithBarcodeAction | 12 | StorageGateway CreateTapeWithBarcode action. |
QtAws::StorageGateway::StorageGatewayRequest::CreateTapesAction | 13 | StorageGateway CreateTapes action. |
QtAws::StorageGateway::StorageGatewayRequest::DeleteBandwidthRateLimitAction | 14 | StorageGateway DeleteBandwidthRateLimit action. |
QtAws::StorageGateway::StorageGatewayRequest::DeleteChapCredentialsAction | 15 | StorageGateway DeleteChapCredentials action. |
QtAws::StorageGateway::StorageGatewayRequest::DeleteFileShareAction | 16 | StorageGateway DeleteFileShare action. |
QtAws::StorageGateway::StorageGatewayRequest::DeleteGatewayAction | 17 | StorageGateway DeleteGateway action. |
QtAws::StorageGateway::StorageGatewayRequest::DeleteSnapshotScheduleAction | 18 | StorageGateway DeleteSnapshotSchedule action. |
QtAws::StorageGateway::StorageGatewayRequest::DeleteTapeAction | 19 | StorageGateway DeleteTape action. |
QtAws::StorageGateway::StorageGatewayRequest::DeleteTapeArchiveAction | 20 | StorageGateway DeleteTapeArchive action. |
QtAws::StorageGateway::StorageGatewayRequest::DeleteVolumeAction | 21 | StorageGateway DeleteVolume action. |
QtAws::StorageGateway::StorageGatewayRequest::DescribeBandwidthRateLimitAction | 22 | StorageGateway DescribeBandwidthRateLimit action. |
QtAws::StorageGateway::StorageGatewayRequest::DescribeCacheAction | 23 | StorageGateway DescribeCache action. |
QtAws::StorageGateway::StorageGatewayRequest::DescribeCachediSCSIVolumesAction | 24 | StorageGateway DescribeCachediSCSIVolumes action. |
QtAws::StorageGateway::StorageGatewayRequest::DescribeChapCredentialsAction | 25 | StorageGateway DescribeChapCredentials action. |
QtAws::StorageGateway::StorageGatewayRequest::DescribeGatewayInformationAction | 26 | StorageGateway DescribeGatewayInformation action. |
QtAws::StorageGateway::StorageGatewayRequest::DescribeMaintenanceStartTimeAction | 27 | StorageGateway DescribeMaintenanceStartTime action. |
QtAws::StorageGateway::StorageGatewayRequest::DescribeNFSFileSharesAction | 28 | StorageGateway DescribeNFSFileShares action. |
QtAws::StorageGateway::StorageGatewayRequest::DescribeSnapshotScheduleAction | 29 | StorageGateway DescribeSnapshotSchedule action. |
QtAws::StorageGateway::StorageGatewayRequest::DescribeStorediSCSIVolumesAction | 30 | StorageGateway DescribeStorediSCSIVolumes action. |
QtAws::StorageGateway::StorageGatewayRequest::DescribeTapeArchivesAction | 31 | StorageGateway DescribeTapeArchives action. |
QtAws::StorageGateway::StorageGatewayRequest::DescribeTapeRecoveryPointsAction | 32 | StorageGateway DescribeTapeRecoveryPoints action. |
QtAws::StorageGateway::StorageGatewayRequest::DescribeTapesAction | 33 | StorageGateway DescribeTapes action. |
QtAws::StorageGateway::StorageGatewayRequest::DescribeUploadBufferAction | 34 | StorageGateway DescribeUploadBuffer action. |
QtAws::StorageGateway::StorageGatewayRequest::DescribeVTLDevicesAction | 35 | StorageGateway DescribeVTLDevices action. |
QtAws::StorageGateway::StorageGatewayRequest::DescribeWorkingStorageAction | 36 | StorageGateway DescribeWorkingStorage action. |
QtAws::StorageGateway::StorageGatewayRequest::DisableGatewayAction | 37 | StorageGateway DisableGateway action. |
QtAws::StorageGateway::StorageGatewayRequest::ListFileSharesAction | 38 | StorageGateway ListFileShares action. |
QtAws::StorageGateway::StorageGatewayRequest::ListGatewaysAction | 39 | StorageGateway ListGateways action. |
QtAws::StorageGateway::StorageGatewayRequest::ListLocalDisksAction | 40 | StorageGateway ListLocalDisks action. |
QtAws::StorageGateway::StorageGatewayRequest::ListTagsForResourceAction | 41 | StorageGateway ListTagsForResource action. |
QtAws::StorageGateway::StorageGatewayRequest::ListTapesAction | 42 | StorageGateway ListTapes action. |
QtAws::StorageGateway::StorageGatewayRequest::ListVolumeInitiatorsAction | 43 | StorageGateway ListVolumeInitiators action. |
QtAws::StorageGateway::StorageGatewayRequest::ListVolumeRecoveryPointsAction | 44 | StorageGateway ListVolumeRecoveryPoints action. |
QtAws::StorageGateway::StorageGatewayRequest::ListVolumesAction | 45 | StorageGateway ListVolumes action. |
QtAws::StorageGateway::StorageGatewayRequest::NotifyWhenUploadedAction | 46 | StorageGateway NotifyWhenUploaded action. |
QtAws::StorageGateway::StorageGatewayRequest::RefreshCacheAction | 47 | StorageGateway RefreshCache action. |
QtAws::StorageGateway::StorageGatewayRequest::RemoveTagsFromResourceAction | 48 | StorageGateway RemoveTagsFromResource action. |
QtAws::StorageGateway::StorageGatewayRequest::ResetCacheAction | 49 | StorageGateway ResetCache action. |
QtAws::StorageGateway::StorageGatewayRequest::RetrieveTapeArchiveAction | 50 | StorageGateway RetrieveTapeArchive action. |
QtAws::StorageGateway::StorageGatewayRequest::RetrieveTapeRecoveryPointAction | 51 | StorageGateway RetrieveTapeRecoveryPoint action. |
QtAws::StorageGateway::StorageGatewayRequest::SetLocalConsolePasswordAction | 52 | StorageGateway SetLocalConsolePassword action. |
QtAws::StorageGateway::StorageGatewayRequest::ShutdownGatewayAction | 53 | StorageGateway ShutdownGateway action. |
QtAws::StorageGateway::StorageGatewayRequest::StartGatewayAction | 54 | StorageGateway StartGateway action. |
QtAws::StorageGateway::StorageGatewayRequest::UpdateBandwidthRateLimitAction | 55 | StorageGateway UpdateBandwidthRateLimit action. |
QtAws::StorageGateway::StorageGatewayRequest::UpdateChapCredentialsAction | 56 | StorageGateway UpdateChapCredentials action. |
QtAws::StorageGateway::StorageGatewayRequest::UpdateGatewayInformationAction | 57 | StorageGateway UpdateGatewayInformation action. |
QtAws::StorageGateway::StorageGatewayRequest::UpdateGatewaySoftwareNowAction | 58 | StorageGateway UpdateGatewaySoftwareNow action. |
QtAws::StorageGateway::StorageGatewayRequest::UpdateMaintenanceStartTimeAction | 59 | StorageGateway UpdateMaintenanceStartTime action. |
QtAws::StorageGateway::StorageGatewayRequest::UpdateNFSFileShareAction | 60 | StorageGateway UpdateNFSFileShare action. |
QtAws::StorageGateway::StorageGatewayRequest::UpdateSnapshotScheduleAction | 61 | StorageGateway UpdateSnapshotSchedule action. |
QtAws::StorageGateway::StorageGatewayRequest::UpdateVTLDeviceTypeAction | 62 | StorageGateway UpdateVTLDeviceType action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
StorageGatewayRequest::StorageGatewayRequest(const Action action)
Constructs a StorageGatewayRequest object for StorageGateway action.
StorageGatewayRequest::StorageGatewayRequest(const StorageGatewayRequest &other)
Constructs a copy of other.
[protected] StorageGatewayRequest::StorageGatewayRequest(StorageGatewayRequestPrivate * const d)
Constructs aa StorageGatewayRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from StorageGatewayRequestPrivate.
Action StorageGatewayRequest::action() const
Returns the StorageGateway action to be performed by this request.
See also setAction().
QString StorageGatewayRequest::actionString() const
Returns the name of the StorageGateway action to be performed by this request.
QString StorageGatewayRequest::apiVersion() const
Returns the StorageGateway API version implemented by this request.
See also setApiVersion().
[protected] int StorageGatewayRequest::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 StorageGatewayRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant StorageGatewayRequest::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 &StorageGatewayRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void StorageGatewayRequest::setAction(const Action action)
Sets the StorageGateway action to be performed by this request to action.
See also action().
void StorageGatewayRequest::setApiVersion(const QString &version)
Sets the StorageGateway API version to include in this request to version.
See also apiVersion().
[protected] void StorageGatewayRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void StorageGatewayRequest::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 StorageGatewayRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the StorageGateway request using the given endpoint.
This StorageGateway 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.
StorageGatewayRequest &StorageGatewayRequest::operator=(const StorageGatewayRequest &other)
Sets the StorageGatewayRequest object to be equal to other.
[virtual] bool StorageGatewayRequest::operator==(const StorageGatewayRequest &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.