258 lines
10 KiB
C++
258 lines
10 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/iot/IoT_EXPORTS.h>
|
|
#include <aws/iot/IoTRequest.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/iot/model/AttributePayload.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace IoT
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
* <p>The input for the UpdateThing operation.</p><p><h3>See Also:</h3> <a
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/iot-2015-05-28/UpdateThingRequest">AWS
|
|
* API Reference</a></p>
|
|
*/
|
|
class AWS_IOT_API UpdateThingRequest : public IoTRequest
|
|
{
|
|
public:
|
|
UpdateThingRequest();
|
|
|
|
// Service request name is the Operation name which will send this request out,
|
|
// each operation should has unique request name, so that we can get operation's name from this request.
|
|
// Note: this is not true for response, multiple operations may have the same response name,
|
|
// so we can not get operation's name from response.
|
|
inline virtual const char* GetServiceRequestName() const override { return "UpdateThing"; }
|
|
|
|
Aws::String SerializePayload() const override;
|
|
|
|
|
|
/**
|
|
* <p>The name of the thing to update.</p> <p>You can't change a thing's name. To
|
|
* change a thing's name, you must create a new thing, give it the new name, and
|
|
* then delete the old thing.</p>
|
|
*/
|
|
inline const Aws::String& GetThingName() const{ return m_thingName; }
|
|
|
|
/**
|
|
* <p>The name of the thing to update.</p> <p>You can't change a thing's name. To
|
|
* change a thing's name, you must create a new thing, give it the new name, and
|
|
* then delete the old thing.</p>
|
|
*/
|
|
inline bool ThingNameHasBeenSet() const { return m_thingNameHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The name of the thing to update.</p> <p>You can't change a thing's name. To
|
|
* change a thing's name, you must create a new thing, give it the new name, and
|
|
* then delete the old thing.</p>
|
|
*/
|
|
inline void SetThingName(const Aws::String& value) { m_thingNameHasBeenSet = true; m_thingName = value; }
|
|
|
|
/**
|
|
* <p>The name of the thing to update.</p> <p>You can't change a thing's name. To
|
|
* change a thing's name, you must create a new thing, give it the new name, and
|
|
* then delete the old thing.</p>
|
|
*/
|
|
inline void SetThingName(Aws::String&& value) { m_thingNameHasBeenSet = true; m_thingName = std::move(value); }
|
|
|
|
/**
|
|
* <p>The name of the thing to update.</p> <p>You can't change a thing's name. To
|
|
* change a thing's name, you must create a new thing, give it the new name, and
|
|
* then delete the old thing.</p>
|
|
*/
|
|
inline void SetThingName(const char* value) { m_thingNameHasBeenSet = true; m_thingName.assign(value); }
|
|
|
|
/**
|
|
* <p>The name of the thing to update.</p> <p>You can't change a thing's name. To
|
|
* change a thing's name, you must create a new thing, give it the new name, and
|
|
* then delete the old thing.</p>
|
|
*/
|
|
inline UpdateThingRequest& WithThingName(const Aws::String& value) { SetThingName(value); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the thing to update.</p> <p>You can't change a thing's name. To
|
|
* change a thing's name, you must create a new thing, give it the new name, and
|
|
* then delete the old thing.</p>
|
|
*/
|
|
inline UpdateThingRequest& WithThingName(Aws::String&& value) { SetThingName(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the thing to update.</p> <p>You can't change a thing's name. To
|
|
* change a thing's name, you must create a new thing, give it the new name, and
|
|
* then delete the old thing.</p>
|
|
*/
|
|
inline UpdateThingRequest& WithThingName(const char* value) { SetThingName(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The name of the thing type.</p>
|
|
*/
|
|
inline const Aws::String& GetThingTypeName() const{ return m_thingTypeName; }
|
|
|
|
/**
|
|
* <p>The name of the thing type.</p>
|
|
*/
|
|
inline bool ThingTypeNameHasBeenSet() const { return m_thingTypeNameHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The name of the thing type.</p>
|
|
*/
|
|
inline void SetThingTypeName(const Aws::String& value) { m_thingTypeNameHasBeenSet = true; m_thingTypeName = value; }
|
|
|
|
/**
|
|
* <p>The name of the thing type.</p>
|
|
*/
|
|
inline void SetThingTypeName(Aws::String&& value) { m_thingTypeNameHasBeenSet = true; m_thingTypeName = std::move(value); }
|
|
|
|
/**
|
|
* <p>The name of the thing type.</p>
|
|
*/
|
|
inline void SetThingTypeName(const char* value) { m_thingTypeNameHasBeenSet = true; m_thingTypeName.assign(value); }
|
|
|
|
/**
|
|
* <p>The name of the thing type.</p>
|
|
*/
|
|
inline UpdateThingRequest& WithThingTypeName(const Aws::String& value) { SetThingTypeName(value); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the thing type.</p>
|
|
*/
|
|
inline UpdateThingRequest& WithThingTypeName(Aws::String&& value) { SetThingTypeName(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the thing type.</p>
|
|
*/
|
|
inline UpdateThingRequest& WithThingTypeName(const char* value) { SetThingTypeName(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>A list of thing attributes, a JSON string containing name-value pairs. For
|
|
* example:</p> <p> <code>{\"attributes\":{\"name1\":\"value2\"}}</code> </p>
|
|
* <p>This data is used to add new attributes or update existing attributes.</p>
|
|
*/
|
|
inline const AttributePayload& GetAttributePayload() const{ return m_attributePayload; }
|
|
|
|
/**
|
|
* <p>A list of thing attributes, a JSON string containing name-value pairs. For
|
|
* example:</p> <p> <code>{\"attributes\":{\"name1\":\"value2\"}}</code> </p>
|
|
* <p>This data is used to add new attributes or update existing attributes.</p>
|
|
*/
|
|
inline bool AttributePayloadHasBeenSet() const { return m_attributePayloadHasBeenSet; }
|
|
|
|
/**
|
|
* <p>A list of thing attributes, a JSON string containing name-value pairs. For
|
|
* example:</p> <p> <code>{\"attributes\":{\"name1\":\"value2\"}}</code> </p>
|
|
* <p>This data is used to add new attributes or update existing attributes.</p>
|
|
*/
|
|
inline void SetAttributePayload(const AttributePayload& value) { m_attributePayloadHasBeenSet = true; m_attributePayload = value; }
|
|
|
|
/**
|
|
* <p>A list of thing attributes, a JSON string containing name-value pairs. For
|
|
* example:</p> <p> <code>{\"attributes\":{\"name1\":\"value2\"}}</code> </p>
|
|
* <p>This data is used to add new attributes or update existing attributes.</p>
|
|
*/
|
|
inline void SetAttributePayload(AttributePayload&& value) { m_attributePayloadHasBeenSet = true; m_attributePayload = std::move(value); }
|
|
|
|
/**
|
|
* <p>A list of thing attributes, a JSON string containing name-value pairs. For
|
|
* example:</p> <p> <code>{\"attributes\":{\"name1\":\"value2\"}}</code> </p>
|
|
* <p>This data is used to add new attributes or update existing attributes.</p>
|
|
*/
|
|
inline UpdateThingRequest& WithAttributePayload(const AttributePayload& value) { SetAttributePayload(value); return *this;}
|
|
|
|
/**
|
|
* <p>A list of thing attributes, a JSON string containing name-value pairs. For
|
|
* example:</p> <p> <code>{\"attributes\":{\"name1\":\"value2\"}}</code> </p>
|
|
* <p>This data is used to add new attributes or update existing attributes.</p>
|
|
*/
|
|
inline UpdateThingRequest& WithAttributePayload(AttributePayload&& value) { SetAttributePayload(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The expected version of the thing record in the registry. If the version of
|
|
* the record in the registry does not match the expected version specified in the
|
|
* request, the <code>UpdateThing</code> request is rejected with a
|
|
* <code>VersionConflictException</code>.</p>
|
|
*/
|
|
inline long long GetExpectedVersion() const{ return m_expectedVersion; }
|
|
|
|
/**
|
|
* <p>The expected version of the thing record in the registry. If the version of
|
|
* the record in the registry does not match the expected version specified in the
|
|
* request, the <code>UpdateThing</code> request is rejected with a
|
|
* <code>VersionConflictException</code>.</p>
|
|
*/
|
|
inline bool ExpectedVersionHasBeenSet() const { return m_expectedVersionHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The expected version of the thing record in the registry. If the version of
|
|
* the record in the registry does not match the expected version specified in the
|
|
* request, the <code>UpdateThing</code> request is rejected with a
|
|
* <code>VersionConflictException</code>.</p>
|
|
*/
|
|
inline void SetExpectedVersion(long long value) { m_expectedVersionHasBeenSet = true; m_expectedVersion = value; }
|
|
|
|
/**
|
|
* <p>The expected version of the thing record in the registry. If the version of
|
|
* the record in the registry does not match the expected version specified in the
|
|
* request, the <code>UpdateThing</code> request is rejected with a
|
|
* <code>VersionConflictException</code>.</p>
|
|
*/
|
|
inline UpdateThingRequest& WithExpectedVersion(long long value) { SetExpectedVersion(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Remove a thing type association. If <b>true</b>, the association is
|
|
* removed.</p>
|
|
*/
|
|
inline bool GetRemoveThingType() const{ return m_removeThingType; }
|
|
|
|
/**
|
|
* <p>Remove a thing type association. If <b>true</b>, the association is
|
|
* removed.</p>
|
|
*/
|
|
inline bool RemoveThingTypeHasBeenSet() const { return m_removeThingTypeHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Remove a thing type association. If <b>true</b>, the association is
|
|
* removed.</p>
|
|
*/
|
|
inline void SetRemoveThingType(bool value) { m_removeThingTypeHasBeenSet = true; m_removeThingType = value; }
|
|
|
|
/**
|
|
* <p>Remove a thing type association. If <b>true</b>, the association is
|
|
* removed.</p>
|
|
*/
|
|
inline UpdateThingRequest& WithRemoveThingType(bool value) { SetRemoveThingType(value); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::String m_thingName;
|
|
bool m_thingNameHasBeenSet;
|
|
|
|
Aws::String m_thingTypeName;
|
|
bool m_thingTypeNameHasBeenSet;
|
|
|
|
AttributePayload m_attributePayload;
|
|
bool m_attributePayloadHasBeenSet;
|
|
|
|
long long m_expectedVersion;
|
|
bool m_expectedVersionHasBeenSet;
|
|
|
|
bool m_removeThingType;
|
|
bool m_removeThingTypeHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace IoT
|
|
} // namespace Aws
|