ApplicationDiscoveryServiceRequest Class

(QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest)

The ApplicationDiscoveryServiceRequest class provides an interface for ApplicationDiscoveryService requests. More...

Public Types

enum Action { AssociateConfigurationItemsToApplicationAction, CreateApplicationAction, CreateTagsAction, DeleteApplicationsAction, ..., UpdateApplicationAction }
flags Actions

Public Functions

ApplicationDiscoveryServiceRequest(const Action action)
ApplicationDiscoveryServiceRequest(const ApplicationDiscoveryServiceRequest &other)
Action action() const
QString actionString() const
QString apiVersion() const
void setAction(const Action action)
void setApiVersion(const QString &version)
ApplicationDiscoveryServiceRequest &operator=(const ApplicationDiscoveryServiceRequest &other)
virtual bool operator==(const ApplicationDiscoveryServiceRequest &other) const

Protected Functions

ApplicationDiscoveryServiceRequest(ApplicationDiscoveryServiceRequestPrivate * 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 ApplicationDiscoveryServiceRequest class provides an interface for ApplicationDiscoveryService requests.

Member Type Documentation

enum ApplicationDiscoveryServiceRequest::Action
flags ApplicationDiscoveryServiceRequest::Actions

This enum describes the actions that can be performed as ApplicationDiscoveryService requests.

ConstantValueDescription
QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest::AssociateConfigurationItemsToApplicationAction0ApplicationDiscoveryService AssociateConfigurationItemsToApplication action.
QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest::CreateApplicationAction1ApplicationDiscoveryService CreateApplication action.
QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest::CreateTagsAction2ApplicationDiscoveryService CreateTags action.
QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest::DeleteApplicationsAction3ApplicationDiscoveryService DeleteApplications action.
QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest::DeleteTagsAction4ApplicationDiscoveryService DeleteTags action.
QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest::DescribeAgentsAction5ApplicationDiscoveryService DescribeAgents action.
QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest::DescribeConfigurationsAction6ApplicationDiscoveryService DescribeConfigurations action.
QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest::DescribeExportConfigurationsAction7ApplicationDiscoveryService DescribeExportConfigurations action.
QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest::DescribeExportTasksAction8ApplicationDiscoveryService DescribeExportTasks action.
QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest::DescribeTagsAction9ApplicationDiscoveryService DescribeTags action.
QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest::DisassociateConfigurationItemsFromApplicationAction10ApplicationDiscoveryService DisassociateConfigurationItemsFromApplication action.
QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest::ExportConfigurationsAction11ApplicationDiscoveryService ExportConfigurations action.
QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest::GetDiscoverySummaryAction12ApplicationDiscoveryService GetDiscoverySummary action.
QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest::ListConfigurationsAction13ApplicationDiscoveryService ListConfigurations action.
QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest::ListServerNeighborsAction14ApplicationDiscoveryService ListServerNeighbors action.
QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest::StartDataCollectionByAgentIdsAction15ApplicationDiscoveryService StartDataCollectionByAgentIds action.
QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest::StartExportTaskAction16ApplicationDiscoveryService StartExportTask action.
QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest::StopDataCollectionByAgentIdsAction17ApplicationDiscoveryService StopDataCollectionByAgentIds action.
QtAws::ApplicationDiscoveryService::ApplicationDiscoveryServiceRequest::UpdateApplicationAction18ApplicationDiscoveryService UpdateApplication action.

The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.

Member Function Documentation

ApplicationDiscoveryServiceRequest::ApplicationDiscoveryServiceRequest(const Action action)

Constructs a ApplicationDiscoveryServiceRequest object for ApplicationDiscoveryService action.

ApplicationDiscoveryServiceRequest::ApplicationDiscoveryServiceRequest(const ApplicationDiscoveryServiceRequest &other)

Constructs a copy of other.

[protected] ApplicationDiscoveryServiceRequest::ApplicationDiscoveryServiceRequest(ApplicationDiscoveryServiceRequestPrivate * const d)

Constructs aa ApplicationDiscoveryServiceRequest object with private implementation d.

This overload allows derived classes to provide their own private class implementation that inherits from ApplicationDiscoveryServiceRequestPrivate.

Action ApplicationDiscoveryServiceRequest::action() const

Returns the ApplicationDiscoveryService action to be performed by this request.

See also setAction().

QString ApplicationDiscoveryServiceRequest::actionString() const

Returns the name of the ApplicationDiscoveryService action to be performed by this request.

QString ApplicationDiscoveryServiceRequest::apiVersion() const

Returns the ApplicationDiscoveryService API version implemented by this request.

See also setApiVersion().

[protected] int ApplicationDiscoveryServiceRequest::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 ApplicationDiscoveryServiceRequest::clearParameters()

Removes all parameters from the request.

[protected] QVariant ApplicationDiscoveryServiceRequest::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 &ApplicationDiscoveryServiceRequest::parameters() const

Returns the parameters included in this request.

See also setParameters().

void ApplicationDiscoveryServiceRequest::setAction(const Action action)

Sets the ApplicationDiscoveryService action to be performed by this request to action.

See also action().

void ApplicationDiscoveryServiceRequest::setApiVersion(const QString &version)

Sets the ApplicationDiscoveryService API version to include in this request to version.

See also apiVersion().

[protected] void ApplicationDiscoveryServiceRequest::setParameter(const QString &name, const QVariant &value)

Sets the name parameter to value.

See also parameter().

[protected] void ApplicationDiscoveryServiceRequest::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 ApplicationDiscoveryServiceRequest::unsignedRequest(const QUrl &endpoint) const

Reimplemented from AwsAbstractRequest::unsignedRequest().

Returns a network request for the ApplicationDiscoveryService request using the given endpoint.

This ApplicationDiscoveryService 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.

ApplicationDiscoveryServiceRequest &ApplicationDiscoveryServiceRequest::operator=(const ApplicationDiscoveryServiceRequest &other)

Sets the ApplicationDiscoveryServiceRequest object to be equal to other.

[virtual] bool ApplicationDiscoveryServiceRequest::operator==(const ApplicationDiscoveryServiceRequest &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.