RedshiftRequest Class

(QtAws::Redshift::RedshiftRequest)

The RedshiftRequest class provides an interface for Redshift requests. More...

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

QtAws::Redshift::AuthorizeClusterSecurityGroupIngressRequest, QtAws::Redshift::AuthorizeSnapshotAccessRequest, QtAws::Redshift::CopyClusterSnapshotRequest, QtAws::Redshift::CreateClusterParameterGroupRequest, QtAws::Redshift::CreateClusterRequest, QtAws::Redshift::CreateClusterSecurityGroupRequest, QtAws::Redshift::CreateClusterSnapshotRequest, QtAws::Redshift::CreateClusterSubnetGroupRequest, QtAws::Redshift::CreateEventSubscriptionRequest, QtAws::Redshift::CreateHsmClientCertificateRequest, QtAws::Redshift::CreateHsmConfigurationRequest, QtAws::Redshift::CreateSnapshotCopyGrantRequest, QtAws::Redshift::CreateTagsRequest, QtAws::Redshift::DeleteClusterParameterGroupRequest, QtAws::Redshift::DeleteClusterRequest, QtAws::Redshift::DeleteClusterSecurityGroupRequest, QtAws::Redshift::DeleteClusterSnapshotRequest, QtAws::Redshift::DeleteClusterSubnetGroupRequest, QtAws::Redshift::DeleteEventSubscriptionRequest, QtAws::Redshift::DeleteHsmClientCertificateRequest, QtAws::Redshift::DeleteHsmConfigurationRequest, QtAws::Redshift::DeleteSnapshotCopyGrantRequest, QtAws::Redshift::DeleteTagsRequest, QtAws::Redshift::DescribeClusterParameterGroupsRequest, QtAws::Redshift::DescribeClusterParametersRequest, QtAws::Redshift::DescribeClusterSecurityGroupsRequest, QtAws::Redshift::DescribeClusterSnapshotsRequest, QtAws::Redshift::DescribeClustersRequest, QtAws::Redshift::DescribeClusterSubnetGroupsRequest, QtAws::Redshift::DescribeClusterVersionsRequest, QtAws::Redshift::DescribeDefaultClusterParametersRequest, QtAws::Redshift::DescribeEventCategoriesRequest, QtAws::Redshift::DescribeEventsRequest, QtAws::Redshift::DescribeEventSubscriptionsRequest, QtAws::Redshift::DescribeHsmClientCertificatesRequest, QtAws::Redshift::DescribeHsmConfigurationsRequest, QtAws::Redshift::DescribeLoggingStatusRequest, QtAws::Redshift::DescribeOrderableClusterOptionsRequest, QtAws::Redshift::DescribeReservedNodeOfferingsRequest, QtAws::Redshift::DescribeReservedNodesRequest, QtAws::Redshift::DescribeResizeRequest, QtAws::Redshift::DescribeSnapshotCopyGrantsRequest, QtAws::Redshift::DescribeTableRestoreStatusRequest, QtAws::Redshift::DescribeTagsRequest, QtAws::Redshift::DisableLoggingRequest, QtAws::Redshift::DisableSnapshotCopyRequest, QtAws::Redshift::EnableLoggingRequest, QtAws::Redshift::EnableSnapshotCopyRequest, QtAws::Redshift::GetClusterCredentialsRequest, QtAws::Redshift::ModifyClusterIamRolesRequest, QtAws::Redshift::ModifyClusterParameterGroupRequest, QtAws::Redshift::ModifyClusterRequest, QtAws::Redshift::ModifyClusterSubnetGroupRequest, QtAws::Redshift::ModifyEventSubscriptionRequest, QtAws::Redshift::ModifySnapshotCopyRetentionPeriodRequest, QtAws::Redshift::PurchaseReservedNodeOfferingRequest, QtAws::Redshift::RebootClusterRequest, QtAws::Redshift::ResetClusterParameterGroupRequest, QtAws::Redshift::RestoreFromClusterSnapshotRequest, QtAws::Redshift::RestoreTableFromClusterSnapshotRequest, QtAws::Redshift::RevokeClusterSecurityGroupIngressRequest, QtAws::Redshift::RevokeSnapshotAccessRequest, and QtAws::Redshift::RotateEncryptionKeyRequest

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

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

Reimplemented Protected Functions

virtual QNetworkRequest unsignedRequest(const QUrl &endpoint) const override

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.

ConstantValueDescription
QtAws::Redshift::RedshiftRequest::AuthorizeClusterSecurityGroupIngressAction0Redshift AuthorizeClusterSecurityGroupIngress action.
QtAws::Redshift::RedshiftRequest::AuthorizeSnapshotAccessAction1Redshift AuthorizeSnapshotAccess action.
QtAws::Redshift::RedshiftRequest::CopyClusterSnapshotAction2Redshift CopyClusterSnapshot action.
QtAws::Redshift::RedshiftRequest::CreateClusterAction3Redshift CreateCluster action.
QtAws::Redshift::RedshiftRequest::CreateClusterParameterGroupAction4Redshift CreateClusterParameterGroup action.
QtAws::Redshift::RedshiftRequest::CreateClusterSecurityGroupAction5Redshift CreateClusterSecurityGroup action.
QtAws::Redshift::RedshiftRequest::CreateClusterSnapshotAction6Redshift CreateClusterSnapshot action.
QtAws::Redshift::RedshiftRequest::CreateClusterSubnetGroupAction7Redshift CreateClusterSubnetGroup action.
QtAws::Redshift::RedshiftRequest::CreateEventSubscriptionAction8Redshift CreateEventSubscription action.
QtAws::Redshift::RedshiftRequest::CreateHsmClientCertificateAction9Redshift CreateHsmClientCertificate action.
QtAws::Redshift::RedshiftRequest::CreateHsmConfigurationAction10Redshift CreateHsmConfiguration action.
QtAws::Redshift::RedshiftRequest::CreateSnapshotCopyGrantAction11Redshift CreateSnapshotCopyGrant action.
QtAws::Redshift::RedshiftRequest::CreateTagsAction12Redshift CreateTags action.
QtAws::Redshift::RedshiftRequest::DeleteClusterAction13Redshift DeleteCluster action.
QtAws::Redshift::RedshiftRequest::DeleteClusterParameterGroupAction14Redshift DeleteClusterParameterGroup action.
QtAws::Redshift::RedshiftRequest::DeleteClusterSecurityGroupAction15Redshift DeleteClusterSecurityGroup action.
QtAws::Redshift::RedshiftRequest::DeleteClusterSnapshotAction16Redshift DeleteClusterSnapshot action.
QtAws::Redshift::RedshiftRequest::DeleteClusterSubnetGroupAction17Redshift DeleteClusterSubnetGroup action.
QtAws::Redshift::RedshiftRequest::DeleteEventSubscriptionAction18Redshift DeleteEventSubscription action.
QtAws::Redshift::RedshiftRequest::DeleteHsmClientCertificateAction19Redshift DeleteHsmClientCertificate action.
QtAws::Redshift::RedshiftRequest::DeleteHsmConfigurationAction20Redshift DeleteHsmConfiguration action.
QtAws::Redshift::RedshiftRequest::DeleteSnapshotCopyGrantAction21Redshift DeleteSnapshotCopyGrant action.
QtAws::Redshift::RedshiftRequest::DeleteTagsAction22Redshift DeleteTags action.
QtAws::Redshift::RedshiftRequest::DescribeClusterParameterGroupsAction23Redshift DescribeClusterParameterGroups action.
QtAws::Redshift::RedshiftRequest::DescribeClusterParametersAction24Redshift DescribeClusterParameters action.
QtAws::Redshift::RedshiftRequest::DescribeClusterSecurityGroupsAction25Redshift DescribeClusterSecurityGroups action.
QtAws::Redshift::RedshiftRequest::DescribeClusterSnapshotsAction26Redshift DescribeClusterSnapshots action.
QtAws::Redshift::RedshiftRequest::DescribeClusterSubnetGroupsAction27Redshift DescribeClusterSubnetGroups action.
QtAws::Redshift::RedshiftRequest::DescribeClusterVersionsAction28Redshift DescribeClusterVersions action.
QtAws::Redshift::RedshiftRequest::DescribeClustersAction29Redshift DescribeClusters action.
QtAws::Redshift::RedshiftRequest::DescribeDefaultClusterParametersAction30Redshift DescribeDefaultClusterParameters action.
QtAws::Redshift::RedshiftRequest::DescribeEventCategoriesAction31Redshift DescribeEventCategories action.
QtAws::Redshift::RedshiftRequest::DescribeEventSubscriptionsAction32Redshift DescribeEventSubscriptions action.
QtAws::Redshift::RedshiftRequest::DescribeEventsAction33Redshift DescribeEvents action.
QtAws::Redshift::RedshiftRequest::DescribeHsmClientCertificatesAction34Redshift DescribeHsmClientCertificates action.
QtAws::Redshift::RedshiftRequest::DescribeHsmConfigurationsAction35Redshift DescribeHsmConfigurations action.
QtAws::Redshift::RedshiftRequest::DescribeLoggingStatusAction36Redshift DescribeLoggingStatus action.
QtAws::Redshift::RedshiftRequest::DescribeOrderableClusterOptionsAction37Redshift DescribeOrderableClusterOptions action.
QtAws::Redshift::RedshiftRequest::DescribeReservedNodeOfferingsAction38Redshift DescribeReservedNodeOfferings action.
QtAws::Redshift::RedshiftRequest::DescribeReservedNodesAction39Redshift DescribeReservedNodes action.
QtAws::Redshift::RedshiftRequest::DescribeResizeAction40Redshift DescribeResize action.
QtAws::Redshift::RedshiftRequest::DescribeSnapshotCopyGrantsAction41Redshift DescribeSnapshotCopyGrants action.
QtAws::Redshift::RedshiftRequest::DescribeTableRestoreStatusAction42Redshift DescribeTableRestoreStatus action.
QtAws::Redshift::RedshiftRequest::DescribeTagsAction43Redshift DescribeTags action.
QtAws::Redshift::RedshiftRequest::DisableLoggingAction44Redshift DisableLogging action.
QtAws::Redshift::RedshiftRequest::DisableSnapshotCopyAction45Redshift DisableSnapshotCopy action.
QtAws::Redshift::RedshiftRequest::EnableLoggingAction46Redshift EnableLogging action.
QtAws::Redshift::RedshiftRequest::EnableSnapshotCopyAction47Redshift EnableSnapshotCopy action.
QtAws::Redshift::RedshiftRequest::GetClusterCredentialsAction48Redshift GetClusterCredentials action.
QtAws::Redshift::RedshiftRequest::ModifyClusterAction49Redshift ModifyCluster action.
QtAws::Redshift::RedshiftRequest::ModifyClusterIamRolesAction50Redshift ModifyClusterIamRoles action.
QtAws::Redshift::RedshiftRequest::ModifyClusterParameterGroupAction51Redshift ModifyClusterParameterGroup action.
QtAws::Redshift::RedshiftRequest::ModifyClusterSubnetGroupAction52Redshift ModifyClusterSubnetGroup action.
QtAws::Redshift::RedshiftRequest::ModifyEventSubscriptionAction53Redshift ModifyEventSubscription action.
QtAws::Redshift::RedshiftRequest::ModifySnapshotCopyRetentionPeriodAction54Redshift ModifySnapshotCopyRetentionPeriod action.
QtAws::Redshift::RedshiftRequest::PurchaseReservedNodeOfferingAction55Redshift PurchaseReservedNodeOffering action.
QtAws::Redshift::RedshiftRequest::RebootClusterAction56Redshift RebootCluster action.
QtAws::Redshift::RedshiftRequest::ResetClusterParameterGroupAction57Redshift ResetClusterParameterGroup action.
QtAws::Redshift::RedshiftRequest::RestoreFromClusterSnapshotAction58Redshift RestoreFromClusterSnapshot action.
QtAws::Redshift::RedshiftRequest::RestoreTableFromClusterSnapshotAction59Redshift RestoreTableFromClusterSnapshot action.
QtAws::Redshift::RedshiftRequest::RevokeClusterSecurityGroupIngressAction60Redshift RevokeClusterSecurityGroupIngress action.
QtAws::Redshift::RedshiftRequest::RevokeSnapshotAccessAction61Redshift RevokeSnapshotAccess action.
QtAws::Redshift::RedshiftRequest::RotateEncryptionKeyAction62Redshift 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 &parameters)

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.