ElasticBeanstalkRequest Class
(QtAws::ElasticBeanstalk::ElasticBeanstalkRequest)The ElasticBeanstalkRequest class provides an interface for ElasticBeanstalk requests. More...
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 |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
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 ¶meters) |
Reimplemented Protected Functions
| virtual QNetworkRequest | unsignedRequest(const QUrl &endpoint) const override |
- 4 protected functions inherited from QtAws::Core::AwsAbstractRequest
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.
| Constant | Value | Description |
|---|---|---|
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::AbortEnvironmentUpdateAction | 0 | ElasticBeanstalk AbortEnvironmentUpdate action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::ApplyEnvironmentManagedActionAction | 1 | ElasticBeanstalk ApplyEnvironmentManagedAction action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::CheckDNSAvailabilityAction | 2 | ElasticBeanstalk CheckDNSAvailability action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::ComposeEnvironmentsAction | 3 | ElasticBeanstalk ComposeEnvironments action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::CreateApplicationAction | 4 | ElasticBeanstalk CreateApplication action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::CreateApplicationVersionAction | 5 | ElasticBeanstalk CreateApplicationVersion action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::CreateConfigurationTemplateAction | 6 | ElasticBeanstalk CreateConfigurationTemplate action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::CreateEnvironmentAction | 7 | ElasticBeanstalk CreateEnvironment action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::CreatePlatformVersionAction | 8 | ElasticBeanstalk CreatePlatformVersion action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::CreateStorageLocationAction | 9 | ElasticBeanstalk CreateStorageLocation action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DeleteApplicationAction | 10 | ElasticBeanstalk DeleteApplication action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DeleteApplicationVersionAction | 11 | ElasticBeanstalk DeleteApplicationVersion action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DeleteConfigurationTemplateAction | 12 | ElasticBeanstalk DeleteConfigurationTemplate action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DeleteEnvironmentConfigurationAction | 13 | ElasticBeanstalk DeleteEnvironmentConfiguration action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DeletePlatformVersionAction | 14 | ElasticBeanstalk DeletePlatformVersion action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeAccountAttributesAction | 15 | ElasticBeanstalk DescribeAccountAttributes action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeApplicationVersionsAction | 16 | ElasticBeanstalk DescribeApplicationVersions action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeApplicationsAction | 17 | ElasticBeanstalk DescribeApplications action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeConfigurationOptionsAction | 18 | ElasticBeanstalk DescribeConfigurationOptions action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeConfigurationSettingsAction | 19 | ElasticBeanstalk DescribeConfigurationSettings action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeEnvironmentHealthAction | 20 | ElasticBeanstalk DescribeEnvironmentHealth action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeEnvironmentManagedActionHistoryAction | 21 | ElasticBeanstalk DescribeEnvironmentManagedActionHistory action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeEnvironmentManagedActionsAction | 22 | ElasticBeanstalk DescribeEnvironmentManagedActions action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeEnvironmentResourcesAction | 23 | ElasticBeanstalk DescribeEnvironmentResources action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeEnvironmentsAction | 24 | ElasticBeanstalk DescribeEnvironments action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeEventsAction | 25 | ElasticBeanstalk DescribeEvents action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribeInstancesHealthAction | 26 | ElasticBeanstalk DescribeInstancesHealth action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::DescribePlatformVersionAction | 27 | ElasticBeanstalk DescribePlatformVersion action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::ListAvailableSolutionStacksAction | 28 | ElasticBeanstalk ListAvailableSolutionStacks action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::ListPlatformVersionsAction | 29 | ElasticBeanstalk ListPlatformVersions action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::ListTagsForResourceAction | 30 | ElasticBeanstalk ListTagsForResource action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::RebuildEnvironmentAction | 31 | ElasticBeanstalk RebuildEnvironment action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::RequestEnvironmentInfoAction | 32 | ElasticBeanstalk RequestEnvironmentInfo action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::RestartAppServerAction | 33 | ElasticBeanstalk RestartAppServer action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::RetrieveEnvironmentInfoAction | 34 | ElasticBeanstalk RetrieveEnvironmentInfo action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::SwapEnvironmentCNAMEsAction | 35 | ElasticBeanstalk SwapEnvironmentCNAMEs action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::TerminateEnvironmentAction | 36 | ElasticBeanstalk TerminateEnvironment action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::UpdateApplicationAction | 37 | ElasticBeanstalk UpdateApplication action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::UpdateApplicationResourceLifecycleAction | 38 | ElasticBeanstalk UpdateApplicationResourceLifecycle action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::UpdateApplicationVersionAction | 39 | ElasticBeanstalk UpdateApplicationVersion action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::UpdateConfigurationTemplateAction | 40 | ElasticBeanstalk UpdateConfigurationTemplate action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::UpdateEnvironmentAction | 41 | ElasticBeanstalk UpdateEnvironment action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::UpdateTagsForResourceAction | 42 | ElasticBeanstalk UpdateTagsForResource action. |
QtAws::ElasticBeanstalk::ElasticBeanstalkRequest::ValidateConfigurationSettingsAction | 43 | ElasticBeanstalk 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 ¶meters)
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.