DataPipelineRequest Class

Member Function Documentation

DataPipelineRequest::DataPipelineRequest(const Action action)

Constructs a DataPipelineRequest object for DataPipeline action.

DataPipelineRequest::DataPipelineRequest(const DataPipelineRequest &other)

Constructs a copy of other.

[protected] DataPipelineRequest::DataPipelineRequest(DataPipelineRequestPrivate * const d)

Constructs aa DataPipelineRequest object with private implementation d.

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

Action DataPipelineRequest::action() const

Returns the DataPipeline action to be performed by this request.

See also setAction().

QString DataPipelineRequest::actionString() const

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

QString DataPipelineRequest::apiVersion() const

Returns the DataPipeline API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void DataPipelineRequest::setAction(const Action action)

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

See also action().

void DataPipelineRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the DataPipelineRequest object to be equal to other.

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