AWS IoT Device SDK C++ v2  1.34.0
AWS IoT Device SDK C++ v2
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
Aws::Greengrass::DeferComponentUpdateRequest Class Reference

#include <GreengrassCoreIpcModel.h>

Inheritance diagram for Aws::Greengrass::DeferComponentUpdateRequest:
Aws::Eventstreamrpc::AbstractShapeBase

Public Member Functions

 DeferComponentUpdateRequest () noexcept
 
 DeferComponentUpdateRequest (const DeferComponentUpdateRequest &)=default
 
void SetDeploymentId (const Aws::Crt::String &deploymentId) noexcept
 
Aws::Crt::Optional< Aws::Crt::StringGetDeploymentId () noexcept
 
void SetMessage (const Aws::Crt::String &message) noexcept
 
Aws::Crt::Optional< Aws::Crt::StringGetMessage () noexcept
 
void SetRecheckAfterMs (const int64_t &recheckAfterMs) noexcept
 
Aws::Crt::Optional< int64_t > GetRecheckAfterMs () noexcept
 
void SerializeToJsonObject (Aws::Crt::JsonObject &payloadObject) const noexcept override
 
bool operator< (const DeferComponentUpdateRequest &) const noexcept
 
- Public Member Functions inherited from Aws::Eventstreamrpc::AbstractShapeBase
 AbstractShapeBase () noexcept
 
virtual ~AbstractShapeBase () noexcept=default
 

Static Public Member Functions

static void s_loadFromJsonView (DeferComponentUpdateRequest &, const Aws::Crt::JsonView &) noexcept
 
static Aws::Crt::ScopedResource< AbstractShapeBases_allocateFromPayload (Aws::Crt::StringView, Aws::Crt::Allocator *) noexcept
 
static void s_customDeleter (DeferComponentUpdateRequest *) noexcept
 
- Static Public Member Functions inherited from Aws::Eventstreamrpc::AbstractShapeBase
static void s_customDeleter (AbstractShapeBase *shape) noexcept
 

Static Public Attributes

static const char * MODEL_NAME = "aws.greengrass#DeferComponentUpdateRequest"
 

Protected Member Functions

Aws::Crt::String GetModelName () const noexcept override
 

Additional Inherited Members

- Protected Attributes inherited from Aws::Eventstreamrpc::AbstractShapeBase
Crt::Allocatorm_allocator
 

Constructor & Destructor Documentation

◆ DeferComponentUpdateRequest() [1/2]

Aws::Greengrass::DeferComponentUpdateRequest::DeferComponentUpdateRequest ( )
inlinenoexcept

◆ DeferComponentUpdateRequest() [2/2]

Aws::Greengrass::DeferComponentUpdateRequest::DeferComponentUpdateRequest ( const DeferComponentUpdateRequest )
default

Member Function Documentation

◆ GetDeploymentId()

Aws::Crt::Optional<Aws::Crt::String> Aws::Greengrass::DeferComponentUpdateRequest::GetDeploymentId ( )
inlinenoexcept

The ID of the AWS IoT Greengrass deployment to defer.

◆ GetMessage()

Aws::Crt::Optional<Aws::Crt::String> Aws::Greengrass::DeferComponentUpdateRequest::GetMessage ( )
inlinenoexcept

(Optional) The name of the component for which to defer updates. Defaults to the name of the component that makes the request.

◆ GetModelName()

Aws::Crt::String Aws::Greengrass::DeferComponentUpdateRequest::GetModelName ( ) const
overrideprotectedvirtualnoexcept

◆ GetRecheckAfterMs()

Aws::Crt::Optional<int64_t> Aws::Greengrass::DeferComponentUpdateRequest::GetRecheckAfterMs ( )
inlinenoexcept

The amount of time in milliseconds for which to defer the update. Greengrass waits for this amount of time and then sends another PreComponentUpdateEvent

◆ operator<()

bool Aws::Greengrass::DeferComponentUpdateRequest::operator< ( const DeferComponentUpdateRequest ) const
noexcept

◆ s_allocateFromPayload()

Aws::Crt::ScopedResource< AbstractShapeBase > Aws::Greengrass::DeferComponentUpdateRequest::s_allocateFromPayload ( Aws::Crt::StringView  stringView,
Aws::Crt::Allocator allocator 
)
staticnoexcept

◆ s_customDeleter()

void Aws::Greengrass::DeferComponentUpdateRequest::s_customDeleter ( DeferComponentUpdateRequest shape)
staticnoexcept

◆ s_loadFromJsonView()

void Aws::Greengrass::DeferComponentUpdateRequest::s_loadFromJsonView ( DeferComponentUpdateRequest deferComponentUpdateRequest,
const Aws::Crt::JsonView jsonView 
)
staticnoexcept

◆ SerializeToJsonObject()

void Aws::Greengrass::DeferComponentUpdateRequest::SerializeToJsonObject ( Aws::Crt::JsonObject payloadObject) const
overridevirtualnoexcept

◆ SetDeploymentId()

void Aws::Greengrass::DeferComponentUpdateRequest::SetDeploymentId ( const Aws::Crt::String deploymentId)
inlinenoexcept

The ID of the AWS IoT Greengrass deployment to defer.

◆ SetMessage()

void Aws::Greengrass::DeferComponentUpdateRequest::SetMessage ( const Aws::Crt::String message)
inlinenoexcept

(Optional) The name of the component for which to defer updates. Defaults to the name of the component that makes the request.

◆ SetRecheckAfterMs()

void Aws::Greengrass::DeferComponentUpdateRequest::SetRecheckAfterMs ( const int64_t &  recheckAfterMs)
inlinenoexcept

The amount of time in milliseconds for which to defer the update. Greengrass waits for this amount of time and then sends another PreComponentUpdateEvent

Member Data Documentation

◆ MODEL_NAME

const char * Aws::Greengrass::DeferComponentUpdateRequest::MODEL_NAME = "aws.greengrass#DeferComponentUpdateRequest"
static

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