CodeDeployRequest Class
(QtAws::CodeDeploy::CodeDeployRequest)The CodeDeployRequest class provides an interface for CodeDeploy requests. More...
Public Types
| enum | Action { AddTagsToOnPremisesInstancesAction, BatchGetApplicationRevisionsAction, BatchGetApplicationsAction, BatchGetDeploymentGroupsAction, ..., UpdateDeploymentGroupAction } |
| flags | Actions |
Public Functions
| CodeDeployRequest(const Action action) | |
| CodeDeployRequest(const CodeDeployRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| CodeDeployRequest & | operator=(const CodeDeployRequest &other) |
| virtual bool | operator==(const CodeDeployRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| CodeDeployRequest(CodeDeployRequestPrivate * 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 CodeDeployRequest class provides an interface for CodeDeploy requests.
Member Type Documentation
enum CodeDeployRequest::Action
flags CodeDeployRequest::Actions
This enum describes the actions that can be performed as CodeDeploy requests.
| Constant | Value | Description |
|---|---|---|
QtAws::CodeDeploy::CodeDeployRequest::AddTagsToOnPremisesInstancesAction | 0 | CodeDeploy AddTagsToOnPremisesInstances action. |
QtAws::CodeDeploy::CodeDeployRequest::BatchGetApplicationRevisionsAction | 1 | CodeDeploy BatchGetApplicationRevisions action. |
QtAws::CodeDeploy::CodeDeployRequest::BatchGetApplicationsAction | 2 | CodeDeploy BatchGetApplications action. |
QtAws::CodeDeploy::CodeDeployRequest::BatchGetDeploymentGroupsAction | 3 | CodeDeploy BatchGetDeploymentGroups action. |
QtAws::CodeDeploy::CodeDeployRequest::BatchGetDeploymentInstancesAction | 4 | CodeDeploy BatchGetDeploymentInstances action. |
QtAws::CodeDeploy::CodeDeployRequest::BatchGetDeploymentsAction | 5 | CodeDeploy BatchGetDeployments action. |
QtAws::CodeDeploy::CodeDeployRequest::BatchGetOnPremisesInstancesAction | 6 | CodeDeploy BatchGetOnPremisesInstances action. |
QtAws::CodeDeploy::CodeDeployRequest::ContinueDeploymentAction | 7 | CodeDeploy ContinueDeployment action. |
QtAws::CodeDeploy::CodeDeployRequest::CreateApplicationAction | 8 | CodeDeploy CreateApplication action. |
QtAws::CodeDeploy::CodeDeployRequest::CreateDeploymentAction | 9 | CodeDeploy CreateDeployment action. |
QtAws::CodeDeploy::CodeDeployRequest::CreateDeploymentConfigAction | 10 | CodeDeploy CreateDeploymentConfig action. |
QtAws::CodeDeploy::CodeDeployRequest::CreateDeploymentGroupAction | 11 | CodeDeploy CreateDeploymentGroup action. |
QtAws::CodeDeploy::CodeDeployRequest::DeleteApplicationAction | 12 | CodeDeploy DeleteApplication action. |
QtAws::CodeDeploy::CodeDeployRequest::DeleteDeploymentConfigAction | 13 | CodeDeploy DeleteDeploymentConfig action. |
QtAws::CodeDeploy::CodeDeployRequest::DeleteDeploymentGroupAction | 14 | CodeDeploy DeleteDeploymentGroup action. |
QtAws::CodeDeploy::CodeDeployRequest::DeleteGitHubAccountTokenAction | 15 | CodeDeploy DeleteGitHubAccountToken action. |
QtAws::CodeDeploy::CodeDeployRequest::DeregisterOnPremisesInstanceAction | 16 | CodeDeploy DeregisterOnPremisesInstance action. |
QtAws::CodeDeploy::CodeDeployRequest::GetApplicationAction | 17 | CodeDeploy GetApplication action. |
QtAws::CodeDeploy::CodeDeployRequest::GetApplicationRevisionAction | 18 | CodeDeploy GetApplicationRevision action. |
QtAws::CodeDeploy::CodeDeployRequest::GetDeploymentAction | 19 | CodeDeploy GetDeployment action. |
QtAws::CodeDeploy::CodeDeployRequest::GetDeploymentConfigAction | 20 | CodeDeploy GetDeploymentConfig action. |
QtAws::CodeDeploy::CodeDeployRequest::GetDeploymentGroupAction | 21 | CodeDeploy GetDeploymentGroup action. |
QtAws::CodeDeploy::CodeDeployRequest::GetDeploymentInstanceAction | 22 | CodeDeploy GetDeploymentInstance action. |
QtAws::CodeDeploy::CodeDeployRequest::GetOnPremisesInstanceAction | 23 | CodeDeploy GetOnPremisesInstance action. |
QtAws::CodeDeploy::CodeDeployRequest::ListApplicationRevisionsAction | 24 | CodeDeploy ListApplicationRevisions action. |
QtAws::CodeDeploy::CodeDeployRequest::ListApplicationsAction | 25 | CodeDeploy ListApplications action. |
QtAws::CodeDeploy::CodeDeployRequest::ListDeploymentConfigsAction | 26 | CodeDeploy ListDeploymentConfigs action. |
QtAws::CodeDeploy::CodeDeployRequest::ListDeploymentGroupsAction | 27 | CodeDeploy ListDeploymentGroups action. |
QtAws::CodeDeploy::CodeDeployRequest::ListDeploymentInstancesAction | 28 | CodeDeploy ListDeploymentInstances action. |
QtAws::CodeDeploy::CodeDeployRequest::ListDeploymentsAction | 29 | CodeDeploy ListDeployments action. |
QtAws::CodeDeploy::CodeDeployRequest::ListGitHubAccountTokenNamesAction | 30 | CodeDeploy ListGitHubAccountTokenNames action. |
QtAws::CodeDeploy::CodeDeployRequest::ListOnPremisesInstancesAction | 31 | CodeDeploy ListOnPremisesInstances action. |
QtAws::CodeDeploy::CodeDeployRequest::PutLifecycleEventHookExecutionStatusAction | 32 | CodeDeploy PutLifecycleEventHookExecutionStatus action. |
QtAws::CodeDeploy::CodeDeployRequest::RegisterApplicationRevisionAction | 33 | CodeDeploy RegisterApplicationRevision action. |
QtAws::CodeDeploy::CodeDeployRequest::RegisterOnPremisesInstanceAction | 34 | CodeDeploy RegisterOnPremisesInstance action. |
QtAws::CodeDeploy::CodeDeployRequest::RemoveTagsFromOnPremisesInstancesAction | 35 | CodeDeploy RemoveTagsFromOnPremisesInstances action. |
QtAws::CodeDeploy::CodeDeployRequest::SkipWaitTimeForInstanceTerminationAction | 36 | CodeDeploy SkipWaitTimeForInstanceTermination action. |
QtAws::CodeDeploy::CodeDeployRequest::StopDeploymentAction | 37 | CodeDeploy StopDeployment action. |
QtAws::CodeDeploy::CodeDeployRequest::UpdateApplicationAction | 38 | CodeDeploy UpdateApplication action. |
QtAws::CodeDeploy::CodeDeployRequest::UpdateDeploymentGroupAction | 39 | CodeDeploy UpdateDeploymentGroup action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
CodeDeployRequest::CodeDeployRequest(const Action action)
Constructs a CodeDeployRequest object for CodeDeploy action.
CodeDeployRequest::CodeDeployRequest(const CodeDeployRequest &other)
Constructs a copy of other.
[protected] CodeDeployRequest::CodeDeployRequest(CodeDeployRequestPrivate * const d)
Constructs aa CodeDeployRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from CodeDeployRequestPrivate.
Action CodeDeployRequest::action() const
Returns the CodeDeploy action to be performed by this request.
See also setAction().
QString CodeDeployRequest::actionString() const
Returns the name of the CodeDeploy action to be performed by this request.
QString CodeDeployRequest::apiVersion() const
Returns the CodeDeploy API version implemented by this request.
See also setApiVersion().
[protected] int CodeDeployRequest::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 CodeDeployRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant CodeDeployRequest::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 &CodeDeployRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void CodeDeployRequest::setAction(const Action action)
Sets the CodeDeploy action to be performed by this request to action.
See also action().
void CodeDeployRequest::setApiVersion(const QString &version)
Sets the CodeDeploy API version to include in this request to version.
See also apiVersion().
[protected] void CodeDeployRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void CodeDeployRequest::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 CodeDeployRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the CodeDeploy request using the given endpoint.
This CodeDeploy 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.
CodeDeployRequest &CodeDeployRequest::operator=(const CodeDeployRequest &other)
Sets the CodeDeployRequest object to be equal to other.
[virtual] bool CodeDeployRequest::operator==(const CodeDeployRequest &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.