StorageGatewayRequest Class

(QtAws::StorageGateway::StorageGatewayRequest)

The StorageGatewayRequest class provides an interface for StorageGateway requests. More...

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

QtAws::StorageGateway::ActivateGatewayRequest, QtAws::StorageGateway::AddCacheRequest, QtAws::StorageGateway::AddTagsToResourceRequest, QtAws::StorageGateway::AddUploadBufferRequest, QtAws::StorageGateway::AddWorkingStorageRequest, QtAws::StorageGateway::CancelArchivalRequest, QtAws::StorageGateway::CancelRetrievalRequest, QtAws::StorageGateway::CreateCachediSCSIVolumeRequest, QtAws::StorageGateway::CreateNFSFileShareRequest, QtAws::StorageGateway::CreateSnapshotFromVolumeRecoveryPointRequest, QtAws::StorageGateway::CreateSnapshotRequest, QtAws::StorageGateway::CreateStorediSCSIVolumeRequest, QtAws::StorageGateway::CreateTapesRequest, QtAws::StorageGateway::CreateTapeWithBarcodeRequest, QtAws::StorageGateway::DeleteBandwidthRateLimitRequest, QtAws::StorageGateway::DeleteChapCredentialsRequest, QtAws::StorageGateway::DeleteFileShareRequest, QtAws::StorageGateway::DeleteGatewayRequest, QtAws::StorageGateway::DeleteSnapshotScheduleRequest, QtAws::StorageGateway::DeleteTapeArchiveRequest, QtAws::StorageGateway::DeleteTapeRequest, QtAws::StorageGateway::DeleteVolumeRequest, QtAws::StorageGateway::DescribeBandwidthRateLimitRequest, QtAws::StorageGateway::DescribeCachediSCSIVolumesRequest, QtAws::StorageGateway::DescribeCacheRequest, QtAws::StorageGateway::DescribeChapCredentialsRequest, QtAws::StorageGateway::DescribeGatewayInformationRequest, QtAws::StorageGateway::DescribeMaintenanceStartTimeRequest, QtAws::StorageGateway::DescribeNFSFileSharesRequest, QtAws::StorageGateway::DescribeSnapshotScheduleRequest, QtAws::StorageGateway::DescribeStorediSCSIVolumesRequest, QtAws::StorageGateway::DescribeTapeArchivesRequest, QtAws::StorageGateway::DescribeTapeRecoveryPointsRequest, QtAws::StorageGateway::DescribeTapesRequest, QtAws::StorageGateway::DescribeUploadBufferRequest, QtAws::StorageGateway::DescribeVTLDevicesRequest, QtAws::StorageGateway::DescribeWorkingStorageRequest, QtAws::StorageGateway::DisableGatewayRequest, QtAws::StorageGateway::ListFileSharesRequest, QtAws::StorageGateway::ListGatewaysRequest, QtAws::StorageGateway::ListLocalDisksRequest, QtAws::StorageGateway::ListTagsForResourceRequest, QtAws::StorageGateway::ListTapesRequest, QtAws::StorageGateway::ListVolumeInitiatorsRequest, QtAws::StorageGateway::ListVolumeRecoveryPointsRequest, QtAws::StorageGateway::ListVolumesRequest, QtAws::StorageGateway::NotifyWhenUploadedRequest, QtAws::StorageGateway::RefreshCacheRequest, QtAws::StorageGateway::RemoveTagsFromResourceRequest, QtAws::StorageGateway::ResetCacheRequest, QtAws::StorageGateway::RetrieveTapeArchiveRequest, QtAws::StorageGateway::RetrieveTapeRecoveryPointRequest, QtAws::StorageGateway::SetLocalConsolePasswordRequest, QtAws::StorageGateway::ShutdownGatewayRequest, QtAws::StorageGateway::StartGatewayRequest, QtAws::StorageGateway::UpdateBandwidthRateLimitRequest, QtAws::StorageGateway::UpdateChapCredentialsRequest, QtAws::StorageGateway::UpdateGatewayInformationRequest, QtAws::StorageGateway::UpdateGatewaySoftwareNowRequest, QtAws::StorageGateway::UpdateMaintenanceStartTimeRequest, QtAws::StorageGateway::UpdateNFSFileShareRequest, QtAws::StorageGateway::UpdateSnapshotScheduleRequest, and QtAws::StorageGateway::UpdateVTLDeviceTypeRequest

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

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 &parameters)

Reimplemented Protected Functions

virtual QNetworkRequest unsignedRequest(const QUrl &endpoint) const override

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.

ConstantValueDescription
QtAws::StorageGateway::StorageGatewayRequest::ActivateGatewayAction0StorageGateway ActivateGateway action.
QtAws::StorageGateway::StorageGatewayRequest::AddCacheAction1StorageGateway AddCache action.
QtAws::StorageGateway::StorageGatewayRequest::AddTagsToResourceAction2StorageGateway AddTagsToResource action.
QtAws::StorageGateway::StorageGatewayRequest::AddUploadBufferAction3StorageGateway AddUploadBuffer action.
QtAws::StorageGateway::StorageGatewayRequest::AddWorkingStorageAction4StorageGateway AddWorkingStorage action.
QtAws::StorageGateway::StorageGatewayRequest::CancelArchivalAction5StorageGateway CancelArchival action.
QtAws::StorageGateway::StorageGatewayRequest::CancelRetrievalAction6StorageGateway CancelRetrieval action.
QtAws::StorageGateway::StorageGatewayRequest::CreateCachediSCSIVolumeAction7StorageGateway CreateCachediSCSIVolume action.
QtAws::StorageGateway::StorageGatewayRequest::CreateNFSFileShareAction8StorageGateway CreateNFSFileShare action.
QtAws::StorageGateway::StorageGatewayRequest::CreateSnapshotAction9StorageGateway CreateSnapshot action.
QtAws::StorageGateway::StorageGatewayRequest::CreateSnapshotFromVolumeRecoveryPointAction10StorageGateway CreateSnapshotFromVolumeRecoveryPoint action.
QtAws::StorageGateway::StorageGatewayRequest::CreateStorediSCSIVolumeAction11StorageGateway CreateStorediSCSIVolume action.
QtAws::StorageGateway::StorageGatewayRequest::CreateTapeWithBarcodeAction12StorageGateway CreateTapeWithBarcode action.
QtAws::StorageGateway::StorageGatewayRequest::CreateTapesAction13StorageGateway CreateTapes action.
QtAws::StorageGateway::StorageGatewayRequest::DeleteBandwidthRateLimitAction14StorageGateway DeleteBandwidthRateLimit action.
QtAws::StorageGateway::StorageGatewayRequest::DeleteChapCredentialsAction15StorageGateway DeleteChapCredentials action.
QtAws::StorageGateway::StorageGatewayRequest::DeleteFileShareAction16StorageGateway DeleteFileShare action.
QtAws::StorageGateway::StorageGatewayRequest::DeleteGatewayAction17StorageGateway DeleteGateway action.
QtAws::StorageGateway::StorageGatewayRequest::DeleteSnapshotScheduleAction18StorageGateway DeleteSnapshotSchedule action.
QtAws::StorageGateway::StorageGatewayRequest::DeleteTapeAction19StorageGateway DeleteTape action.
QtAws::StorageGateway::StorageGatewayRequest::DeleteTapeArchiveAction20StorageGateway DeleteTapeArchive action.
QtAws::StorageGateway::StorageGatewayRequest::DeleteVolumeAction21StorageGateway DeleteVolume action.
QtAws::StorageGateway::StorageGatewayRequest::DescribeBandwidthRateLimitAction22StorageGateway DescribeBandwidthRateLimit action.
QtAws::StorageGateway::StorageGatewayRequest::DescribeCacheAction23StorageGateway DescribeCache action.
QtAws::StorageGateway::StorageGatewayRequest::DescribeCachediSCSIVolumesAction24StorageGateway DescribeCachediSCSIVolumes action.
QtAws::StorageGateway::StorageGatewayRequest::DescribeChapCredentialsAction25StorageGateway DescribeChapCredentials action.
QtAws::StorageGateway::StorageGatewayRequest::DescribeGatewayInformationAction26StorageGateway DescribeGatewayInformation action.
QtAws::StorageGateway::StorageGatewayRequest::DescribeMaintenanceStartTimeAction27StorageGateway DescribeMaintenanceStartTime action.
QtAws::StorageGateway::StorageGatewayRequest::DescribeNFSFileSharesAction28StorageGateway DescribeNFSFileShares action.
QtAws::StorageGateway::StorageGatewayRequest::DescribeSnapshotScheduleAction29StorageGateway DescribeSnapshotSchedule action.
QtAws::StorageGateway::StorageGatewayRequest::DescribeStorediSCSIVolumesAction30StorageGateway DescribeStorediSCSIVolumes action.
QtAws::StorageGateway::StorageGatewayRequest::DescribeTapeArchivesAction31StorageGateway DescribeTapeArchives action.
QtAws::StorageGateway::StorageGatewayRequest::DescribeTapeRecoveryPointsAction32StorageGateway DescribeTapeRecoveryPoints action.
QtAws::StorageGateway::StorageGatewayRequest::DescribeTapesAction33StorageGateway DescribeTapes action.
QtAws::StorageGateway::StorageGatewayRequest::DescribeUploadBufferAction34StorageGateway DescribeUploadBuffer action.
QtAws::StorageGateway::StorageGatewayRequest::DescribeVTLDevicesAction35StorageGateway DescribeVTLDevices action.
QtAws::StorageGateway::StorageGatewayRequest::DescribeWorkingStorageAction36StorageGateway DescribeWorkingStorage action.
QtAws::StorageGateway::StorageGatewayRequest::DisableGatewayAction37StorageGateway DisableGateway action.
QtAws::StorageGateway::StorageGatewayRequest::ListFileSharesAction38StorageGateway ListFileShares action.
QtAws::StorageGateway::StorageGatewayRequest::ListGatewaysAction39StorageGateway ListGateways action.
QtAws::StorageGateway::StorageGatewayRequest::ListLocalDisksAction40StorageGateway ListLocalDisks action.
QtAws::StorageGateway::StorageGatewayRequest::ListTagsForResourceAction41StorageGateway ListTagsForResource action.
QtAws::StorageGateway::StorageGatewayRequest::ListTapesAction42StorageGateway ListTapes action.
QtAws::StorageGateway::StorageGatewayRequest::ListVolumeInitiatorsAction43StorageGateway ListVolumeInitiators action.
QtAws::StorageGateway::StorageGatewayRequest::ListVolumeRecoveryPointsAction44StorageGateway ListVolumeRecoveryPoints action.
QtAws::StorageGateway::StorageGatewayRequest::ListVolumesAction45StorageGateway ListVolumes action.
QtAws::StorageGateway::StorageGatewayRequest::NotifyWhenUploadedAction46StorageGateway NotifyWhenUploaded action.
QtAws::StorageGateway::StorageGatewayRequest::RefreshCacheAction47StorageGateway RefreshCache action.
QtAws::StorageGateway::StorageGatewayRequest::RemoveTagsFromResourceAction48StorageGateway RemoveTagsFromResource action.
QtAws::StorageGateway::StorageGatewayRequest::ResetCacheAction49StorageGateway ResetCache action.
QtAws::StorageGateway::StorageGatewayRequest::RetrieveTapeArchiveAction50StorageGateway RetrieveTapeArchive action.
QtAws::StorageGateway::StorageGatewayRequest::RetrieveTapeRecoveryPointAction51StorageGateway RetrieveTapeRecoveryPoint action.
QtAws::StorageGateway::StorageGatewayRequest::SetLocalConsolePasswordAction52StorageGateway SetLocalConsolePassword action.
QtAws::StorageGateway::StorageGatewayRequest::ShutdownGatewayAction53StorageGateway ShutdownGateway action.
QtAws::StorageGateway::StorageGatewayRequest::StartGatewayAction54StorageGateway StartGateway action.
QtAws::StorageGateway::StorageGatewayRequest::UpdateBandwidthRateLimitAction55StorageGateway UpdateBandwidthRateLimit action.
QtAws::StorageGateway::StorageGatewayRequest::UpdateChapCredentialsAction56StorageGateway UpdateChapCredentials action.
QtAws::StorageGateway::StorageGatewayRequest::UpdateGatewayInformationAction57StorageGateway UpdateGatewayInformation action.
QtAws::StorageGateway::StorageGatewayRequest::UpdateGatewaySoftwareNowAction58StorageGateway UpdateGatewaySoftwareNow action.
QtAws::StorageGateway::StorageGatewayRequest::UpdateMaintenanceStartTimeAction59StorageGateway UpdateMaintenanceStartTime action.
QtAws::StorageGateway::StorageGatewayRequest::UpdateNFSFileShareAction60StorageGateway UpdateNFSFileShare action.
QtAws::StorageGateway::StorageGatewayRequest::UpdateSnapshotScheduleAction61StorageGateway UpdateSnapshotSchedule action.
QtAws::StorageGateway::StorageGatewayRequest::UpdateVTLDeviceTypeAction62StorageGateway 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 &parameters)

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.