DirectConnectRequest Class

(QtAws::DirectConnect::DirectConnectRequest)

The DirectConnectRequest class provides an interface for DirectConnect requests. More...

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

QtAws::DirectConnect::AllocateConnectionOnInterconnectRequest, QtAws::DirectConnect::AllocateHostedConnectionRequest, QtAws::DirectConnect::AllocatePrivateVirtualInterfaceRequest, QtAws::DirectConnect::AllocatePublicVirtualInterfaceRequest, QtAws::DirectConnect::AssociateConnectionWithLagRequest, QtAws::DirectConnect::AssociateHostedConnectionRequest, QtAws::DirectConnect::AssociateVirtualInterfaceRequest, QtAws::DirectConnect::ConfirmConnectionRequest, QtAws::DirectConnect::ConfirmPrivateVirtualInterfaceRequest, QtAws::DirectConnect::ConfirmPublicVirtualInterfaceRequest, QtAws::DirectConnect::CreateBGPPeerRequest, QtAws::DirectConnect::CreateConnectionRequest, QtAws::DirectConnect::CreateDirectConnectGatewayAssociationRequest, QtAws::DirectConnect::CreateDirectConnectGatewayRequest, QtAws::DirectConnect::CreateInterconnectRequest, QtAws::DirectConnect::CreateLagRequest, QtAws::DirectConnect::CreatePrivateVirtualInterfaceRequest, QtAws::DirectConnect::CreatePublicVirtualInterfaceRequest, QtAws::DirectConnect::DeleteBGPPeerRequest, QtAws::DirectConnect::DeleteConnectionRequest, QtAws::DirectConnect::DeleteDirectConnectGatewayAssociationRequest, QtAws::DirectConnect::DeleteDirectConnectGatewayRequest, QtAws::DirectConnect::DeleteInterconnectRequest, QtAws::DirectConnect::DeleteLagRequest, QtAws::DirectConnect::DeleteVirtualInterfaceRequest, QtAws::DirectConnect::DescribeConnectionLoaRequest, QtAws::DirectConnect::DescribeConnectionsOnInterconnectRequest, QtAws::DirectConnect::DescribeConnectionsRequest, QtAws::DirectConnect::DescribeDirectConnectGatewayAssociationsRequest, QtAws::DirectConnect::DescribeDirectConnectGatewayAttachmentsRequest, QtAws::DirectConnect::DescribeDirectConnectGatewaysRequest, QtAws::DirectConnect::DescribeHostedConnectionsRequest, QtAws::DirectConnect::DescribeInterconnectLoaRequest, QtAws::DirectConnect::DescribeInterconnectsRequest, QtAws::DirectConnect::DescribeLagsRequest, QtAws::DirectConnect::DescribeLoaRequest, QtAws::DirectConnect::DescribeTagsRequest, QtAws::DirectConnect::DescribeVirtualInterfacesRequest, QtAws::DirectConnect::DisassociateConnectionFromLagRequest, QtAws::DirectConnect::TagResourceRequest, QtAws::DirectConnect::UntagResourceRequest, and QtAws::DirectConnect::UpdateLagRequest

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

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

Reimplemented Protected Functions

virtual QNetworkRequest unsignedRequest(const QUrl &endpoint) const override

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.

ConstantValueDescription
QtAws::DirectConnect::DirectConnectRequest::AllocateConnectionOnInterconnectAction0DirectConnect AllocateConnectionOnInterconnect action.
QtAws::DirectConnect::DirectConnectRequest::AllocateHostedConnectionAction1DirectConnect AllocateHostedConnection action.
QtAws::DirectConnect::DirectConnectRequest::AllocatePrivateVirtualInterfaceAction2DirectConnect AllocatePrivateVirtualInterface action.
QtAws::DirectConnect::DirectConnectRequest::AllocatePublicVirtualInterfaceAction3DirectConnect AllocatePublicVirtualInterface action.
QtAws::DirectConnect::DirectConnectRequest::AssociateConnectionWithLagAction4DirectConnect AssociateConnectionWithLag action.
QtAws::DirectConnect::DirectConnectRequest::AssociateHostedConnectionAction5DirectConnect AssociateHostedConnection action.
QtAws::DirectConnect::DirectConnectRequest::AssociateVirtualInterfaceAction6DirectConnect AssociateVirtualInterface action.
QtAws::DirectConnect::DirectConnectRequest::ConfirmConnectionAction7DirectConnect ConfirmConnection action.
QtAws::DirectConnect::DirectConnectRequest::ConfirmPrivateVirtualInterfaceAction8DirectConnect ConfirmPrivateVirtualInterface action.
QtAws::DirectConnect::DirectConnectRequest::ConfirmPublicVirtualInterfaceAction9DirectConnect ConfirmPublicVirtualInterface action.
QtAws::DirectConnect::DirectConnectRequest::CreateBGPPeerAction10DirectConnect CreateBGPPeer action.
QtAws::DirectConnect::DirectConnectRequest::CreateConnectionAction11DirectConnect CreateConnection action.
QtAws::DirectConnect::DirectConnectRequest::CreateDirectConnectGatewayAction12DirectConnect CreateDirectConnectGateway action.
QtAws::DirectConnect::DirectConnectRequest::CreateDirectConnectGatewayAssociationAction13DirectConnect CreateDirectConnectGatewayAssociation action.
QtAws::DirectConnect::DirectConnectRequest::CreateInterconnectAction14DirectConnect CreateInterconnect action.
QtAws::DirectConnect::DirectConnectRequest::CreateLagAction15DirectConnect CreateLag action.
QtAws::DirectConnect::DirectConnectRequest::CreatePrivateVirtualInterfaceAction16DirectConnect CreatePrivateVirtualInterface action.
QtAws::DirectConnect::DirectConnectRequest::CreatePublicVirtualInterfaceAction17DirectConnect CreatePublicVirtualInterface action.
QtAws::DirectConnect::DirectConnectRequest::DeleteBGPPeerAction18DirectConnect DeleteBGPPeer action.
QtAws::DirectConnect::DirectConnectRequest::DeleteConnectionAction19DirectConnect DeleteConnection action.
QtAws::DirectConnect::DirectConnectRequest::DeleteDirectConnectGatewayAction20DirectConnect DeleteDirectConnectGateway action.
QtAws::DirectConnect::DirectConnectRequest::DeleteDirectConnectGatewayAssociationAction21DirectConnect DeleteDirectConnectGatewayAssociation action.
QtAws::DirectConnect::DirectConnectRequest::DeleteInterconnectAction22DirectConnect DeleteInterconnect action.
QtAws::DirectConnect::DirectConnectRequest::DeleteLagAction23DirectConnect DeleteLag action.
QtAws::DirectConnect::DirectConnectRequest::DeleteVirtualInterfaceAction24DirectConnect DeleteVirtualInterface action.
QtAws::DirectConnect::DirectConnectRequest::DescribeConnectionLoaAction25DirectConnect DescribeConnectionLoa action.
QtAws::DirectConnect::DirectConnectRequest::DescribeConnectionsAction26DirectConnect DescribeConnections action.
QtAws::DirectConnect::DirectConnectRequest::DescribeConnectionsOnInterconnectAction27DirectConnect DescribeConnectionsOnInterconnect action.
QtAws::DirectConnect::DirectConnectRequest::DescribeDirectConnectGatewayAssociationsAction28DirectConnect DescribeDirectConnectGatewayAssociations action.
QtAws::DirectConnect::DirectConnectRequest::DescribeDirectConnectGatewayAttachmentsAction29DirectConnect DescribeDirectConnectGatewayAttachments action.
QtAws::DirectConnect::DirectConnectRequest::DescribeDirectConnectGatewaysAction30DirectConnect DescribeDirectConnectGateways action.
QtAws::DirectConnect::DirectConnectRequest::DescribeHostedConnectionsAction31DirectConnect DescribeHostedConnections action.
QtAws::DirectConnect::DirectConnectRequest::DescribeInterconnectLoaAction32DirectConnect DescribeInterconnectLoa action.
QtAws::DirectConnect::DirectConnectRequest::DescribeInterconnectsAction33DirectConnect DescribeInterconnects action.
QtAws::DirectConnect::DirectConnectRequest::DescribeLagsAction34DirectConnect DescribeLags action.
QtAws::DirectConnect::DirectConnectRequest::DescribeLoaAction35DirectConnect DescribeLoa action.
QtAws::DirectConnect::DirectConnectRequest::DescribeLocationsAction36DirectConnect DescribeLocations action.
QtAws::DirectConnect::DirectConnectRequest::DescribeTagsAction37DirectConnect DescribeTags action.
QtAws::DirectConnect::DirectConnectRequest::DescribeVirtualGatewaysAction38DirectConnect DescribeVirtualGateways action.
QtAws::DirectConnect::DirectConnectRequest::DescribeVirtualInterfacesAction39DirectConnect DescribeVirtualInterfaces action.
QtAws::DirectConnect::DirectConnectRequest::DisassociateConnectionFromLagAction40DirectConnect DisassociateConnectionFromLag action.
QtAws::DirectConnect::DirectConnectRequest::TagResourceAction41DirectConnect TagResource action.
QtAws::DirectConnect::DirectConnectRequest::UntagResourceAction42DirectConnect UntagResource action.
QtAws::DirectConnect::DirectConnectRequest::UpdateLagAction43DirectConnect 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 &parameters)

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.