SageMakerRuntimeRequest Class

(QtAws::SageMakerRuntime::SageMakerRuntimeRequest)

The SageMakerRuntimeRequest class provides an interface for SageMakerRuntime requests. More...

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

QtAws::SageMakerRuntime::InvokeEndpointRequest

Public Types

enum Action { InvokeEndpointAction }
flags Actions

Public Functions

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

Protected Functions

SageMakerRuntimeRequest(SageMakerRuntimeRequestPrivate * 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 SageMakerRuntimeRequest class provides an interface for SageMakerRuntime requests.

Member Type Documentation

enum SageMakerRuntimeRequest::Action
flags SageMakerRuntimeRequest::Actions

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

ConstantValueDescription
QtAws::SageMakerRuntime::SageMakerRuntimeRequest::InvokeEndpointAction0SageMakerRuntime InvokeEndpoint action.

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

Member Function Documentation

SageMakerRuntimeRequest::SageMakerRuntimeRequest(const Action action)

Constructs a SageMakerRuntimeRequest object for SageMakerRuntime action.

SageMakerRuntimeRequest::SageMakerRuntimeRequest(const SageMakerRuntimeRequest &other)

Constructs a copy of other.

[protected] SageMakerRuntimeRequest::SageMakerRuntimeRequest(SageMakerRuntimeRequestPrivate * const d)

Constructs aa SageMakerRuntimeRequest object with private implementation d.

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

Action SageMakerRuntimeRequest::action() const

Returns the SageMakerRuntime action to be performed by this request.

See also setAction().

QString SageMakerRuntimeRequest::actionString() const

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

QString SageMakerRuntimeRequest::apiVersion() const

Returns the SageMakerRuntime API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void SageMakerRuntimeRequest::setAction(const Action action)

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

See also action().

void SageMakerRuntimeRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the SageMakerRuntimeRequest object to be equal to other.

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