AcmpcaRequest Class
(QtAws::ACMPCA::AcmpcaRequest)The AcmpcaRequest class provides an interface for ACMPCA requests. More...
Public Types
| enum | Action { CreateCertificateAuthorityAction, CreateCertificateAuthorityAuditReportAction, DeleteCertificateAuthorityAction, DescribeCertificateAuthorityAction, ..., UpdateCertificateAuthorityAction } |
| flags | Actions |
Public Functions
| AcmpcaRequest(const Action action) | |
| AcmpcaRequest(const AcmpcaRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| AcmpcaRequest & | operator=(const AcmpcaRequest &other) |
| virtual bool | operator==(const AcmpcaRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| AcmpcaRequest(AcmpcaRequestPrivate * 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 AcmpcaRequest class provides an interface for ACMPCA requests.
Member Type Documentation
enum AcmpcaRequest::Action
flags AcmpcaRequest::Actions
This enum describes the actions that can be performed as ACMPCA requests.
| Constant | Value | Description |
|---|---|---|
QtAws::ACMPCA::AcmpcaRequest::CreateCertificateAuthorityAction | 0 | ACMPCA CreateCertificateAuthority action. |
QtAws::ACMPCA::AcmpcaRequest::CreateCertificateAuthorityAuditReportAction | 1 | ACMPCA CreateCertificateAuthorityAuditReport action. |
QtAws::ACMPCA::AcmpcaRequest::DeleteCertificateAuthorityAction | 2 | ACMPCA DeleteCertificateAuthority action. |
QtAws::ACMPCA::AcmpcaRequest::DescribeCertificateAuthorityAction | 3 | ACMPCA DescribeCertificateAuthority action. |
QtAws::ACMPCA::AcmpcaRequest::DescribeCertificateAuthorityAuditReportAction | 4 | ACMPCA DescribeCertificateAuthorityAuditReport action. |
QtAws::ACMPCA::AcmpcaRequest::GetCertificateAction | 5 | ACMPCA GetCertificate action. |
QtAws::ACMPCA::AcmpcaRequest::GetCertificateAuthorityCertificateAction | 6 | ACMPCA GetCertificateAuthorityCertificate action. |
QtAws::ACMPCA::AcmpcaRequest::GetCertificateAuthorityCsrAction | 7 | ACMPCA GetCertificateAuthorityCsr action. |
QtAws::ACMPCA::AcmpcaRequest::ImportCertificateAuthorityCertificateAction | 8 | ACMPCA ImportCertificateAuthorityCertificate action. |
QtAws::ACMPCA::AcmpcaRequest::IssueCertificateAction | 9 | ACMPCA IssueCertificate action. |
QtAws::ACMPCA::AcmpcaRequest::ListCertificateAuthoritiesAction | 10 | ACMPCA ListCertificateAuthorities action. |
QtAws::ACMPCA::AcmpcaRequest::ListTagsAction | 11 | ACMPCA ListTags action. |
QtAws::ACMPCA::AcmpcaRequest::RevokeCertificateAction | 12 | ACMPCA RevokeCertificate action. |
QtAws::ACMPCA::AcmpcaRequest::TagCertificateAuthorityAction | 13 | ACMPCA TagCertificateAuthority action. |
QtAws::ACMPCA::AcmpcaRequest::UntagCertificateAuthorityAction | 14 | ACMPCA UntagCertificateAuthority action. |
QtAws::ACMPCA::AcmpcaRequest::UpdateCertificateAuthorityAction | 15 | ACMPCA UpdateCertificateAuthority action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
AcmpcaRequest::AcmpcaRequest(const Action action)
Constructs a AcmpcaRequest object for ACMPCA action.
AcmpcaRequest::AcmpcaRequest(const AcmpcaRequest &other)
Constructs a copy of other.
[protected] AcmpcaRequest::AcmpcaRequest(AcmpcaRequestPrivate * const d)
Constructs aa AcmpcaRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from AcmpcaRequestPrivate.
Action AcmpcaRequest::action() const
Returns the ACMPCA action to be performed by this request.
See also setAction().
QString AcmpcaRequest::actionString() const
Returns the name of the ACMPCA action to be performed by this request.
QString AcmpcaRequest::apiVersion() const
Returns the ACMPCA API version implemented by this request.
See also setApiVersion().
[protected] int AcmpcaRequest::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 AcmpcaRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant AcmpcaRequest::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 &AcmpcaRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void AcmpcaRequest::setAction(const Action action)
Sets the ACMPCA action to be performed by this request to action.
See also action().
void AcmpcaRequest::setApiVersion(const QString &version)
Sets the ACMPCA API version to include in this request to version.
See also apiVersion().
[protected] void AcmpcaRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void AcmpcaRequest::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 AcmpcaRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the ACMPCA request using the given endpoint.
This ACMPCA 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.
AcmpcaRequest &AcmpcaRequest::operator=(const AcmpcaRequest &other)
Sets the AcmpcaRequest object to be equal to other.
[virtual] bool AcmpcaRequest::operator==(const AcmpcaRequest &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.