ElasticsearchServiceRequest Class

Member Function Documentation

ElasticsearchServiceRequest::ElasticsearchServiceRequest(const Action action)

Constructs a ElasticsearchServiceRequest object for ElasticsearchService action.

ElasticsearchServiceRequest::ElasticsearchServiceRequest(const ElasticsearchServiceRequest &other)

Constructs a copy of other.

[protected] ElasticsearchServiceRequest::ElasticsearchServiceRequest(ElasticsearchServiceRequestPrivate * const d)

Constructs aa ElasticsearchServiceRequest object with private implementation d.

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

Action ElasticsearchServiceRequest::action() const

Returns the ElasticsearchService action to be performed by this request.

See also setAction().

QString ElasticsearchServiceRequest::actionString() const

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

QString ElasticsearchServiceRequest::apiVersion() const

Returns the ElasticsearchService API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void ElasticsearchServiceRequest::setAction(const Action action)

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

See also action().

void ElasticsearchServiceRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the ElasticsearchServiceRequest object to be equal to other.

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