CodeBuildRequest Class

Member Function Documentation

CodeBuildRequest::CodeBuildRequest(const Action action)

Constructs a CodeBuildRequest object for CodeBuild action.

CodeBuildRequest::CodeBuildRequest(const CodeBuildRequest &other)

Constructs a copy of other.

[protected] CodeBuildRequest::CodeBuildRequest(CodeBuildRequestPrivate * const d)

Constructs aa CodeBuildRequest object with private implementation d.

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

Action CodeBuildRequest::action() const

Returns the CodeBuild action to be performed by this request.

See also setAction().

QString CodeBuildRequest::actionString() const

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

QString CodeBuildRequest::apiVersion() const

Returns the CodeBuild API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void CodeBuildRequest::setAction(const Action action)

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

See also action().

void CodeBuildRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the CodeBuildRequest object to be equal to other.

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