ServiceDiscoveryRequest Class

(QtAws::ServiceDiscovery::ServiceDiscoveryRequest)

The ServiceDiscoveryRequest class provides an interface for ServiceDiscovery requests. More...

Public Types

enum Action { CreatePrivateDnsNamespaceAction, CreatePublicDnsNamespaceAction, CreateServiceAction, DeleteNamespaceAction, ..., UpdateServiceAction }
flags Actions

Public Functions

ServiceDiscoveryRequest(const Action action)
ServiceDiscoveryRequest(const ServiceDiscoveryRequest &other)
Action action() const
QString actionString() const
QString apiVersion() const
void setAction(const Action action)
void setApiVersion(const QString &version)
ServiceDiscoveryRequest &operator=(const ServiceDiscoveryRequest &other)
virtual bool operator==(const ServiceDiscoveryRequest &other) const

Protected Functions

ServiceDiscoveryRequest(ServiceDiscoveryRequestPrivate * 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 ServiceDiscoveryRequest class provides an interface for ServiceDiscovery requests.

Member Type Documentation

enum ServiceDiscoveryRequest::Action
flags ServiceDiscoveryRequest::Actions

This enum describes the actions that can be performed as ServiceDiscovery requests.

ConstantValueDescription
QtAws::ServiceDiscovery::ServiceDiscoveryRequest::CreatePrivateDnsNamespaceAction0ServiceDiscovery CreatePrivateDnsNamespace action.
QtAws::ServiceDiscovery::ServiceDiscoveryRequest::CreatePublicDnsNamespaceAction1ServiceDiscovery CreatePublicDnsNamespace action.
QtAws::ServiceDiscovery::ServiceDiscoveryRequest::CreateServiceAction2ServiceDiscovery CreateService action.
QtAws::ServiceDiscovery::ServiceDiscoveryRequest::DeleteNamespaceAction3ServiceDiscovery DeleteNamespace action.
QtAws::ServiceDiscovery::ServiceDiscoveryRequest::DeleteServiceAction4ServiceDiscovery DeleteService action.
QtAws::ServiceDiscovery::ServiceDiscoveryRequest::DeregisterInstanceAction5ServiceDiscovery DeregisterInstance action.
QtAws::ServiceDiscovery::ServiceDiscoveryRequest::GetInstanceAction6ServiceDiscovery GetInstance action.
QtAws::ServiceDiscovery::ServiceDiscoveryRequest::GetInstancesHealthStatusAction7ServiceDiscovery GetInstancesHealthStatus action.
QtAws::ServiceDiscovery::ServiceDiscoveryRequest::GetNamespaceAction8ServiceDiscovery GetNamespace action.
QtAws::ServiceDiscovery::ServiceDiscoveryRequest::GetOperationAction9ServiceDiscovery GetOperation action.
QtAws::ServiceDiscovery::ServiceDiscoveryRequest::GetServiceAction10ServiceDiscovery GetService action.
QtAws::ServiceDiscovery::ServiceDiscoveryRequest::ListInstancesAction11ServiceDiscovery ListInstances action.
QtAws::ServiceDiscovery::ServiceDiscoveryRequest::ListNamespacesAction12ServiceDiscovery ListNamespaces action.
QtAws::ServiceDiscovery::ServiceDiscoveryRequest::ListOperationsAction13ServiceDiscovery ListOperations action.
QtAws::ServiceDiscovery::ServiceDiscoveryRequest::ListServicesAction14ServiceDiscovery ListServices action.
QtAws::ServiceDiscovery::ServiceDiscoveryRequest::RegisterInstanceAction15ServiceDiscovery RegisterInstance action.
QtAws::ServiceDiscovery::ServiceDiscoveryRequest::UpdateInstanceCustomHealthStatusAction16ServiceDiscovery UpdateInstanceCustomHealthStatus action.
QtAws::ServiceDiscovery::ServiceDiscoveryRequest::UpdateServiceAction17ServiceDiscovery UpdateService action.

The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.

Member Function Documentation

ServiceDiscoveryRequest::ServiceDiscoveryRequest(const Action action)

Constructs a ServiceDiscoveryRequest object for ServiceDiscovery action.

ServiceDiscoveryRequest::ServiceDiscoveryRequest(const ServiceDiscoveryRequest &other)

Constructs a copy of other.

[protected] ServiceDiscoveryRequest::ServiceDiscoveryRequest(ServiceDiscoveryRequestPrivate * const d)

Constructs aa ServiceDiscoveryRequest object with private implementation d.

This overload allows derived classes to provide their own private class implementation that inherits from ServiceDiscoveryRequestPrivate.

Action ServiceDiscoveryRequest::action() const

Returns the ServiceDiscovery action to be performed by this request.

See also setAction().

QString ServiceDiscoveryRequest::actionString() const

Returns the name of the ServiceDiscovery action to be performed by this request.

QString ServiceDiscoveryRequest::apiVersion() const

Returns the ServiceDiscovery API version implemented by this request.

See also setApiVersion().

[protected] int ServiceDiscoveryRequest::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 ServiceDiscoveryRequest::clearParameters()

Removes all parameters from the request.

[protected] QVariant ServiceDiscoveryRequest::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 &ServiceDiscoveryRequest::parameters() const

Returns the parameters included in this request.

See also setParameters().

void ServiceDiscoveryRequest::setAction(const Action action)

Sets the ServiceDiscovery action to be performed by this request to action.

See also action().

void ServiceDiscoveryRequest::setApiVersion(const QString &version)

Sets the ServiceDiscovery API version to include in this request to version.

See also apiVersion().

[protected] void ServiceDiscoveryRequest::setParameter(const QString &name, const QVariant &value)

Sets the name parameter to value.

See also parameter().

[protected] void ServiceDiscoveryRequest::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 ServiceDiscoveryRequest::unsignedRequest(const QUrl &endpoint) const

Reimplemented from AwsAbstractRequest::unsignedRequest().

Returns a network request for the ServiceDiscovery request using the given endpoint.

This ServiceDiscovery 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.

ServiceDiscoveryRequest &ServiceDiscoveryRequest::operator=(const ServiceDiscoveryRequest &other)

Sets the ServiceDiscoveryRequest object to be equal to other.

[virtual] bool ServiceDiscoveryRequest::operator==(const ServiceDiscoveryRequest &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.