FirehoseRequest Class

(QtAws::Firehose::FirehoseRequest)

The FirehoseRequest class provides an interface for Firehose requests. More...

Header:	#include <FirehoseRequest>
Inherits:	QtAws::Core::AwsAbstractRequest
Inherited By:	QtAws::Firehose::CreateDeliveryStreamRequest, QtAws::Firehose::DeleteDeliveryStreamRequest, QtAws::Firehose::DescribeDeliveryStreamRequest, QtAws::Firehose::ListDeliveryStreamsRequest, QtAws::Firehose::ListTagsForDeliveryStreamRequest, QtAws::Firehose::PutRecordBatchRequest, QtAws::Firehose::PutRecordRequest, QtAws::Firehose::TagDeliveryStreamRequest, QtAws::Firehose::UntagDeliveryStreamRequest, and QtAws::Firehose::UpdateDestinationRequest

List of all members, including inherited members

Public Types

enum	Action { CreateDeliveryStreamAction, DeleteDeliveryStreamAction, DescribeDeliveryStreamAction, ListDeliveryStreamsAction, ..., UpdateDestinationAction }
flags	Actions

Public Functions

	FirehoseRequest(const Action action)
	FirehoseRequest(const FirehoseRequest &other)
Action	action() const
QString	actionString() const
QString	apiVersion() const
void	setAction(const Action action)
void	setApiVersion(const QString &version)
FirehoseRequest &	operator=(const FirehoseRequest &other)
virtual bool	operator==(const FirehoseRequest &other) const

7 public functions inherited from QtAws::Core::AwsAbstractRequest

Protected Functions

	FirehoseRequest(FirehoseRequestPrivate * const d)
int	clearParameter(const QString &name)
void	clearParameters()
QVariant	parameter(const QString &name, const QVariant &defaultValue = QVariant()) const
const QVariantMap &	parameters() const
void	setParameter(const QString &name, const QVariant &value)
void	setParameters(const QVariantMap &parameters)

Reimplemented Protected Functions

virtual QNetworkRequest unsignedRequest(const QUrl &endpoint) const override

4 protected functions inherited from QtAws::Core::AwsAbstractRequest

Detailed Description

The FirehoseRequest class provides an interface for Firehose requests.

Member Type Documentation

enum FirehoseRequest::Action
flags FirehoseRequest::Actions

This enum describes the actions that can be performed as Firehose requests.

Constant	Value	Description
`QtAws::Firehose::FirehoseRequest::CreateDeliveryStreamAction`	`0`	Firehose CreateDeliveryStream action.
`QtAws::Firehose::FirehoseRequest::DeleteDeliveryStreamAction`	`1`	Firehose DeleteDeliveryStream action.
`QtAws::Firehose::FirehoseRequest::DescribeDeliveryStreamAction`	`2`	Firehose DescribeDeliveryStream action.
`QtAws::Firehose::FirehoseRequest::ListDeliveryStreamsAction`	`3`	Firehose ListDeliveryStreams action.
`QtAws::Firehose::FirehoseRequest::ListTagsForDeliveryStreamAction`	`4`	Firehose ListTagsForDeliveryStream action.
`QtAws::Firehose::FirehoseRequest::PutRecordAction`	`5`	Firehose PutRecord action.
`QtAws::Firehose::FirehoseRequest::PutRecordBatchAction`	`6`	Firehose PutRecordBatch action.
`QtAws::Firehose::FirehoseRequest::TagDeliveryStreamAction`	`7`	Firehose TagDeliveryStream action.
`QtAws::Firehose::FirehoseRequest::UntagDeliveryStreamAction`	`8`	Firehose UntagDeliveryStream action.
`QtAws::Firehose::FirehoseRequest::UpdateDestinationAction`	`9`	Firehose UpdateDestination action.

The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.

Member Function Documentation

FirehoseRequest::FirehoseRequest(const Action action)

Constructs a FirehoseRequest object for Firehose action.

FirehoseRequest::FirehoseRequest(const FirehoseRequest &other)

Constructs a copy of other.

`[protected]` FirehoseRequest::FirehoseRequest(FirehoseRequestPrivate * const d)

Constructs aa FirehoseRequest object with private implementation d.

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

Action FirehoseRequest::action() const

Returns the Firehose action to be performed by this request.

See also setAction().

QString FirehoseRequest::actionString() const

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

QString FirehoseRequest::apiVersion() const

Returns the Firehose API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void FirehoseRequest::setAction(const Action action)

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

See also action().

void FirehoseRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the FirehoseRequest object to be equal to other.

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

© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.

Contents