Aws::Greengrass::CreateLocalDeploymentRequest Class Reference

#include <GreengrassCoreIpcModel.h>

Inheritance diagram for Aws::Greengrass::CreateLocalDeploymentRequest:

Public Member Functions
	CreateLocalDeploymentRequest () noexcept
	CreateLocalDeploymentRequest (const CreateLocalDeploymentRequest &)=default
void	SetGroupName (const Aws::Crt::String &groupName) noexcept
Aws::Crt::Optional< Aws::Crt::String >	GetGroupName () const noexcept
void	SetRootComponentVersionsToAdd (const Aws::Crt::Map< Aws::Crt::String, Aws::Crt::String > &rootComponentVersionsToAdd) noexcept
Aws::Crt::Optional< Aws::Crt::Map< Aws::Crt::String, Aws::Crt::String > >	GetRootComponentVersionsToAdd () const noexcept
void	SetRootComponentsToRemove (const Aws::Crt::Vector< Aws::Crt::String > &rootComponentsToRemove) noexcept
Aws::Crt::Optional< Aws::Crt::Vector< Aws::Crt::String > >	GetRootComponentsToRemove () const noexcept
void	SetComponentToConfiguration (const Aws::Crt::Map< Aws::Crt::String, Aws::Crt::JsonObject > &componentToConfiguration) noexcept
Aws::Crt::Optional< Aws::Crt::Map< Aws::Crt::String, Aws::Crt::JsonObject > >	GetComponentToConfiguration () const noexcept
void	SetComponentToRunWithInfo (const Aws::Crt::Map< Aws::Crt::String, RunWithInfo > &componentToRunWithInfo) noexcept
Aws::Crt::Optional< Aws::Crt::Map< Aws::Crt::String, RunWithInfo > >	GetComponentToRunWithInfo () const noexcept
void	SetRecipeDirectoryPath (const Aws::Crt::String &recipeDirectoryPath) noexcept
Aws::Crt::Optional< Aws::Crt::String >	GetRecipeDirectoryPath () const noexcept
void	SetArtifactsDirectoryPath (const Aws::Crt::String &artifactsDirectoryPath) noexcept
Aws::Crt::Optional< Aws::Crt::String >	GetArtifactsDirectoryPath () const noexcept
void	SetFailureHandlingPolicy (FailureHandlingPolicy failureHandlingPolicy) noexcept
Aws::Crt::Optional< FailureHandlingPolicy >	GetFailureHandlingPolicy () const noexcept
void	SerializeToJsonObject (Aws::Crt::JsonObject &payloadObject) const noexcept override
bool	operator< (const CreateLocalDeploymentRequest &) const noexcept
Public Member Functions inherited from Aws::Eventstreamrpc::AbstractShapeBase
	AbstractShapeBase () noexcept
virtual	~AbstractShapeBase () noexcept=default

Static Public Member Functions
static void	s_loadFromJsonView (CreateLocalDeploymentRequest &, const Aws::Crt::JsonView &) noexcept
static Aws::Crt::ScopedResource< AbstractShapeBase >	s_allocateFromPayload (Aws::Crt::StringView, Aws::Crt::Allocator *) noexcept
static void	s_customDeleter (CreateLocalDeploymentRequest *) 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#CreateLocalDeploymentRequest"

Protected Member Functions
Aws::Crt::String	GetModelName () const noexcept override

Additional Inherited Members
Protected Attributes inherited from Aws::Eventstreamrpc::AbstractShapeBase
Crt::Allocator *	m_allocator

Constructor & Destructor Documentation

CreateLocalDeploymentRequest() [1/2]

Aws::Greengrass::CreateLocalDeploymentRequest::CreateLocalDeploymentRequest ( )

inlinenoexcept

CreateLocalDeploymentRequest() [2/2]

Aws::Greengrass::CreateLocalDeploymentRequest::CreateLocalDeploymentRequest ( const CreateLocalDeploymentRequest & )

default

Member Function Documentation

GetArtifactsDirectoryPath()

Aws::Crt::Optional< Aws::Crt::String > Aws::Greengrass::CreateLocalDeploymentRequest::GetArtifactsDirectoryPath ( ) const

inlinenoexcept

All artifact files in this directory will be copied over to the Greengrass package store.

GetComponentToConfiguration()

Aws::Crt::Optional< Aws::Crt::Map< Aws::Crt::String, Aws::Crt::JsonObject > > Aws::Greengrass::CreateLocalDeploymentRequest::GetComponentToConfiguration ( ) const

inlinenoexcept

Map of component names to configuration.

GetComponentToRunWithInfo()

Aws::Crt::Optional< Aws::Crt::Map< Aws::Crt::String, RunWithInfo > > Aws::Greengrass::CreateLocalDeploymentRequest::GetComponentToRunWithInfo ( ) const

inlinenoexcept

Map of component names to component run as info.

GetFailureHandlingPolicy()

Aws::Crt::Optional< FailureHandlingPolicy > Aws::Greengrass::CreateLocalDeploymentRequest::GetFailureHandlingPolicy ( ) const

noexcept

Deployment failure handling policy.

GetGroupName()

Aws::Crt::Optional< Aws::Crt::String > Aws::Greengrass::CreateLocalDeploymentRequest::GetGroupName ( ) const

inlinenoexcept

The thing group name the deployment is targeting. If the group name is not specified, "LOCAL_DEPLOYMENT" will be used.

GetModelName()

Aws::Crt::String Aws::Greengrass::CreateLocalDeploymentRequest::GetModelName ( ) const

overrideprotectedvirtualnoexcept

Implements Aws::Eventstreamrpc::AbstractShapeBase.

GetRecipeDirectoryPath()

Aws::Crt::Optional< Aws::Crt::String > Aws::Greengrass::CreateLocalDeploymentRequest::GetRecipeDirectoryPath ( ) const

inlinenoexcept

All recipes files in this directory will be copied over to the Greengrass package store.

GetRootComponentsToRemove()

Aws::Crt::Optional< Aws::Crt::Vector< Aws::Crt::String > > Aws::Greengrass::CreateLocalDeploymentRequest::GetRootComponentsToRemove ( ) const

inlinenoexcept

List of components that need to be removed from the group, for example if new artifacts were loaded in this request but recipe version did not change.

GetRootComponentVersionsToAdd()

Aws::Crt::Optional< Aws::Crt::Map< Aws::Crt::String, Aws::Crt::String > > Aws::Greengrass::CreateLocalDeploymentRequest::GetRootComponentVersionsToAdd ( ) const

inlinenoexcept

Map of component name to version. Components will be added to the group's existing root components.

operator<()

bool Aws::Greengrass::CreateLocalDeploymentRequest::operator< ( const CreateLocalDeploymentRequest & ) const

noexcept

s_allocateFromPayload()

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

staticnoexcept

s_customDeleter()

void Aws::Greengrass::CreateLocalDeploymentRequest::s_customDeleter ( CreateLocalDeploymentRequest * shape )

staticnoexcept

s_loadFromJsonView()

void Aws::Greengrass::CreateLocalDeploymentRequest::s_loadFromJsonView ( CreateLocalDeploymentRequest & createLocalDeploymentRequest, const Aws::Crt::JsonView & jsonView )

staticnoexcept

SerializeToJsonObject()

void Aws::Greengrass::CreateLocalDeploymentRequest::SerializeToJsonObject ( Aws::Crt::JsonObject & payloadObject ) const

overridevirtualnoexcept

Implements Aws::Eventstreamrpc::AbstractShapeBase.

SetArtifactsDirectoryPath()

void Aws::Greengrass::CreateLocalDeploymentRequest::SetArtifactsDirectoryPath ( const Aws::Crt::String & artifactsDirectoryPath )

inlinenoexcept

All artifact files in this directory will be copied over to the Greengrass package store.

SetComponentToConfiguration()

void Aws::Greengrass::CreateLocalDeploymentRequest::SetComponentToConfiguration ( const Aws::Crt::Map< Aws::Crt::String, Aws::Crt::JsonObject > & componentToConfiguration )

inlinenoexcept

Map of component names to configuration.

SetComponentToRunWithInfo()

void Aws::Greengrass::CreateLocalDeploymentRequest::SetComponentToRunWithInfo ( const Aws::Crt::Map< Aws::Crt::String, RunWithInfo > & componentToRunWithInfo )

inlinenoexcept

Map of component names to component run as info.

SetFailureHandlingPolicy()

void Aws::Greengrass::CreateLocalDeploymentRequest::SetFailureHandlingPolicy ( FailureHandlingPolicy failureHandlingPolicy )

noexcept

Deployment failure handling policy.

SetGroupName()

void Aws::Greengrass::CreateLocalDeploymentRequest::SetGroupName ( const Aws::Crt::String & groupName )

inlinenoexcept

The thing group name the deployment is targeting. If the group name is not specified, "LOCAL_DEPLOYMENT" will be used.

SetRecipeDirectoryPath()

void Aws::Greengrass::CreateLocalDeploymentRequest::SetRecipeDirectoryPath ( const Aws::Crt::String & recipeDirectoryPath )

inlinenoexcept

All recipes files in this directory will be copied over to the Greengrass package store.

SetRootComponentsToRemove()

void Aws::Greengrass::CreateLocalDeploymentRequest::SetRootComponentsToRemove ( const Aws::Crt::Vector< Aws::Crt::String > & rootComponentsToRemove )

inlinenoexcept

List of components that need to be removed from the group, for example if new artifacts were loaded in this request but recipe version did not change.

SetRootComponentVersionsToAdd()

void Aws::Greengrass::CreateLocalDeploymentRequest::SetRootComponentVersionsToAdd ( const Aws::Crt::Map< Aws::Crt::String, Aws::Crt::String > & rootComponentVersionsToAdd )

inlinenoexcept

Map of component name to version. Components will be added to the group's existing root components.

Member Data Documentation

MODEL_NAME

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

static

---

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

• greengrass_ipc/include/aws/greengrass/GreengrassCoreIpcModel.h
• greengrass_ipc/source/GreengrassCoreIpcModel.cpp