ServiceCatalogRequest Class

(QtAws::ServiceCatalog::ServiceCatalogRequest)

The ServiceCatalogRequest class provides an interface for ServiceCatalog requests. More...

Header: #include <ServiceCatalogRequest>
Inherits: QtAws::Core::AwsAbstractRequest
Inherited By:

QtAws::ServiceCatalog::AcceptPortfolioShareRequest, QtAws::ServiceCatalog::AssociatePrincipalWithPortfolioRequest, QtAws::ServiceCatalog::AssociateProductWithPortfolioRequest, QtAws::ServiceCatalog::AssociateTagOptionWithResourceRequest, QtAws::ServiceCatalog::CopyProductRequest, QtAws::ServiceCatalog::CreateConstraintRequest, QtAws::ServiceCatalog::CreatePortfolioRequest, QtAws::ServiceCatalog::CreatePortfolioShareRequest, QtAws::ServiceCatalog::CreateProductRequest, QtAws::ServiceCatalog::CreateProvisionedProductPlanRequest, QtAws::ServiceCatalog::CreateProvisioningArtifactRequest, QtAws::ServiceCatalog::CreateTagOptionRequest, QtAws::ServiceCatalog::DeleteConstraintRequest, QtAws::ServiceCatalog::DeletePortfolioRequest, QtAws::ServiceCatalog::DeletePortfolioShareRequest, QtAws::ServiceCatalog::DeleteProductRequest, QtAws::ServiceCatalog::DeleteProvisionedProductPlanRequest, QtAws::ServiceCatalog::DeleteProvisioningArtifactRequest, QtAws::ServiceCatalog::DeleteTagOptionRequest, QtAws::ServiceCatalog::DescribeConstraintRequest, QtAws::ServiceCatalog::DescribeCopyProductStatusRequest, QtAws::ServiceCatalog::DescribePortfolioRequest, QtAws::ServiceCatalog::DescribeProductAsAdminRequest, QtAws::ServiceCatalog::DescribeProductRequest, QtAws::ServiceCatalog::DescribeProductViewRequest, QtAws::ServiceCatalog::DescribeProvisionedProductPlanRequest, QtAws::ServiceCatalog::DescribeProvisionedProductRequest, QtAws::ServiceCatalog::DescribeProvisioningArtifactRequest, QtAws::ServiceCatalog::DescribeProvisioningParametersRequest, QtAws::ServiceCatalog::DescribeRecordRequest, QtAws::ServiceCatalog::DescribeTagOptionRequest, QtAws::ServiceCatalog::DisassociatePrincipalFromPortfolioRequest, QtAws::ServiceCatalog::DisassociateProductFromPortfolioRequest, QtAws::ServiceCatalog::DisassociateTagOptionFromResourceRequest, QtAws::ServiceCatalog::ExecuteProvisionedProductPlanRequest, QtAws::ServiceCatalog::ListAcceptedPortfolioSharesRequest, QtAws::ServiceCatalog::ListConstraintsForPortfolioRequest, QtAws::ServiceCatalog::ListLaunchPathsRequest, QtAws::ServiceCatalog::ListPortfolioAccessRequest, QtAws::ServiceCatalog::ListPortfoliosForProductRequest, QtAws::ServiceCatalog::ListPortfoliosRequest, QtAws::ServiceCatalog::ListPrincipalsForPortfolioRequest, QtAws::ServiceCatalog::ListProvisionedProductPlansRequest, QtAws::ServiceCatalog::ListProvisioningArtifactsRequest, QtAws::ServiceCatalog::ListRecordHistoryRequest, QtAws::ServiceCatalog::ListResourcesForTagOptionRequest, QtAws::ServiceCatalog::ListTagOptionsRequest, QtAws::ServiceCatalog::ProvisionProductRequest, QtAws::ServiceCatalog::RejectPortfolioShareRequest, QtAws::ServiceCatalog::ScanProvisionedProductsRequest, QtAws::ServiceCatalog::SearchProductsAsAdminRequest, QtAws::ServiceCatalog::SearchProductsRequest, QtAws::ServiceCatalog::SearchProvisionedProductsRequest, QtAws::ServiceCatalog::TerminateProvisionedProductRequest, QtAws::ServiceCatalog::UpdateConstraintRequest, QtAws::ServiceCatalog::UpdatePortfolioRequest, QtAws::ServiceCatalog::UpdateProductRequest, QtAws::ServiceCatalog::UpdateProvisionedProductRequest, QtAws::ServiceCatalog::UpdateProvisioningArtifactRequest, and QtAws::ServiceCatalog::UpdateTagOptionRequest

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

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 &parameters)

Reimplemented Protected Functions

virtual QNetworkRequest unsignedRequest(const QUrl &endpoint) const override

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.

ConstantValueDescription
QtAws::ServiceCatalog::ServiceCatalogRequest::AcceptPortfolioShareAction0ServiceCatalog AcceptPortfolioShare action.
QtAws::ServiceCatalog::ServiceCatalogRequest::AssociatePrincipalWithPortfolioAction1ServiceCatalog AssociatePrincipalWithPortfolio action.
QtAws::ServiceCatalog::ServiceCatalogRequest::AssociateProductWithPortfolioAction2ServiceCatalog AssociateProductWithPortfolio action.
QtAws::ServiceCatalog::ServiceCatalogRequest::AssociateTagOptionWithResourceAction3ServiceCatalog AssociateTagOptionWithResource action.
QtAws::ServiceCatalog::ServiceCatalogRequest::CopyProductAction4ServiceCatalog CopyProduct action.
QtAws::ServiceCatalog::ServiceCatalogRequest::CreateConstraintAction5ServiceCatalog CreateConstraint action.
QtAws::ServiceCatalog::ServiceCatalogRequest::CreatePortfolioAction6ServiceCatalog CreatePortfolio action.
QtAws::ServiceCatalog::ServiceCatalogRequest::CreatePortfolioShareAction7ServiceCatalog CreatePortfolioShare action.
QtAws::ServiceCatalog::ServiceCatalogRequest::CreateProductAction8ServiceCatalog CreateProduct action.
QtAws::ServiceCatalog::ServiceCatalogRequest::CreateProvisionedProductPlanAction9ServiceCatalog CreateProvisionedProductPlan action.
QtAws::ServiceCatalog::ServiceCatalogRequest::CreateProvisioningArtifactAction10ServiceCatalog CreateProvisioningArtifact action.
QtAws::ServiceCatalog::ServiceCatalogRequest::CreateTagOptionAction11ServiceCatalog CreateTagOption action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DeleteConstraintAction12ServiceCatalog DeleteConstraint action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DeletePortfolioAction13ServiceCatalog DeletePortfolio action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DeletePortfolioShareAction14ServiceCatalog DeletePortfolioShare action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DeleteProductAction15ServiceCatalog DeleteProduct action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DeleteProvisionedProductPlanAction16ServiceCatalog DeleteProvisionedProductPlan action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DeleteProvisioningArtifactAction17ServiceCatalog DeleteProvisioningArtifact action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DeleteTagOptionAction18ServiceCatalog DeleteTagOption action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeConstraintAction19ServiceCatalog DescribeConstraint action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeCopyProductStatusAction20ServiceCatalog DescribeCopyProductStatus action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribePortfolioAction21ServiceCatalog DescribePortfolio action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeProductAction22ServiceCatalog DescribeProduct action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeProductAsAdminAction23ServiceCatalog DescribeProductAsAdmin action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeProductViewAction24ServiceCatalog DescribeProductView action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeProvisionedProductAction25ServiceCatalog DescribeProvisionedProduct action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeProvisionedProductPlanAction26ServiceCatalog DescribeProvisionedProductPlan action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeProvisioningArtifactAction27ServiceCatalog DescribeProvisioningArtifact action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeProvisioningParametersAction28ServiceCatalog DescribeProvisioningParameters action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeRecordAction29ServiceCatalog DescribeRecord action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DescribeTagOptionAction30ServiceCatalog DescribeTagOption action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DisassociatePrincipalFromPortfolioAction31ServiceCatalog DisassociatePrincipalFromPortfolio action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DisassociateProductFromPortfolioAction32ServiceCatalog DisassociateProductFromPortfolio action.
QtAws::ServiceCatalog::ServiceCatalogRequest::DisassociateTagOptionFromResourceAction33ServiceCatalog DisassociateTagOptionFromResource action.
QtAws::ServiceCatalog::ServiceCatalogRequest::ExecuteProvisionedProductPlanAction34ServiceCatalog ExecuteProvisionedProductPlan action.
QtAws::ServiceCatalog::ServiceCatalogRequest::ListAcceptedPortfolioSharesAction35ServiceCatalog ListAcceptedPortfolioShares action.
QtAws::ServiceCatalog::ServiceCatalogRequest::ListConstraintsForPortfolioAction36ServiceCatalog ListConstraintsForPortfolio action.
QtAws::ServiceCatalog::ServiceCatalogRequest::ListLaunchPathsAction37ServiceCatalog ListLaunchPaths action.
QtAws::ServiceCatalog::ServiceCatalogRequest::ListPortfolioAccessAction38ServiceCatalog ListPortfolioAccess action.
QtAws::ServiceCatalog::ServiceCatalogRequest::ListPortfoliosAction39ServiceCatalog ListPortfolios action.
QtAws::ServiceCatalog::ServiceCatalogRequest::ListPortfoliosForProductAction40ServiceCatalog ListPortfoliosForProduct action.
QtAws::ServiceCatalog::ServiceCatalogRequest::ListPrincipalsForPortfolioAction41ServiceCatalog ListPrincipalsForPortfolio action.
QtAws::ServiceCatalog::ServiceCatalogRequest::ListProvisionedProductPlansAction42ServiceCatalog ListProvisionedProductPlans action.
QtAws::ServiceCatalog::ServiceCatalogRequest::ListProvisioningArtifactsAction43ServiceCatalog ListProvisioningArtifacts action.
QtAws::ServiceCatalog::ServiceCatalogRequest::ListRecordHistoryAction44ServiceCatalog ListRecordHistory action.
QtAws::ServiceCatalog::ServiceCatalogRequest::ListResourcesForTagOptionAction45ServiceCatalog ListResourcesForTagOption action.
QtAws::ServiceCatalog::ServiceCatalogRequest::ListTagOptionsAction46ServiceCatalog ListTagOptions action.
QtAws::ServiceCatalog::ServiceCatalogRequest::ProvisionProductAction47ServiceCatalog ProvisionProduct action.
QtAws::ServiceCatalog::ServiceCatalogRequest::RejectPortfolioShareAction48ServiceCatalog RejectPortfolioShare action.
QtAws::ServiceCatalog::ServiceCatalogRequest::ScanProvisionedProductsAction49ServiceCatalog ScanProvisionedProducts action.
QtAws::ServiceCatalog::ServiceCatalogRequest::SearchProductsAction50ServiceCatalog SearchProducts action.
QtAws::ServiceCatalog::ServiceCatalogRequest::SearchProductsAsAdminAction51ServiceCatalog SearchProductsAsAdmin action.
QtAws::ServiceCatalog::ServiceCatalogRequest::SearchProvisionedProductsAction52ServiceCatalog SearchProvisionedProducts action.
QtAws::ServiceCatalog::ServiceCatalogRequest::TerminateProvisionedProductAction53ServiceCatalog TerminateProvisionedProduct action.
QtAws::ServiceCatalog::ServiceCatalogRequest::UpdateConstraintAction54ServiceCatalog UpdateConstraint action.
QtAws::ServiceCatalog::ServiceCatalogRequest::UpdatePortfolioAction55ServiceCatalog UpdatePortfolio action.
QtAws::ServiceCatalog::ServiceCatalogRequest::UpdateProductAction56ServiceCatalog UpdateProduct action.
QtAws::ServiceCatalog::ServiceCatalogRequest::UpdateProvisionedProductAction57ServiceCatalog UpdateProvisionedProduct action.
QtAws::ServiceCatalog::ServiceCatalogRequest::UpdateProvisioningArtifactAction58ServiceCatalog UpdateProvisioningArtifact action.
QtAws::ServiceCatalog::ServiceCatalogRequest::UpdateTagOptionAction59ServiceCatalog 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 &parameters)

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.