CodePipelineRequest Class

Member Function Documentation

CodePipelineRequest::CodePipelineRequest(const Action action)

Constructs a CodePipelineRequest object for CodePipeline action.

CodePipelineRequest::CodePipelineRequest(const CodePipelineRequest &other)

Constructs a copy of other.

[protected] CodePipelineRequest::CodePipelineRequest(CodePipelineRequestPrivate * const d)

Constructs aa CodePipelineRequest object with private implementation d.

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

Action CodePipelineRequest::action() const

Returns the CodePipeline action to be performed by this request.

See also setAction().

QString CodePipelineRequest::actionString() const

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

QString CodePipelineRequest::apiVersion() const

Returns the CodePipeline API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void CodePipelineRequest::setAction(const Action action)

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

See also action().

void CodePipelineRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the CodePipelineRequest object to be equal to other.

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