KinesisVideoRequest Class
(QtAws::KinesisVideo::KinesisVideoRequest)The KinesisVideoRequest class provides an interface for KinesisVideo requests. More...
Public Types
| enum | Action { CreateStreamAction, DeleteStreamAction, DescribeStreamAction, GetDataEndpointAction, ..., UpdateStreamAction } |
| flags | Actions |
Public Functions
| KinesisVideoRequest(const Action action) | |
| KinesisVideoRequest(const KinesisVideoRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| KinesisVideoRequest & | operator=(const KinesisVideoRequest &other) |
| virtual bool | operator==(const KinesisVideoRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| KinesisVideoRequest(KinesisVideoRequestPrivate * 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 ¶meters) |
Reimplemented Protected Functions
| virtual QNetworkRequest | unsignedRequest(const QUrl &endpoint) const override |
- 4 protected functions inherited from QtAws::Core::AwsAbstractRequest
Detailed Description
The KinesisVideoRequest class provides an interface for KinesisVideo requests.
Member Type Documentation
enum KinesisVideoRequest::Action
flags KinesisVideoRequest::Actions
This enum describes the actions that can be performed as KinesisVideo requests.
| Constant | Value | Description |
|---|---|---|
QtAws::KinesisVideo::KinesisVideoRequest::CreateStreamAction | 0 | KinesisVideo CreateStream action. |
QtAws::KinesisVideo::KinesisVideoRequest::DeleteStreamAction | 1 | KinesisVideo DeleteStream action. |
QtAws::KinesisVideo::KinesisVideoRequest::DescribeStreamAction | 2 | KinesisVideo DescribeStream action. |
QtAws::KinesisVideo::KinesisVideoRequest::GetDataEndpointAction | 3 | KinesisVideo GetDataEndpoint action. |
QtAws::KinesisVideo::KinesisVideoRequest::ListStreamsAction | 4 | KinesisVideo ListStreams action. |
QtAws::KinesisVideo::KinesisVideoRequest::ListTagsForStreamAction | 5 | KinesisVideo ListTagsForStream action. |
QtAws::KinesisVideo::KinesisVideoRequest::TagStreamAction | 6 | KinesisVideo TagStream action. |
QtAws::KinesisVideo::KinesisVideoRequest::UntagStreamAction | 7 | KinesisVideo UntagStream action. |
QtAws::KinesisVideo::KinesisVideoRequest::UpdateDataRetentionAction | 8 | KinesisVideo UpdateDataRetention action. |
QtAws::KinesisVideo::KinesisVideoRequest::UpdateStreamAction | 9 | KinesisVideo UpdateStream action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
KinesisVideoRequest::KinesisVideoRequest(const Action action)
Constructs a KinesisVideoRequest object for KinesisVideo action.
KinesisVideoRequest::KinesisVideoRequest(const KinesisVideoRequest &other)
Constructs a copy of other.
[protected] KinesisVideoRequest::KinesisVideoRequest(KinesisVideoRequestPrivate * const d)
Constructs aa KinesisVideoRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from KinesisVideoRequestPrivate.
Action KinesisVideoRequest::action() const
Returns the KinesisVideo action to be performed by this request.
See also setAction().
QString KinesisVideoRequest::actionString() const
Returns the name of the KinesisVideo action to be performed by this request.
QString KinesisVideoRequest::apiVersion() const
Returns the KinesisVideo API version implemented by this request.
See also setApiVersion().
[protected] int KinesisVideoRequest::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 KinesisVideoRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant KinesisVideoRequest::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 &KinesisVideoRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void KinesisVideoRequest::setAction(const Action action)
Sets the KinesisVideo action to be performed by this request to action.
See also action().
void KinesisVideoRequest::setApiVersion(const QString &version)
Sets the KinesisVideo API version to include in this request to version.
See also apiVersion().
[protected] void KinesisVideoRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void KinesisVideoRequest::setParameters(const QVariantMap ¶meters)
Sets the paramters for this request to parameters. Any request parameters set previously will be discarded.
See also parameters().
[override virtual protected] QNetworkRequest KinesisVideoRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the KinesisVideo request using the given endpoint.
This KinesisVideo 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.
KinesisVideoRequest &KinesisVideoRequest::operator=(const KinesisVideoRequest &other)
Sets the KinesisVideoRequest object to be equal to other.
[virtual] bool KinesisVideoRequest::operator==(const KinesisVideoRequest &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.