CodeDeployRequest Class

(QtAws::CodeDeploy::CodeDeployRequest)

The CodeDeployRequest class provides an interface for CodeDeploy requests. More...

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

QtAws::CodeDeploy::AddTagsToOnPremisesInstancesRequest, QtAws::CodeDeploy::BatchGetApplicationRevisionsRequest, QtAws::CodeDeploy::BatchGetApplicationsRequest, QtAws::CodeDeploy::BatchGetDeploymentGroupsRequest, QtAws::CodeDeploy::BatchGetDeploymentInstancesRequest, QtAws::CodeDeploy::BatchGetDeploymentsRequest, QtAws::CodeDeploy::BatchGetOnPremisesInstancesRequest, QtAws::CodeDeploy::ContinueDeploymentRequest, QtAws::CodeDeploy::CreateApplicationRequest, QtAws::CodeDeploy::CreateDeploymentConfigRequest, QtAws::CodeDeploy::CreateDeploymentGroupRequest, QtAws::CodeDeploy::CreateDeploymentRequest, QtAws::CodeDeploy::DeleteApplicationRequest, QtAws::CodeDeploy::DeleteDeploymentConfigRequest, QtAws::CodeDeploy::DeleteDeploymentGroupRequest, QtAws::CodeDeploy::DeleteGitHubAccountTokenRequest, QtAws::CodeDeploy::DeregisterOnPremisesInstanceRequest, QtAws::CodeDeploy::GetApplicationRequest, QtAws::CodeDeploy::GetApplicationRevisionRequest, QtAws::CodeDeploy::GetDeploymentConfigRequest, QtAws::CodeDeploy::GetDeploymentGroupRequest, QtAws::CodeDeploy::GetDeploymentInstanceRequest, QtAws::CodeDeploy::GetDeploymentRequest, QtAws::CodeDeploy::GetOnPremisesInstanceRequest, QtAws::CodeDeploy::ListApplicationRevisionsRequest, QtAws::CodeDeploy::ListApplicationsRequest, QtAws::CodeDeploy::ListDeploymentConfigsRequest, QtAws::CodeDeploy::ListDeploymentGroupsRequest, QtAws::CodeDeploy::ListDeploymentInstancesRequest, QtAws::CodeDeploy::ListDeploymentsRequest, QtAws::CodeDeploy::ListGitHubAccountTokenNamesRequest, QtAws::CodeDeploy::ListOnPremisesInstancesRequest, QtAws::CodeDeploy::PutLifecycleEventHookExecutionStatusRequest, QtAws::CodeDeploy::RegisterApplicationRevisionRequest, QtAws::CodeDeploy::RegisterOnPremisesInstanceRequest, QtAws::CodeDeploy::RemoveTagsFromOnPremisesInstancesRequest, QtAws::CodeDeploy::SkipWaitTimeForInstanceTerminationRequest, QtAws::CodeDeploy::StopDeploymentRequest, QtAws::CodeDeploy::UpdateApplicationRequest, and QtAws::CodeDeploy::UpdateDeploymentGroupRequest

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

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

Reimplemented Protected Functions

virtual QNetworkRequest unsignedRequest(const QUrl &endpoint) const override

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.

ConstantValueDescription
QtAws::CodeDeploy::CodeDeployRequest::AddTagsToOnPremisesInstancesAction0CodeDeploy AddTagsToOnPremisesInstances action.
QtAws::CodeDeploy::CodeDeployRequest::BatchGetApplicationRevisionsAction1CodeDeploy BatchGetApplicationRevisions action.
QtAws::CodeDeploy::CodeDeployRequest::BatchGetApplicationsAction2CodeDeploy BatchGetApplications action.
QtAws::CodeDeploy::CodeDeployRequest::BatchGetDeploymentGroupsAction3CodeDeploy BatchGetDeploymentGroups action.
QtAws::CodeDeploy::CodeDeployRequest::BatchGetDeploymentInstancesAction4CodeDeploy BatchGetDeploymentInstances action.
QtAws::CodeDeploy::CodeDeployRequest::BatchGetDeploymentsAction5CodeDeploy BatchGetDeployments action.
QtAws::CodeDeploy::CodeDeployRequest::BatchGetOnPremisesInstancesAction6CodeDeploy BatchGetOnPremisesInstances action.
QtAws::CodeDeploy::CodeDeployRequest::ContinueDeploymentAction7CodeDeploy ContinueDeployment action.
QtAws::CodeDeploy::CodeDeployRequest::CreateApplicationAction8CodeDeploy CreateApplication action.
QtAws::CodeDeploy::CodeDeployRequest::CreateDeploymentAction9CodeDeploy CreateDeployment action.
QtAws::CodeDeploy::CodeDeployRequest::CreateDeploymentConfigAction10CodeDeploy CreateDeploymentConfig action.
QtAws::CodeDeploy::CodeDeployRequest::CreateDeploymentGroupAction11CodeDeploy CreateDeploymentGroup action.
QtAws::CodeDeploy::CodeDeployRequest::DeleteApplicationAction12CodeDeploy DeleteApplication action.
QtAws::CodeDeploy::CodeDeployRequest::DeleteDeploymentConfigAction13CodeDeploy DeleteDeploymentConfig action.
QtAws::CodeDeploy::CodeDeployRequest::DeleteDeploymentGroupAction14CodeDeploy DeleteDeploymentGroup action.
QtAws::CodeDeploy::CodeDeployRequest::DeleteGitHubAccountTokenAction15CodeDeploy DeleteGitHubAccountToken action.
QtAws::CodeDeploy::CodeDeployRequest::DeregisterOnPremisesInstanceAction16CodeDeploy DeregisterOnPremisesInstance action.
QtAws::CodeDeploy::CodeDeployRequest::GetApplicationAction17CodeDeploy GetApplication action.
QtAws::CodeDeploy::CodeDeployRequest::GetApplicationRevisionAction18CodeDeploy GetApplicationRevision action.
QtAws::CodeDeploy::CodeDeployRequest::GetDeploymentAction19CodeDeploy GetDeployment action.
QtAws::CodeDeploy::CodeDeployRequest::GetDeploymentConfigAction20CodeDeploy GetDeploymentConfig action.
QtAws::CodeDeploy::CodeDeployRequest::GetDeploymentGroupAction21CodeDeploy GetDeploymentGroup action.
QtAws::CodeDeploy::CodeDeployRequest::GetDeploymentInstanceAction22CodeDeploy GetDeploymentInstance action.
QtAws::CodeDeploy::CodeDeployRequest::GetOnPremisesInstanceAction23CodeDeploy GetOnPremisesInstance action.
QtAws::CodeDeploy::CodeDeployRequest::ListApplicationRevisionsAction24CodeDeploy ListApplicationRevisions action.
QtAws::CodeDeploy::CodeDeployRequest::ListApplicationsAction25CodeDeploy ListApplications action.
QtAws::CodeDeploy::CodeDeployRequest::ListDeploymentConfigsAction26CodeDeploy ListDeploymentConfigs action.
QtAws::CodeDeploy::CodeDeployRequest::ListDeploymentGroupsAction27CodeDeploy ListDeploymentGroups action.
QtAws::CodeDeploy::CodeDeployRequest::ListDeploymentInstancesAction28CodeDeploy ListDeploymentInstances action.
QtAws::CodeDeploy::CodeDeployRequest::ListDeploymentsAction29CodeDeploy ListDeployments action.
QtAws::CodeDeploy::CodeDeployRequest::ListGitHubAccountTokenNamesAction30CodeDeploy ListGitHubAccountTokenNames action.
QtAws::CodeDeploy::CodeDeployRequest::ListOnPremisesInstancesAction31CodeDeploy ListOnPremisesInstances action.
QtAws::CodeDeploy::CodeDeployRequest::PutLifecycleEventHookExecutionStatusAction32CodeDeploy PutLifecycleEventHookExecutionStatus action.
QtAws::CodeDeploy::CodeDeployRequest::RegisterApplicationRevisionAction33CodeDeploy RegisterApplicationRevision action.
QtAws::CodeDeploy::CodeDeployRequest::RegisterOnPremisesInstanceAction34CodeDeploy RegisterOnPremisesInstance action.
QtAws::CodeDeploy::CodeDeployRequest::RemoveTagsFromOnPremisesInstancesAction35CodeDeploy RemoveTagsFromOnPremisesInstances action.
QtAws::CodeDeploy::CodeDeployRequest::SkipWaitTimeForInstanceTerminationAction36CodeDeploy SkipWaitTimeForInstanceTermination action.
QtAws::CodeDeploy::CodeDeployRequest::StopDeploymentAction37CodeDeploy StopDeployment action.
QtAws::CodeDeploy::CodeDeployRequest::UpdateApplicationAction38CodeDeploy UpdateApplication action.
QtAws::CodeDeploy::CodeDeployRequest::UpdateDeploymentGroupAction39CodeDeploy 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 &parameters)

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.