AWS IoT Device SDK C++ v2  1.34.0
AWS IoT Device SDK C++ v2
Public Member Functions | List of all members
Aws::Eventstreamrpc::OperationModelContext Class Referenceabstract

#include <EventStreamClient.h>

Inheritance diagram for Aws::Eventstreamrpc::OperationModelContext:
Aws::Greengrass::AuthorizeClientDeviceActionOperationContext Aws::Greengrass::CancelLocalDeploymentOperationContext Aws::Greengrass::CreateDebugPasswordOperationContext Aws::Greengrass::CreateLocalDeploymentOperationContext Aws::Greengrass::DeferComponentUpdateOperationContext Aws::Greengrass::DeleteThingShadowOperationContext Aws::Greengrass::GetClientDeviceAuthTokenOperationContext Aws::Greengrass::GetComponentDetailsOperationContext Aws::Greengrass::GetConfigurationOperationContext Aws::Greengrass::GetLocalDeploymentStatusOperationContext Aws::Greengrass::GetSecretValueOperationContext Aws::Greengrass::GetThingShadowOperationContext Aws::Greengrass::ListComponentsOperationContext Aws::Greengrass::ListLocalDeploymentsOperationContext Aws::Greengrass::ListNamedShadowsForThingOperationContext Aws::Greengrass::PauseComponentOperationContext Aws::Greengrass::PublishToIoTCoreOperationContext Aws::Greengrass::PublishToTopicOperationContext Aws::Greengrass::PutComponentMetricOperationContext Aws::Greengrass::RestartComponentOperationContext Aws::Greengrass::ResumeComponentOperationContext Aws::Greengrass::SendConfigurationValidityReportOperationContext Aws::Greengrass::StopComponentOperationContext Aws::Greengrass::SubscribeToCertificateUpdatesOperationContext Aws::Greengrass::SubscribeToComponentUpdatesOperationContext Aws::Greengrass::SubscribeToConfigurationUpdateOperationContext Aws::Greengrass::SubscribeToIoTCoreOperationContext Aws::Greengrass::SubscribeToTopicOperationContext Aws::Greengrass::SubscribeToValidateConfigurationUpdatesOperationContext Aws::Greengrass::UpdateConfigurationOperationContext Aws::Greengrass::UpdateStateOperationContext Aws::Greengrass::UpdateThingShadowOperationContext Aws::Greengrass::ValidateAuthorizationTokenOperationContext Aws::Greengrass::VerifyClientDeviceIdentityOperationContext

Public Member Functions

 OperationModelContext (const ServiceModel &serviceModel) noexcept
 
virtual ~OperationModelContext () noexcept=default
 
virtual Crt::ScopedResource< AbstractShapeBaseAllocateInitialResponseFromPayload (Crt::StringView stringView, Crt::Allocator *allocator) const noexcept=0
 
virtual Crt::ScopedResource< AbstractShapeBaseAllocateStreamingResponseFromPayload (Crt::StringView stringView, Crt::Allocator *allocator) const noexcept=0
 
virtual Crt::String GetInitialResponseModelName () const noexcept=0
 
virtual Crt::String GetRequestModelName () const noexcept=0
 
virtual Crt::Optional< Crt::StringGetStreamingResponseModelName () const noexcept=0
 
virtual Crt::String GetOperationName () const noexcept=0
 
Crt::ScopedResource< OperationErrorAllocateOperationErrorFromPayload (const Crt::String &errorModelName, Crt::StringView stringView, Crt::Allocator *allocator) const noexcept
 

Detailed Description

All generated model types implement this interface, including errors.

Constructor & Destructor Documentation

◆ OperationModelContext()

Aws::Eventstreamrpc::OperationModelContext::OperationModelContext ( const ServiceModel serviceModel)
noexcept

◆ ~OperationModelContext()

virtual Aws::Eventstreamrpc::OperationModelContext::~OperationModelContext ( )
virtualdefaultnoexcept

Member Function Documentation

◆ AllocateInitialResponseFromPayload()

virtual Crt::ScopedResource<AbstractShapeBase> Aws::Eventstreamrpc::OperationModelContext::AllocateInitialResponseFromPayload ( Crt::StringView  stringView,
Crt::Allocator allocator 
) const
pure virtualnoexcept

Parse the given string into an initial response object.

Parameters
stringViewString to parse the response from.
allocatorAllocator to use.
Returns
The initial response object.

Implemented in Aws::Greengrass::CreateLocalDeploymentOperationContext, Aws::Greengrass::PauseComponentOperationContext, Aws::Greengrass::StopComponentOperationContext, Aws::Greengrass::ListLocalDeploymentsOperationContext, Aws::Greengrass::SubscribeToComponentUpdatesOperationContext, Aws::Greengrass::ListNamedShadowsForThingOperationContext, Aws::Greengrass::CancelLocalDeploymentOperationContext, Aws::Greengrass::UpdateStateOperationContext, Aws::Greengrass::GetSecretValueOperationContext, Aws::Greengrass::GetLocalDeploymentStatusOperationContext, Aws::Greengrass::RestartComponentOperationContext, Aws::Greengrass::ValidateAuthorizationTokenOperationContext, Aws::Greengrass::UpdateConfigurationOperationContext, Aws::Greengrass::UpdateThingShadowOperationContext, Aws::Greengrass::SendConfigurationValidityReportOperationContext, Aws::Greengrass::GetThingShadowOperationContext, Aws::Greengrass::CreateDebugPasswordOperationContext, Aws::Greengrass::ListComponentsOperationContext, Aws::Greengrass::AuthorizeClientDeviceActionOperationContext, Aws::Greengrass::VerifyClientDeviceIdentityOperationContext, Aws::Greengrass::SubscribeToCertificateUpdatesOperationContext, Aws::Greengrass::PublishToTopicOperationContext, Aws::Greengrass::GetClientDeviceAuthTokenOperationContext, Aws::Greengrass::GetComponentDetailsOperationContext, Aws::Greengrass::SubscribeToTopicOperationContext, Aws::Greengrass::GetConfigurationOperationContext, Aws::Greengrass::SubscribeToValidateConfigurationUpdatesOperationContext, Aws::Greengrass::DeferComponentUpdateOperationContext, Aws::Greengrass::PutComponentMetricOperationContext, Aws::Greengrass::DeleteThingShadowOperationContext, Aws::Greengrass::SubscribeToConfigurationUpdateOperationContext, Aws::Greengrass::PublishToIoTCoreOperationContext, Aws::Greengrass::ResumeComponentOperationContext, and Aws::Greengrass::SubscribeToIoTCoreOperationContext.

◆ AllocateOperationErrorFromPayload()

Crt::ScopedResource<OperationError> Aws::Eventstreamrpc::OperationModelContext::AllocateOperationErrorFromPayload ( const Crt::String errorModelName,
Crt::StringView  stringView,
Crt::Allocator allocator 
) const
inlinenoexcept

Parse the given string into an operation error.

Parameters
errorModelNameThe model name.
stringViewString to parse the error from.
allocatorAllocator to use.
Returns
The operation error.

◆ AllocateStreamingResponseFromPayload()

virtual Crt::ScopedResource<AbstractShapeBase> Aws::Eventstreamrpc::OperationModelContext::AllocateStreamingResponseFromPayload ( Crt::StringView  stringView,
Crt::Allocator allocator 
) const
pure virtualnoexcept

Parse the given string into a streaming response object.

Parameters
stringViewString to parse the response from.
allocatorAllocator to use.
Returns
The streaming response object.

Implemented in Aws::Greengrass::CreateLocalDeploymentOperationContext, Aws::Greengrass::PauseComponentOperationContext, Aws::Greengrass::StopComponentOperationContext, Aws::Greengrass::ListLocalDeploymentsOperationContext, Aws::Greengrass::SubscribeToComponentUpdatesOperationContext, Aws::Greengrass::ListNamedShadowsForThingOperationContext, Aws::Greengrass::CancelLocalDeploymentOperationContext, Aws::Greengrass::UpdateStateOperationContext, Aws::Greengrass::GetSecretValueOperationContext, Aws::Greengrass::GetLocalDeploymentStatusOperationContext, Aws::Greengrass::RestartComponentOperationContext, Aws::Greengrass::ValidateAuthorizationTokenOperationContext, Aws::Greengrass::UpdateConfigurationOperationContext, Aws::Greengrass::UpdateThingShadowOperationContext, Aws::Greengrass::SendConfigurationValidityReportOperationContext, Aws::Greengrass::GetThingShadowOperationContext, Aws::Greengrass::CreateDebugPasswordOperationContext, Aws::Greengrass::ListComponentsOperationContext, Aws::Greengrass::AuthorizeClientDeviceActionOperationContext, Aws::Greengrass::VerifyClientDeviceIdentityOperationContext, Aws::Greengrass::SubscribeToCertificateUpdatesOperationContext, Aws::Greengrass::PublishToTopicOperationContext, Aws::Greengrass::GetClientDeviceAuthTokenOperationContext, Aws::Greengrass::GetComponentDetailsOperationContext, Aws::Greengrass::SubscribeToTopicOperationContext, Aws::Greengrass::GetConfigurationOperationContext, Aws::Greengrass::SubscribeToValidateConfigurationUpdatesOperationContext, Aws::Greengrass::DeferComponentUpdateOperationContext, Aws::Greengrass::PutComponentMetricOperationContext, Aws::Greengrass::DeleteThingShadowOperationContext, Aws::Greengrass::SubscribeToConfigurationUpdateOperationContext, Aws::Greengrass::PublishToIoTCoreOperationContext, Aws::Greengrass::ResumeComponentOperationContext, and Aws::Greengrass::SubscribeToIoTCoreOperationContext.

◆ GetInitialResponseModelName()

virtual Crt::String Aws::Eventstreamrpc::OperationModelContext::GetInitialResponseModelName ( ) const
pure virtualnoexcept

Get the initial response type name.

Returns
The initial response type name.

Implemented in Aws::Greengrass::CreateLocalDeploymentOperationContext, Aws::Greengrass::PauseComponentOperationContext, Aws::Greengrass::StopComponentOperationContext, Aws::Greengrass::ListLocalDeploymentsOperationContext, Aws::Greengrass::SubscribeToComponentUpdatesOperationContext, Aws::Greengrass::ListNamedShadowsForThingOperationContext, Aws::Greengrass::CancelLocalDeploymentOperationContext, Aws::Greengrass::UpdateStateOperationContext, Aws::Greengrass::GetSecretValueOperationContext, Aws::Greengrass::GetLocalDeploymentStatusOperationContext, Aws::Greengrass::RestartComponentOperationContext, Aws::Greengrass::ValidateAuthorizationTokenOperationContext, Aws::Greengrass::UpdateConfigurationOperationContext, Aws::Greengrass::UpdateThingShadowOperationContext, Aws::Greengrass::SendConfigurationValidityReportOperationContext, Aws::Greengrass::GetThingShadowOperationContext, Aws::Greengrass::CreateDebugPasswordOperationContext, Aws::Greengrass::ListComponentsOperationContext, Aws::Greengrass::AuthorizeClientDeviceActionOperationContext, Aws::Greengrass::VerifyClientDeviceIdentityOperationContext, Aws::Greengrass::SubscribeToCertificateUpdatesOperationContext, Aws::Greengrass::PublishToTopicOperationContext, Aws::Greengrass::GetClientDeviceAuthTokenOperationContext, Aws::Greengrass::GetComponentDetailsOperationContext, Aws::Greengrass::SubscribeToTopicOperationContext, Aws::Greengrass::GetConfigurationOperationContext, Aws::Greengrass::SubscribeToValidateConfigurationUpdatesOperationContext, Aws::Greengrass::DeferComponentUpdateOperationContext, Aws::Greengrass::PutComponentMetricOperationContext, Aws::Greengrass::DeleteThingShadowOperationContext, Aws::Greengrass::SubscribeToConfigurationUpdateOperationContext, Aws::Greengrass::PublishToIoTCoreOperationContext, Aws::Greengrass::ResumeComponentOperationContext, and Aws::Greengrass::SubscribeToIoTCoreOperationContext.

◆ GetOperationName()

virtual Crt::String Aws::Eventstreamrpc::OperationModelContext::GetOperationName ( ) const
pure virtualnoexcept

Returns the canonical operation name associated with this context across any client language. Namespace included. Example: aws.greengrass::SubscribeToTopic

Returns
The canonical operation name associated with this context across any client language.

Implemented in Aws::Greengrass::CreateLocalDeploymentOperationContext, Aws::Greengrass::PauseComponentOperationContext, Aws::Greengrass::StopComponentOperationContext, Aws::Greengrass::ListLocalDeploymentsOperationContext, Aws::Greengrass::SubscribeToComponentUpdatesOperationContext, Aws::Greengrass::ListNamedShadowsForThingOperationContext, Aws::Greengrass::CancelLocalDeploymentOperationContext, Aws::Greengrass::UpdateStateOperationContext, Aws::Greengrass::GetSecretValueOperationContext, Aws::Greengrass::GetLocalDeploymentStatusOperationContext, Aws::Greengrass::RestartComponentOperationContext, Aws::Greengrass::ValidateAuthorizationTokenOperationContext, Aws::Greengrass::UpdateConfigurationOperationContext, Aws::Greengrass::UpdateThingShadowOperationContext, Aws::Greengrass::SendConfigurationValidityReportOperationContext, Aws::Greengrass::GetThingShadowOperationContext, Aws::Greengrass::CreateDebugPasswordOperationContext, Aws::Greengrass::ListComponentsOperationContext, Aws::Greengrass::AuthorizeClientDeviceActionOperationContext, Aws::Greengrass::VerifyClientDeviceIdentityOperationContext, Aws::Greengrass::SubscribeToCertificateUpdatesOperationContext, Aws::Greengrass::PublishToTopicOperationContext, Aws::Greengrass::GetClientDeviceAuthTokenOperationContext, Aws::Greengrass::GetComponentDetailsOperationContext, Aws::Greengrass::SubscribeToTopicOperationContext, Aws::Greengrass::GetConfigurationOperationContext, Aws::Greengrass::SubscribeToValidateConfigurationUpdatesOperationContext, Aws::Greengrass::DeferComponentUpdateOperationContext, Aws::Greengrass::PutComponentMetricOperationContext, Aws::Greengrass::DeleteThingShadowOperationContext, Aws::Greengrass::SubscribeToConfigurationUpdateOperationContext, Aws::Greengrass::PublishToIoTCoreOperationContext, Aws::Greengrass::ResumeComponentOperationContext, and Aws::Greengrass::SubscribeToIoTCoreOperationContext.

◆ GetRequestModelName()

virtual Crt::String Aws::Eventstreamrpc::OperationModelContext::GetRequestModelName ( ) const
pure virtualnoexcept

Get the request type name.

Returns
The request type name.

Implemented in Aws::Greengrass::CreateLocalDeploymentOperationContext, Aws::Greengrass::PauseComponentOperationContext, Aws::Greengrass::StopComponentOperationContext, Aws::Greengrass::ListLocalDeploymentsOperationContext, Aws::Greengrass::SubscribeToComponentUpdatesOperationContext, Aws::Greengrass::ListNamedShadowsForThingOperationContext, Aws::Greengrass::CancelLocalDeploymentOperationContext, Aws::Greengrass::UpdateStateOperationContext, Aws::Greengrass::GetSecretValueOperationContext, Aws::Greengrass::GetLocalDeploymentStatusOperationContext, Aws::Greengrass::RestartComponentOperationContext, Aws::Greengrass::ValidateAuthorizationTokenOperationContext, Aws::Greengrass::UpdateConfigurationOperationContext, Aws::Greengrass::UpdateThingShadowOperationContext, Aws::Greengrass::SendConfigurationValidityReportOperationContext, Aws::Greengrass::GetThingShadowOperationContext, Aws::Greengrass::CreateDebugPasswordOperationContext, Aws::Greengrass::ListComponentsOperationContext, Aws::Greengrass::AuthorizeClientDeviceActionOperationContext, Aws::Greengrass::VerifyClientDeviceIdentityOperationContext, Aws::Greengrass::SubscribeToCertificateUpdatesOperationContext, Aws::Greengrass::PublishToTopicOperationContext, Aws::Greengrass::GetClientDeviceAuthTokenOperationContext, Aws::Greengrass::GetComponentDetailsOperationContext, Aws::Greengrass::SubscribeToTopicOperationContext, Aws::Greengrass::GetConfigurationOperationContext, Aws::Greengrass::SubscribeToValidateConfigurationUpdatesOperationContext, Aws::Greengrass::DeferComponentUpdateOperationContext, Aws::Greengrass::PutComponentMetricOperationContext, Aws::Greengrass::DeleteThingShadowOperationContext, Aws::Greengrass::SubscribeToConfigurationUpdateOperationContext, Aws::Greengrass::PublishToIoTCoreOperationContext, Aws::Greengrass::ResumeComponentOperationContext, and Aws::Greengrass::SubscribeToIoTCoreOperationContext.

◆ GetStreamingResponseModelName()

virtual Crt::Optional<Crt::String> Aws::Eventstreamrpc::OperationModelContext::GetStreamingResponseModelName ( ) const
pure virtualnoexcept

Get the streaming response type name.

Returns
The streaming response type name.

Implemented in Aws::Greengrass::CreateLocalDeploymentOperationContext, Aws::Greengrass::PauseComponentOperationContext, Aws::Greengrass::StopComponentOperationContext, Aws::Greengrass::ListLocalDeploymentsOperationContext, Aws::Greengrass::SubscribeToComponentUpdatesOperationContext, Aws::Greengrass::ListNamedShadowsForThingOperationContext, Aws::Greengrass::CancelLocalDeploymentOperationContext, Aws::Greengrass::UpdateStateOperationContext, Aws::Greengrass::GetSecretValueOperationContext, Aws::Greengrass::GetLocalDeploymentStatusOperationContext, Aws::Greengrass::RestartComponentOperationContext, Aws::Greengrass::ValidateAuthorizationTokenOperationContext, Aws::Greengrass::UpdateConfigurationOperationContext, Aws::Greengrass::UpdateThingShadowOperationContext, Aws::Greengrass::SendConfigurationValidityReportOperationContext, Aws::Greengrass::GetThingShadowOperationContext, Aws::Greengrass::CreateDebugPasswordOperationContext, Aws::Greengrass::ListComponentsOperationContext, Aws::Greengrass::AuthorizeClientDeviceActionOperationContext, Aws::Greengrass::VerifyClientDeviceIdentityOperationContext, Aws::Greengrass::SubscribeToCertificateUpdatesOperationContext, Aws::Greengrass::PublishToTopicOperationContext, Aws::Greengrass::GetClientDeviceAuthTokenOperationContext, Aws::Greengrass::GetComponentDetailsOperationContext, Aws::Greengrass::SubscribeToTopicOperationContext, Aws::Greengrass::GetConfigurationOperationContext, Aws::Greengrass::SubscribeToValidateConfigurationUpdatesOperationContext, Aws::Greengrass::DeferComponentUpdateOperationContext, Aws::Greengrass::PutComponentMetricOperationContext, Aws::Greengrass::DeleteThingShadowOperationContext, Aws::Greengrass::SubscribeToConfigurationUpdateOperationContext, Aws::Greengrass::PublishToIoTCoreOperationContext, Aws::Greengrass::ResumeComponentOperationContext, and Aws::Greengrass::SubscribeToIoTCoreOperationContext.


The documentation for this class was generated from the following files: