ElasticBeanstalkRequest Class

(QtAws::ElasticBeanstalk::ElasticBeanstalkRequest)

The ElasticBeanstalkRequest class provides an interface for ElasticBeanstalk requests. More...

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

QtAws::ElasticBeanstalk::AbortEnvironmentUpdateRequest, QtAws::ElasticBeanstalk::ApplyEnvironmentManagedActionRequest, QtAws::ElasticBeanstalk::CheckDNSAvailabilityRequest, QtAws::ElasticBeanstalk::ComposeEnvironmentsRequest, QtAws::ElasticBeanstalk::CreateApplicationRequest, QtAws::ElasticBeanstalk::CreateApplicationVersionRequest, QtAws::ElasticBeanstalk::CreateConfigurationTemplateRequest, QtAws::ElasticBeanstalk::CreateEnvironmentRequest, QtAws::ElasticBeanstalk::CreatePlatformVersionRequest, QtAws::ElasticBeanstalk::DeleteApplicationRequest, QtAws::ElasticBeanstalk::DeleteApplicationVersionRequest, QtAws::ElasticBeanstalk::DeleteConfigurationTemplateRequest, QtAws::ElasticBeanstalk::DeleteEnvironmentConfigurationRequest, QtAws::ElasticBeanstalk::DeletePlatformVersionRequest, QtAws::ElasticBeanstalk::DescribeApplicationsRequest, QtAws::ElasticBeanstalk::DescribeApplicationVersionsRequest, QtAws::ElasticBeanstalk::DescribeConfigurationOptionsRequest, QtAws::ElasticBeanstalk::DescribeConfigurationSettingsRequest, QtAws::ElasticBeanstalk::DescribeEnvironmentHealthRequest, QtAws::ElasticBeanstalk::DescribeEnvironmentManagedActionHistoryRequest, QtAws::ElasticBeanstalk::DescribeEnvironmentManagedActionsRequest, QtAws::ElasticBeanstalk::DescribeEnvironmentResourcesRequest, QtAws::ElasticBeanstalk::DescribeEnvironmentsRequest, QtAws::ElasticBeanstalk::DescribeEventsRequest, QtAws::ElasticBeanstalk::DescribeInstancesHealthRequest, QtAws::ElasticBeanstalk::DescribePlatformVersionRequest, QtAws::ElasticBeanstalk::ListPlatformVersionsRequest, QtAws::ElasticBeanstalk::ListTagsForResourceRequest, QtAws::ElasticBeanstalk::RebuildEnvironmentRequest, QtAws::ElasticBeanstalk::RequestEnvironmentInfoRequest, QtAws::ElasticBeanstalk::RestartAppServerRequest, QtAws::ElasticBeanstalk::RetrieveEnvironmentInfoRequest, QtAws::ElasticBeanstalk::SwapEnvironmentCNAMEsRequest, QtAws::ElasticBeanstalk::TerminateEnvironmentRequest, QtAws::ElasticBeanstalk::UpdateApplicationRequest, QtAws::ElasticBeanstalk::UpdateApplicationResourceLifecycleRequest, QtAws::ElasticBeanstalk::UpdateApplicationVersionRequest, QtAws::ElasticBeanstalk::UpdateConfigurationTemplateRequest, QtAws::ElasticBeanstalk::UpdateEnvironmentRequest, QtAws::ElasticBeanstalk::UpdateTagsForResourceRequest, and QtAws::ElasticBeanstalk::ValidateConfigurationSettingsRequest

Public Types

enum Action { AbortEnvironmentUpdateAction, ApplyEnvironmentManagedActionAction, CheckDNSAvailabilityAction, ComposeEnvironmentsAction, ..., ValidateConfigurationSettingsAction }
flags Actions

Public Functions

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

Protected Functions

ElasticBeanstalkRequest(ElasticBeanstalkRequestPrivate * 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 ElasticBeanstalkRequest class provides an interface for ElasticBeanstalk requests.

Member Type Documentation

enum ElasticBeanstalkRequest::Action
flags ElasticBeanstalkRequest::Actions

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

ConstantValueDescription
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::AbortEnvironmentUpdateAction0ElasticBeanstalk AbortEnvironmentUpdate action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::ApplyEnvironmentManagedActionAction1ElasticBeanstalk ApplyEnvironmentManagedAction action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::CheckDNSAvailabilityAction2ElasticBeanstalk CheckDNSAvailability action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::ComposeEnvironmentsAction3ElasticBeanstalk ComposeEnvironments action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::CreateApplicationAction4ElasticBeanstalk CreateApplication action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::CreateApplicationVersionAction5ElasticBeanstalk CreateApplicationVersion action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::CreateConfigurationTemplateAction6ElasticBeanstalk CreateConfigurationTemplate action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::CreateEnvironmentAction7ElasticBeanstalk CreateEnvironment action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::CreatePlatformVersionAction8ElasticBeanstalk CreatePlatformVersion action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::CreateStorageLocationAction9ElasticBeanstalk CreateStorageLocation action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DeleteApplicationAction10ElasticBeanstalk DeleteApplication action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DeleteApplicationVersionAction11ElasticBeanstalk DeleteApplicationVersion action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DeleteConfigurationTemplateAction12ElasticBeanstalk DeleteConfigurationTemplate action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DeleteEnvironmentConfigurationAction13ElasticBeanstalk DeleteEnvironmentConfiguration action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DeletePlatformVersionAction14ElasticBeanstalk DeletePlatformVersion action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeAccountAttributesAction15ElasticBeanstalk DescribeAccountAttributes action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeApplicationVersionsAction16ElasticBeanstalk DescribeApplicationVersions action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeApplicationsAction17ElasticBeanstalk DescribeApplications action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeConfigurationOptionsAction18ElasticBeanstalk DescribeConfigurationOptions action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeConfigurationSettingsAction19ElasticBeanstalk DescribeConfigurationSettings action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeEnvironmentHealthAction20ElasticBeanstalk DescribeEnvironmentHealth action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeEnvironmentManagedActionHistoryAction21ElasticBeanstalk DescribeEnvironmentManagedActionHistory action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeEnvironmentManagedActionsAction22ElasticBeanstalk DescribeEnvironmentManagedActions action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeEnvironmentResourcesAction23ElasticBeanstalk DescribeEnvironmentResources action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeEnvironmentsAction24ElasticBeanstalk DescribeEnvironments action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeEventsAction25ElasticBeanstalk DescribeEvents action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeInstancesHealthAction26ElasticBeanstalk DescribeInstancesHealth action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribePlatformVersionAction27ElasticBeanstalk DescribePlatformVersion action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::ListAvailableSolutionStacksAction28ElasticBeanstalk ListAvailableSolutionStacks action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::ListPlatformVersionsAction29ElasticBeanstalk ListPlatformVersions action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::ListTagsForResourceAction30ElasticBeanstalk ListTagsForResource action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::RebuildEnvironmentAction31ElasticBeanstalk RebuildEnvironment action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::RequestEnvironmentInfoAction32ElasticBeanstalk RequestEnvironmentInfo action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::RestartAppServerAction33ElasticBeanstalk RestartAppServer action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::RetrieveEnvironmentInfoAction34ElasticBeanstalk RetrieveEnvironmentInfo action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::SwapEnvironmentCNAMEsAction35ElasticBeanstalk SwapEnvironmentCNAMEs action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::TerminateEnvironmentAction36ElasticBeanstalk TerminateEnvironment action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::UpdateApplicationAction37ElasticBeanstalk UpdateApplication action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::UpdateApplicationResourceLifecycleAction38ElasticBeanstalk UpdateApplicationResourceLifecycle action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::UpdateApplicationVersionAction39ElasticBeanstalk UpdateApplicationVersion action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::UpdateConfigurationTemplateAction40ElasticBeanstalk UpdateConfigurationTemplate action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::UpdateEnvironmentAction41ElasticBeanstalk UpdateEnvironment action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::UpdateTagsForResourceAction42ElasticBeanstalk UpdateTagsForResource action.
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::ValidateConfigurationSettingsAction43ElasticBeanstalk ValidateConfigurationSettings action.

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

Member Function Documentation

ElasticBeanstalkRequest::ElasticBeanstalkRequest(const Action action)

Constructs a ElasticBeanstalkRequest object for ElasticBeanstalk action.

ElasticBeanstalkRequest::ElasticBeanstalkRequest(const ElasticBeanstalkRequest &other)

Constructs a copy of other.

[protected] ElasticBeanstalkRequest::ElasticBeanstalkRequest(ElasticBeanstalkRequestPrivate * const d)

Constructs aa ElasticBeanstalkRequest object with private implementation d.

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

Action ElasticBeanstalkRequest::action() const

Returns the ElasticBeanstalk action to be performed by this request.

See also setAction().

QString ElasticBeanstalkRequest::actionString() const

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

QString ElasticBeanstalkRequest::apiVersion() const

Returns the ElasticBeanstalk API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void ElasticBeanstalkRequest::setAction(const Action action)

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

See also action().

void ElasticBeanstalkRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the ElasticBeanstalkRequest object to be equal to other.

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