RedshiftRequest Class
(QtAws::Redshift::RedshiftRequest)The RedshiftRequest class provides an interface for Redshift requests. More...
Public Types
| enum | Action { AuthorizeClusterSecurityGroupIngressAction, AuthorizeSnapshotAccessAction, CopyClusterSnapshotAction, CreateClusterAction, ..., RotateEncryptionKeyAction } |
| flags | Actions |
Public Functions
| RedshiftRequest(const Action action) | |
| RedshiftRequest(const RedshiftRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| RedshiftRequest & | operator=(const RedshiftRequest &other) |
| virtual bool | operator==(const RedshiftRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| RedshiftRequest(RedshiftRequestPrivate * 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 RedshiftRequest class provides an interface for Redshift requests.
Member Type Documentation
enum RedshiftRequest::Action
flags RedshiftRequest::Actions
This enum describes the actions that can be performed as Redshift requests.
| Constant | Value | Description |
|---|---|---|
QtAws::Redshift::RedshiftRequest::AuthorizeClusterSecurityGroupIngressAction | 0 | Redshift AuthorizeClusterSecurityGroupIngress action. |
QtAws::Redshift::RedshiftRequest::AuthorizeSnapshotAccessAction | 1 | Redshift AuthorizeSnapshotAccess action. |
QtAws::Redshift::RedshiftRequest::CopyClusterSnapshotAction | 2 | Redshift CopyClusterSnapshot action. |
QtAws::Redshift::RedshiftRequest::CreateClusterAction | 3 | Redshift CreateCluster action. |
QtAws::Redshift::RedshiftRequest::CreateClusterParameterGroupAction | 4 | Redshift CreateClusterParameterGroup action. |
QtAws::Redshift::RedshiftRequest::CreateClusterSecurityGroupAction | 5 | Redshift CreateClusterSecurityGroup action. |
QtAws::Redshift::RedshiftRequest::CreateClusterSnapshotAction | 6 | Redshift CreateClusterSnapshot action. |
QtAws::Redshift::RedshiftRequest::CreateClusterSubnetGroupAction | 7 | Redshift CreateClusterSubnetGroup action. |
QtAws::Redshift::RedshiftRequest::CreateEventSubscriptionAction | 8 | Redshift CreateEventSubscription action. |
QtAws::Redshift::RedshiftRequest::CreateHsmClientCertificateAction | 9 | Redshift CreateHsmClientCertificate action. |
QtAws::Redshift::RedshiftRequest::CreateHsmConfigurationAction | 10 | Redshift CreateHsmConfiguration action. |
QtAws::Redshift::RedshiftRequest::CreateSnapshotCopyGrantAction | 11 | Redshift CreateSnapshotCopyGrant action. |
QtAws::Redshift::RedshiftRequest::CreateTagsAction | 12 | Redshift CreateTags action. |
QtAws::Redshift::RedshiftRequest::DeleteClusterAction | 13 | Redshift DeleteCluster action. |
QtAws::Redshift::RedshiftRequest::DeleteClusterParameterGroupAction | 14 | Redshift DeleteClusterParameterGroup action. |
QtAws::Redshift::RedshiftRequest::DeleteClusterSecurityGroupAction | 15 | Redshift DeleteClusterSecurityGroup action. |
QtAws::Redshift::RedshiftRequest::DeleteClusterSnapshotAction | 16 | Redshift DeleteClusterSnapshot action. |
QtAws::Redshift::RedshiftRequest::DeleteClusterSubnetGroupAction | 17 | Redshift DeleteClusterSubnetGroup action. |
QtAws::Redshift::RedshiftRequest::DeleteEventSubscriptionAction | 18 | Redshift DeleteEventSubscription action. |
QtAws::Redshift::RedshiftRequest::DeleteHsmClientCertificateAction | 19 | Redshift DeleteHsmClientCertificate action. |
QtAws::Redshift::RedshiftRequest::DeleteHsmConfigurationAction | 20 | Redshift DeleteHsmConfiguration action. |
QtAws::Redshift::RedshiftRequest::DeleteSnapshotCopyGrantAction | 21 | Redshift DeleteSnapshotCopyGrant action. |
QtAws::Redshift::RedshiftRequest::DeleteTagsAction | 22 | Redshift DeleteTags action. |
QtAws::Redshift::RedshiftRequest::DescribeClusterParameterGroupsAction | 23 | Redshift DescribeClusterParameterGroups action. |
QtAws::Redshift::RedshiftRequest::DescribeClusterParametersAction | 24 | Redshift DescribeClusterParameters action. |
QtAws::Redshift::RedshiftRequest::DescribeClusterSecurityGroupsAction | 25 | Redshift DescribeClusterSecurityGroups action. |
QtAws::Redshift::RedshiftRequest::DescribeClusterSnapshotsAction | 26 | Redshift DescribeClusterSnapshots action. |
QtAws::Redshift::RedshiftRequest::DescribeClusterSubnetGroupsAction | 27 | Redshift DescribeClusterSubnetGroups action. |
QtAws::Redshift::RedshiftRequest::DescribeClusterVersionsAction | 28 | Redshift DescribeClusterVersions action. |
QtAws::Redshift::RedshiftRequest::DescribeClustersAction | 29 | Redshift DescribeClusters action. |
QtAws::Redshift::RedshiftRequest::DescribeDefaultClusterParametersAction | 30 | Redshift DescribeDefaultClusterParameters action. |
QtAws::Redshift::RedshiftRequest::DescribeEventCategoriesAction | 31 | Redshift DescribeEventCategories action. |
QtAws::Redshift::RedshiftRequest::DescribeEventSubscriptionsAction | 32 | Redshift DescribeEventSubscriptions action. |
QtAws::Redshift::RedshiftRequest::DescribeEventsAction | 33 | Redshift DescribeEvents action. |
QtAws::Redshift::RedshiftRequest::DescribeHsmClientCertificatesAction | 34 | Redshift DescribeHsmClientCertificates action. |
QtAws::Redshift::RedshiftRequest::DescribeHsmConfigurationsAction | 35 | Redshift DescribeHsmConfigurations action. |
QtAws::Redshift::RedshiftRequest::DescribeLoggingStatusAction | 36 | Redshift DescribeLoggingStatus action. |
QtAws::Redshift::RedshiftRequest::DescribeOrderableClusterOptionsAction | 37 | Redshift DescribeOrderableClusterOptions action. |
QtAws::Redshift::RedshiftRequest::DescribeReservedNodeOfferingsAction | 38 | Redshift DescribeReservedNodeOfferings action. |
QtAws::Redshift::RedshiftRequest::DescribeReservedNodesAction | 39 | Redshift DescribeReservedNodes action. |
QtAws::Redshift::RedshiftRequest::DescribeResizeAction | 40 | Redshift DescribeResize action. |
QtAws::Redshift::RedshiftRequest::DescribeSnapshotCopyGrantsAction | 41 | Redshift DescribeSnapshotCopyGrants action. |
QtAws::Redshift::RedshiftRequest::DescribeTableRestoreStatusAction | 42 | Redshift DescribeTableRestoreStatus action. |
QtAws::Redshift::RedshiftRequest::DescribeTagsAction | 43 | Redshift DescribeTags action. |
QtAws::Redshift::RedshiftRequest::DisableLoggingAction | 44 | Redshift DisableLogging action. |
QtAws::Redshift::RedshiftRequest::DisableSnapshotCopyAction | 45 | Redshift DisableSnapshotCopy action. |
QtAws::Redshift::RedshiftRequest::EnableLoggingAction | 46 | Redshift EnableLogging action. |
QtAws::Redshift::RedshiftRequest::EnableSnapshotCopyAction | 47 | Redshift EnableSnapshotCopy action. |
QtAws::Redshift::RedshiftRequest::GetClusterCredentialsAction | 48 | Redshift GetClusterCredentials action. |
QtAws::Redshift::RedshiftRequest::ModifyClusterAction | 49 | Redshift ModifyCluster action. |
QtAws::Redshift::RedshiftRequest::ModifyClusterIamRolesAction | 50 | Redshift ModifyClusterIamRoles action. |
QtAws::Redshift::RedshiftRequest::ModifyClusterParameterGroupAction | 51 | Redshift ModifyClusterParameterGroup action. |
QtAws::Redshift::RedshiftRequest::ModifyClusterSubnetGroupAction | 52 | Redshift ModifyClusterSubnetGroup action. |
QtAws::Redshift::RedshiftRequest::ModifyEventSubscriptionAction | 53 | Redshift ModifyEventSubscription action. |
QtAws::Redshift::RedshiftRequest::ModifySnapshotCopyRetentionPeriodAction | 54 | Redshift ModifySnapshotCopyRetentionPeriod action. |
QtAws::Redshift::RedshiftRequest::PurchaseReservedNodeOfferingAction | 55 | Redshift PurchaseReservedNodeOffering action. |
QtAws::Redshift::RedshiftRequest::RebootClusterAction | 56 | Redshift RebootCluster action. |
QtAws::Redshift::RedshiftRequest::ResetClusterParameterGroupAction | 57 | Redshift ResetClusterParameterGroup action. |
QtAws::Redshift::RedshiftRequest::RestoreFromClusterSnapshotAction | 58 | Redshift RestoreFromClusterSnapshot action. |
QtAws::Redshift::RedshiftRequest::RestoreTableFromClusterSnapshotAction | 59 | Redshift RestoreTableFromClusterSnapshot action. |
QtAws::Redshift::RedshiftRequest::RevokeClusterSecurityGroupIngressAction | 60 | Redshift RevokeClusterSecurityGroupIngress action. |
QtAws::Redshift::RedshiftRequest::RevokeSnapshotAccessAction | 61 | Redshift RevokeSnapshotAccess action. |
QtAws::Redshift::RedshiftRequest::RotateEncryptionKeyAction | 62 | Redshift RotateEncryptionKey action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
RedshiftRequest::RedshiftRequest(const Action action)
Constructs a RedshiftRequest object for Redshift action.
RedshiftRequest::RedshiftRequest(const RedshiftRequest &other)
Constructs a copy of other.
[protected] RedshiftRequest::RedshiftRequest(RedshiftRequestPrivate * const d)
Constructs aa RedshiftRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from RedshiftRequestPrivate.
Action RedshiftRequest::action() const
Returns the Redshift action to be performed by this request.
See also setAction().
QString RedshiftRequest::actionString() const
Returns the name of the Redshift action to be performed by this request.
QString RedshiftRequest::apiVersion() const
Returns the Redshift API version implemented by this request.
See also setApiVersion().
[protected] int RedshiftRequest::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 RedshiftRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant RedshiftRequest::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 &RedshiftRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void RedshiftRequest::setAction(const Action action)
Sets the Redshift action to be performed by this request to action.
See also action().
void RedshiftRequest::setApiVersion(const QString &version)
Sets the Redshift API version to include in this request to version.
See also apiVersion().
[protected] void RedshiftRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void RedshiftRequest::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 RedshiftRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the Redshift request using the given endpoint.
This Redshift 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.
RedshiftRequest &RedshiftRequest::operator=(const RedshiftRequest &other)
Sets the RedshiftRequest object to be equal to other.
[virtual] bool RedshiftRequest::operator==(const RedshiftRequest &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.