DirectConnectRequest Class
(QtAws::DirectConnect::DirectConnectRequest)The DirectConnectRequest class provides an interface for DirectConnect requests. More...
Public Types
| enum | Action { AllocateConnectionOnInterconnectAction, AllocateHostedConnectionAction, AllocatePrivateVirtualInterfaceAction, AllocatePublicVirtualInterfaceAction, ..., UpdateLagAction } |
| flags | Actions |
Public Functions
| DirectConnectRequest(const Action action) | |
| DirectConnectRequest(const DirectConnectRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| DirectConnectRequest & | operator=(const DirectConnectRequest &other) |
| virtual bool | operator==(const DirectConnectRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| DirectConnectRequest(DirectConnectRequestPrivate * 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 DirectConnectRequest class provides an interface for DirectConnect requests.
Member Type Documentation
enum DirectConnectRequest::Action
flags DirectConnectRequest::Actions
This enum describes the actions that can be performed as DirectConnect requests.
| Constant | Value | Description |
|---|---|---|
QtAws::DirectConnect::DirectConnectRequest::AllocateConnectionOnInterconnectAction | 0 | DirectConnect AllocateConnectionOnInterconnect action. |
QtAws::DirectConnect::DirectConnectRequest::AllocateHostedConnectionAction | 1 | DirectConnect AllocateHostedConnection action. |
QtAws::DirectConnect::DirectConnectRequest::AllocatePrivateVirtualInterfaceAction | 2 | DirectConnect AllocatePrivateVirtualInterface action. |
QtAws::DirectConnect::DirectConnectRequest::AllocatePublicVirtualInterfaceAction | 3 | DirectConnect AllocatePublicVirtualInterface action. |
QtAws::DirectConnect::DirectConnectRequest::AssociateConnectionWithLagAction | 4 | DirectConnect AssociateConnectionWithLag action. |
QtAws::DirectConnect::DirectConnectRequest::AssociateHostedConnectionAction | 5 | DirectConnect AssociateHostedConnection action. |
QtAws::DirectConnect::DirectConnectRequest::AssociateVirtualInterfaceAction | 6 | DirectConnect AssociateVirtualInterface action. |
QtAws::DirectConnect::DirectConnectRequest::ConfirmConnectionAction | 7 | DirectConnect ConfirmConnection action. |
QtAws::DirectConnect::DirectConnectRequest::ConfirmPrivateVirtualInterfaceAction | 8 | DirectConnect ConfirmPrivateVirtualInterface action. |
QtAws::DirectConnect::DirectConnectRequest::ConfirmPublicVirtualInterfaceAction | 9 | DirectConnect ConfirmPublicVirtualInterface action. |
QtAws::DirectConnect::DirectConnectRequest::CreateBGPPeerAction | 10 | DirectConnect CreateBGPPeer action. |
QtAws::DirectConnect::DirectConnectRequest::CreateConnectionAction | 11 | DirectConnect CreateConnection action. |
QtAws::DirectConnect::DirectConnectRequest::CreateDirectConnectGatewayAction | 12 | DirectConnect CreateDirectConnectGateway action. |
QtAws::DirectConnect::DirectConnectRequest::CreateDirectConnectGatewayAssociationAction | 13 | DirectConnect CreateDirectConnectGatewayAssociation action. |
QtAws::DirectConnect::DirectConnectRequest::CreateInterconnectAction | 14 | DirectConnect CreateInterconnect action. |
QtAws::DirectConnect::DirectConnectRequest::CreateLagAction | 15 | DirectConnect CreateLag action. |
QtAws::DirectConnect::DirectConnectRequest::CreatePrivateVirtualInterfaceAction | 16 | DirectConnect CreatePrivateVirtualInterface action. |
QtAws::DirectConnect::DirectConnectRequest::CreatePublicVirtualInterfaceAction | 17 | DirectConnect CreatePublicVirtualInterface action. |
QtAws::DirectConnect::DirectConnectRequest::DeleteBGPPeerAction | 18 | DirectConnect DeleteBGPPeer action. |
QtAws::DirectConnect::DirectConnectRequest::DeleteConnectionAction | 19 | DirectConnect DeleteConnection action. |
QtAws::DirectConnect::DirectConnectRequest::DeleteDirectConnectGatewayAction | 20 | DirectConnect DeleteDirectConnectGateway action. |
QtAws::DirectConnect::DirectConnectRequest::DeleteDirectConnectGatewayAssociationAction | 21 | DirectConnect DeleteDirectConnectGatewayAssociation action. |
QtAws::DirectConnect::DirectConnectRequest::DeleteInterconnectAction | 22 | DirectConnect DeleteInterconnect action. |
QtAws::DirectConnect::DirectConnectRequest::DeleteLagAction | 23 | DirectConnect DeleteLag action. |
QtAws::DirectConnect::DirectConnectRequest::DeleteVirtualInterfaceAction | 24 | DirectConnect DeleteVirtualInterface action. |
QtAws::DirectConnect::DirectConnectRequest::DescribeConnectionLoaAction | 25 | DirectConnect DescribeConnectionLoa action. |
QtAws::DirectConnect::DirectConnectRequest::DescribeConnectionsAction | 26 | DirectConnect DescribeConnections action. |
QtAws::DirectConnect::DirectConnectRequest::DescribeConnectionsOnInterconnectAction | 27 | DirectConnect DescribeConnectionsOnInterconnect action. |
QtAws::DirectConnect::DirectConnectRequest::DescribeDirectConnectGatewayAssociationsAction | 28 | DirectConnect DescribeDirectConnectGatewayAssociations action. |
QtAws::DirectConnect::DirectConnectRequest::DescribeDirectConnectGatewayAttachmentsAction | 29 | DirectConnect DescribeDirectConnectGatewayAttachments action. |
QtAws::DirectConnect::DirectConnectRequest::DescribeDirectConnectGatewaysAction | 30 | DirectConnect DescribeDirectConnectGateways action. |
QtAws::DirectConnect::DirectConnectRequest::DescribeHostedConnectionsAction | 31 | DirectConnect DescribeHostedConnections action. |
QtAws::DirectConnect::DirectConnectRequest::DescribeInterconnectLoaAction | 32 | DirectConnect DescribeInterconnectLoa action. |
QtAws::DirectConnect::DirectConnectRequest::DescribeInterconnectsAction | 33 | DirectConnect DescribeInterconnects action. |
QtAws::DirectConnect::DirectConnectRequest::DescribeLagsAction | 34 | DirectConnect DescribeLags action. |
QtAws::DirectConnect::DirectConnectRequest::DescribeLoaAction | 35 | DirectConnect DescribeLoa action. |
QtAws::DirectConnect::DirectConnectRequest::DescribeLocationsAction | 36 | DirectConnect DescribeLocations action. |
QtAws::DirectConnect::DirectConnectRequest::DescribeTagsAction | 37 | DirectConnect DescribeTags action. |
QtAws::DirectConnect::DirectConnectRequest::DescribeVirtualGatewaysAction | 38 | DirectConnect DescribeVirtualGateways action. |
QtAws::DirectConnect::DirectConnectRequest::DescribeVirtualInterfacesAction | 39 | DirectConnect DescribeVirtualInterfaces action. |
QtAws::DirectConnect::DirectConnectRequest::DisassociateConnectionFromLagAction | 40 | DirectConnect DisassociateConnectionFromLag action. |
QtAws::DirectConnect::DirectConnectRequest::TagResourceAction | 41 | DirectConnect TagResource action. |
QtAws::DirectConnect::DirectConnectRequest::UntagResourceAction | 42 | DirectConnect UntagResource action. |
QtAws::DirectConnect::DirectConnectRequest::UpdateLagAction | 43 | DirectConnect UpdateLag action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
DirectConnectRequest::DirectConnectRequest(const Action action)
Constructs a DirectConnectRequest object for DirectConnect action.
DirectConnectRequest::DirectConnectRequest(const DirectConnectRequest &other)
Constructs a copy of other.
[protected] DirectConnectRequest::DirectConnectRequest(DirectConnectRequestPrivate * const d)
Constructs aa DirectConnectRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from DirectConnectRequestPrivate.
Action DirectConnectRequest::action() const
Returns the DirectConnect action to be performed by this request.
See also setAction().
QString DirectConnectRequest::actionString() const
Returns the name of the DirectConnect action to be performed by this request.
QString DirectConnectRequest::apiVersion() const
Returns the DirectConnect API version implemented by this request.
See also setApiVersion().
[protected] int DirectConnectRequest::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 DirectConnectRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant DirectConnectRequest::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 &DirectConnectRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void DirectConnectRequest::setAction(const Action action)
Sets the DirectConnect action to be performed by this request to action.
See also action().
void DirectConnectRequest::setApiVersion(const QString &version)
Sets the DirectConnect API version to include in this request to version.
See also apiVersion().
[protected] void DirectConnectRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void DirectConnectRequest::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 DirectConnectRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the DirectConnect request using the given endpoint.
This DirectConnect 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.
DirectConnectRequest &DirectConnectRequest::operator=(const DirectConnectRequest &other)
Sets the DirectConnectRequest object to be equal to other.
[virtual] bool DirectConnectRequest::operator==(const DirectConnectRequest &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.