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::UpdateConfigurationRequest Class Reference

#include <GreengrassCoreIpcModel.h>

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

Public Member Functions

 UpdateConfigurationRequest () noexcept
 
 UpdateConfigurationRequest (const UpdateConfigurationRequest &)=default
 
void SetKeyPath (const Aws::Crt::Vector< Aws::Crt::String > &keyPath) noexcept
 
Aws::Crt::Optional< Aws::Crt::Vector< Aws::Crt::String > > GetKeyPath () noexcept
 
void SetTimestamp (const Aws::Crt::DateTime &timestamp) noexcept
 
Aws::Crt::Optional< Aws::Crt::DateTimeGetTimestamp () noexcept
 
void SetValueToMerge (const Aws::Crt::JsonObject &valueToMerge) noexcept
 
Aws::Crt::Optional< Aws::Crt::JsonObjectGetValueToMerge () noexcept
 
void SerializeToJsonObject (Aws::Crt::JsonObject &payloadObject) const noexcept override
 
bool operator< (const UpdateConfigurationRequest &) const noexcept
 
- Public Member Functions inherited from Aws::Eventstreamrpc::AbstractShapeBase
 AbstractShapeBase () noexcept
 
virtual ~AbstractShapeBase () noexcept=default
 

Static Public Member Functions

static void s_loadFromJsonView (UpdateConfigurationRequest &, const Aws::Crt::JsonView &) noexcept
 
static Aws::Crt::ScopedResource< AbstractShapeBases_allocateFromPayload (Aws::Crt::StringView, Aws::Crt::Allocator *) noexcept
 
static void s_customDeleter (UpdateConfigurationRequest *) 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#UpdateConfigurationRequest"
 

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

◆ UpdateConfigurationRequest() [1/2]

Aws::Greengrass::UpdateConfigurationRequest::UpdateConfigurationRequest ( )
inlinenoexcept

◆ UpdateConfigurationRequest() [2/2]

Aws::Greengrass::UpdateConfigurationRequest::UpdateConfigurationRequest ( const UpdateConfigurationRequest )
default

Member Function Documentation

◆ GetKeyPath()

Aws::Crt::Optional<Aws::Crt::Vector<Aws::Crt::String> > Aws::Greengrass::UpdateConfigurationRequest::GetKeyPath ( )
inlinenoexcept

(Optional) The key path to the container node (the object) to update. Specify a list where each entry is the key for a single level in the configuration object. Defaults to the root of the configuration object.

◆ GetModelName()

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

◆ GetTimestamp()

Aws::Crt::Optional<Aws::Crt::DateTime> Aws::Greengrass::UpdateConfigurationRequest::GetTimestamp ( )
inlinenoexcept

The current Unix epoch time in milliseconds. This operation uses this timestamp to resolve concurrent updates to the key. If the key in the component configuration has a greater timestamp than the timestamp in the request, then the request fails.

◆ GetValueToMerge()

Aws::Crt::Optional<Aws::Crt::JsonObject> Aws::Greengrass::UpdateConfigurationRequest::GetValueToMerge ( )
inlinenoexcept

The configuration object to merge at the location that you specify in keyPath.

◆ operator<()

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

◆ s_allocateFromPayload()

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

◆ s_customDeleter()

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

◆ s_loadFromJsonView()

void Aws::Greengrass::UpdateConfigurationRequest::s_loadFromJsonView ( UpdateConfigurationRequest updateConfigurationRequest,
const Aws::Crt::JsonView jsonView 
)
staticnoexcept

◆ SerializeToJsonObject()

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

◆ SetKeyPath()

void Aws::Greengrass::UpdateConfigurationRequest::SetKeyPath ( const Aws::Crt::Vector< Aws::Crt::String > &  keyPath)
inlinenoexcept

(Optional) The key path to the container node (the object) to update. Specify a list where each entry is the key for a single level in the configuration object. Defaults to the root of the configuration object.

◆ SetTimestamp()

void Aws::Greengrass::UpdateConfigurationRequest::SetTimestamp ( const Aws::Crt::DateTime timestamp)
inlinenoexcept

The current Unix epoch time in milliseconds. This operation uses this timestamp to resolve concurrent updates to the key. If the key in the component configuration has a greater timestamp than the timestamp in the request, then the request fails.

◆ SetValueToMerge()

void Aws::Greengrass::UpdateConfigurationRequest::SetValueToMerge ( const Aws::Crt::JsonObject valueToMerge)
inlinenoexcept

The configuration object to merge at the location that you specify in keyPath.

Member Data Documentation

◆ MODEL_NAME

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

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