ServiceCatalogRequest Class
(QtAws::ServiceCatalog::ServiceCatalogRequest)The ServiceCatalogRequest class provides an interface for ServiceCatalog requests. More...
Public Types
| enum | Action { AcceptPortfolioShareAction, AssociatePrincipalWithPortfolioAction, AssociateProductWithPortfolioAction, AssociateTagOptionWithResourceAction, ..., UpdateTagOptionAction } |
| flags | Actions |
Public Functions
| ServiceCatalogRequest(const Action action) | |
| ServiceCatalogRequest(const ServiceCatalogRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| ServiceCatalogRequest & | operator=(const ServiceCatalogRequest &other) |
| virtual bool | operator==(const ServiceCatalogRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| ServiceCatalogRequest(ServiceCatalogRequestPrivate * 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 ServiceCatalogRequest class provides an interface for ServiceCatalog requests.
Member Type Documentation
enum ServiceCatalogRequest::Action
flags ServiceCatalogRequest::Actions
This enum describes the actions that can be performed as ServiceCatalog requests.
| Constant | Value | Description |
|---|---|---|
QtAws::ServiceCatalog::ServiceCatalogRequest::AcceptPortfolioShareAction | 0 | ServiceCatalog AcceptPortfolioShare action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::AssociatePrincipalWithPortfolioAction | 1 | ServiceCatalog AssociatePrincipalWithPortfolio action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::AssociateProductWithPortfolioAction | 2 | ServiceCatalog AssociateProductWithPortfolio action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::AssociateTagOptionWithResourceAction | 3 | ServiceCatalog AssociateTagOptionWithResource action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::CopyProductAction | 4 | ServiceCatalog CopyProduct action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::CreateConstraintAction | 5 | ServiceCatalog CreateConstraint action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::CreatePortfolioAction | 6 | ServiceCatalog CreatePortfolio action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::CreatePortfolioShareAction | 7 | ServiceCatalog CreatePortfolioShare action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::CreateProductAction | 8 | ServiceCatalog CreateProduct action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::CreateProvisionedProductPlanAction | 9 | ServiceCatalog CreateProvisionedProductPlan action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::CreateProvisioningArtifactAction | 10 | ServiceCatalog CreateProvisioningArtifact action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::CreateTagOptionAction | 11 | ServiceCatalog CreateTagOption action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DeleteConstraintAction | 12 | ServiceCatalog DeleteConstraint action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DeletePortfolioAction | 13 | ServiceCatalog DeletePortfolio action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DeletePortfolioShareAction | 14 | ServiceCatalog DeletePortfolioShare action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DeleteProductAction | 15 | ServiceCatalog DeleteProduct action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DeleteProvisionedProductPlanAction | 16 | ServiceCatalog DeleteProvisionedProductPlan action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DeleteProvisioningArtifactAction | 17 | ServiceCatalog DeleteProvisioningArtifact action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DeleteTagOptionAction | 18 | ServiceCatalog DeleteTagOption action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeConstraintAction | 19 | ServiceCatalog DescribeConstraint action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeCopyProductStatusAction | 20 | ServiceCatalog DescribeCopyProductStatus action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribePortfolioAction | 21 | ServiceCatalog DescribePortfolio action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeProductAction | 22 | ServiceCatalog DescribeProduct action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeProductAsAdminAction | 23 | ServiceCatalog DescribeProductAsAdmin action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeProductViewAction | 24 | ServiceCatalog DescribeProductView action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeProvisionedProductAction | 25 | ServiceCatalog DescribeProvisionedProduct action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeProvisionedProductPlanAction | 26 | ServiceCatalog DescribeProvisionedProductPlan action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeProvisioningArtifactAction | 27 | ServiceCatalog DescribeProvisioningArtifact action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeProvisioningParametersAction | 28 | ServiceCatalog DescribeProvisioningParameters action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeRecordAction | 29 | ServiceCatalog DescribeRecord action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeTagOptionAction | 30 | ServiceCatalog DescribeTagOption action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DisassociatePrincipalFromPortfolioAction | 31 | ServiceCatalog DisassociatePrincipalFromPortfolio action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DisassociateProductFromPortfolioAction | 32 | ServiceCatalog DisassociateProductFromPortfolio action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::DisassociateTagOptionFromResourceAction | 33 | ServiceCatalog DisassociateTagOptionFromResource action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::ExecuteProvisionedProductPlanAction | 34 | ServiceCatalog ExecuteProvisionedProductPlan action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::ListAcceptedPortfolioSharesAction | 35 | ServiceCatalog ListAcceptedPortfolioShares action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::ListConstraintsForPortfolioAction | 36 | ServiceCatalog ListConstraintsForPortfolio action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::ListLaunchPathsAction | 37 | ServiceCatalog ListLaunchPaths action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::ListPortfolioAccessAction | 38 | ServiceCatalog ListPortfolioAccess action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::ListPortfoliosAction | 39 | ServiceCatalog ListPortfolios action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::ListPortfoliosForProductAction | 40 | ServiceCatalog ListPortfoliosForProduct action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::ListPrincipalsForPortfolioAction | 41 | ServiceCatalog ListPrincipalsForPortfolio action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::ListProvisionedProductPlansAction | 42 | ServiceCatalog ListProvisionedProductPlans action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::ListProvisioningArtifactsAction | 43 | ServiceCatalog ListProvisioningArtifacts action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::ListRecordHistoryAction | 44 | ServiceCatalog ListRecordHistory action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::ListResourcesForTagOptionAction | 45 | ServiceCatalog ListResourcesForTagOption action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::ListTagOptionsAction | 46 | ServiceCatalog ListTagOptions action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::ProvisionProductAction | 47 | ServiceCatalog ProvisionProduct action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::RejectPortfolioShareAction | 48 | ServiceCatalog RejectPortfolioShare action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::ScanProvisionedProductsAction | 49 | ServiceCatalog ScanProvisionedProducts action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::SearchProductsAction | 50 | ServiceCatalog SearchProducts action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::SearchProductsAsAdminAction | 51 | ServiceCatalog SearchProductsAsAdmin action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::SearchProvisionedProductsAction | 52 | ServiceCatalog SearchProvisionedProducts action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::TerminateProvisionedProductAction | 53 | ServiceCatalog TerminateProvisionedProduct action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::UpdateConstraintAction | 54 | ServiceCatalog UpdateConstraint action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::UpdatePortfolioAction | 55 | ServiceCatalog UpdatePortfolio action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::UpdateProductAction | 56 | ServiceCatalog UpdateProduct action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::UpdateProvisionedProductAction | 57 | ServiceCatalog UpdateProvisionedProduct action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::UpdateProvisioningArtifactAction | 58 | ServiceCatalog UpdateProvisioningArtifact action. |
QtAws::ServiceCatalog::ServiceCatalogRequest::UpdateTagOptionAction | 59 | ServiceCatalog UpdateTagOption action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
ServiceCatalogRequest::ServiceCatalogRequest(const Action action)
Constructs a ServiceCatalogRequest object for ServiceCatalog action.
ServiceCatalogRequest::ServiceCatalogRequest(const ServiceCatalogRequest &other)
Constructs a copy of other.
[protected] ServiceCatalogRequest::ServiceCatalogRequest(ServiceCatalogRequestPrivate * const d)
Constructs aa ServiceCatalogRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from ServiceCatalogRequestPrivate.
Action ServiceCatalogRequest::action() const
Returns the ServiceCatalog action to be performed by this request.
See also setAction().
QString ServiceCatalogRequest::actionString() const
Returns the name of the ServiceCatalog action to be performed by this request.
QString ServiceCatalogRequest::apiVersion() const
Returns the ServiceCatalog API version implemented by this request.
See also setApiVersion().
[protected] int ServiceCatalogRequest::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 ServiceCatalogRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant ServiceCatalogRequest::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 &ServiceCatalogRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void ServiceCatalogRequest::setAction(const Action action)
Sets the ServiceCatalog action to be performed by this request to action.
See also action().
void ServiceCatalogRequest::setApiVersion(const QString &version)
Sets the ServiceCatalog API version to include in this request to version.
See also apiVersion().
[protected] void ServiceCatalogRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void ServiceCatalogRequest::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 ServiceCatalogRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the ServiceCatalog request using the given endpoint.
This ServiceCatalog 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.
ServiceCatalogRequest &ServiceCatalogRequest::operator=(const ServiceCatalogRequest &other)
Sets the ServiceCatalogRequest object to be equal to other.
[virtual] bool ServiceCatalogRequest::operator==(const ServiceCatalogRequest &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.