XRayRequest Class
(QtAws::XRay::XRayRequest)The XRayRequest class provides an interface for XRay requests. More...
Public Types
| enum | Action { BatchGetTracesAction, GetEncryptionConfigAction, GetServiceGraphAction, GetTraceGraphAction, ..., PutTraceSegmentsAction } |
| flags | Actions |
Public Functions
| XRayRequest(const Action action) | |
| XRayRequest(const XRayRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| XRayRequest & | operator=(const XRayRequest &other) |
| virtual bool | operator==(const XRayRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| XRayRequest(XRayRequestPrivate * 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 XRayRequest class provides an interface for XRay requests.
Member Type Documentation
enum XRayRequest::Action
flags XRayRequest::Actions
This enum describes the actions that can be performed as XRay requests.
| Constant | Value | Description |
|---|---|---|
QtAws::XRay::XRayRequest::BatchGetTracesAction | 0 | XRay BatchGetTraces action. |
QtAws::XRay::XRayRequest::GetEncryptionConfigAction | 1 | XRay GetEncryptionConfig action. |
QtAws::XRay::XRayRequest::GetServiceGraphAction | 2 | XRay GetServiceGraph action. |
QtAws::XRay::XRayRequest::GetTraceGraphAction | 3 | XRay GetTraceGraph action. |
QtAws::XRay::XRayRequest::GetTraceSummariesAction | 4 | XRay GetTraceSummaries action. |
QtAws::XRay::XRayRequest::PutEncryptionConfigAction | 5 | XRay PutEncryptionConfig action. |
QtAws::XRay::XRayRequest::PutTelemetryRecordsAction | 6 | XRay PutTelemetryRecords action. |
QtAws::XRay::XRayRequest::PutTraceSegmentsAction | 7 | XRay PutTraceSegments action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
XRayRequest::XRayRequest(const Action action)
Constructs a XRayRequest object for XRay action.
XRayRequest::XRayRequest(const XRayRequest &other)
Constructs a copy of other.
[protected] XRayRequest::XRayRequest(XRayRequestPrivate * const d)
Constructs aa XRayRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from XRayRequestPrivate.
Action XRayRequest::action() const
Returns the XRay action to be performed by this request.
See also setAction().
QString XRayRequest::actionString() const
Returns the name of the XRay action to be performed by this request.
QString XRayRequest::apiVersion() const
Returns the XRay API version implemented by this request.
See also setApiVersion().
[protected] int XRayRequest::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 XRayRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant XRayRequest::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 &XRayRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void XRayRequest::setAction(const Action action)
Sets the XRay action to be performed by this request to action.
See also action().
void XRayRequest::setApiVersion(const QString &version)
Sets the XRay API version to include in this request to version.
See also apiVersion().
[protected] void XRayRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void XRayRequest::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 XRayRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the XRay request using the given endpoint.
This XRay 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.
XRayRequest &XRayRequest::operator=(const XRayRequest &other)
Sets the XRayRequest object to be equal to other.
[virtual] bool XRayRequest::operator==(const XRayRequest &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.