CodeStarRequest Class

Member Function Documentation

CodeStarRequest::CodeStarRequest(const Action action)

Constructs a CodeStarRequest object for CodeStar action.

CodeStarRequest::CodeStarRequest(const CodeStarRequest &other)

Constructs a copy of other.

[protected] CodeStarRequest::CodeStarRequest(CodeStarRequestPrivate * const d)

Constructs aa CodeStarRequest object with private implementation d.

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

Action CodeStarRequest::action() const

Returns the CodeStar action to be performed by this request.

See also setAction().

QString CodeStarRequest::actionString() const

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

QString CodeStarRequest::apiVersion() const

Returns the CodeStar API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void CodeStarRequest::setAction(const Action action)

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

See also action().

void CodeStarRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the CodeStarRequest object to be equal to other.

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