/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Http { class URI; } //namespace Http namespace IoT { namespace Model { /** *

The input for the ListThings operation.

See Also:

AWS * API Reference

*/ class ListThingsRequest : public IoTRequest { public: AWS_IOT_API ListThingsRequest(); // 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 "ListThings"; } AWS_IOT_API Aws::String SerializePayload() const override; AWS_IOT_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; /** *

To retrieve the next set of results, the nextToken value from a * previous response; otherwise null to receive the first set of * results.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

To retrieve the next set of results, the nextToken value from a * previous response; otherwise null to receive the first set of * results.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

To retrieve the next set of results, the nextToken value from a * previous response; otherwise null to receive the first set of * results.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

To retrieve the next set of results, the nextToken value from a * previous response; otherwise null to receive the first set of * results.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

To retrieve the next set of results, the nextToken value from a * previous response; otherwise null to receive the first set of * results.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

To retrieve the next set of results, the nextToken value from a * previous response; otherwise null to receive the first set of * results.

*/ inline ListThingsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

To retrieve the next set of results, the nextToken value from a * previous response; otherwise null to receive the first set of * results.

*/ inline ListThingsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

To retrieve the next set of results, the nextToken value from a * previous response; otherwise null to receive the first set of * results.

*/ inline ListThingsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

The maximum number of results to return in this operation.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

The maximum number of results to return in this operation.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

The maximum number of results to return in this operation.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

The maximum number of results to return in this operation.

*/ inline ListThingsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

The attribute name used to search for things.

*/ inline const Aws::String& GetAttributeName() const{ return m_attributeName; } /** *

The attribute name used to search for things.

*/ inline bool AttributeNameHasBeenSet() const { return m_attributeNameHasBeenSet; } /** *

The attribute name used to search for things.

*/ inline void SetAttributeName(const Aws::String& value) { m_attributeNameHasBeenSet = true; m_attributeName = value; } /** *

The attribute name used to search for things.

*/ inline void SetAttributeName(Aws::String&& value) { m_attributeNameHasBeenSet = true; m_attributeName = std::move(value); } /** *

The attribute name used to search for things.

*/ inline void SetAttributeName(const char* value) { m_attributeNameHasBeenSet = true; m_attributeName.assign(value); } /** *

The attribute name used to search for things.

*/ inline ListThingsRequest& WithAttributeName(const Aws::String& value) { SetAttributeName(value); return *this;} /** *

The attribute name used to search for things.

*/ inline ListThingsRequest& WithAttributeName(Aws::String&& value) { SetAttributeName(std::move(value)); return *this;} /** *

The attribute name used to search for things.

*/ inline ListThingsRequest& WithAttributeName(const char* value) { SetAttributeName(value); return *this;} /** *

The attribute value used to search for things.

*/ inline const Aws::String& GetAttributeValue() const{ return m_attributeValue; } /** *

The attribute value used to search for things.

*/ inline bool AttributeValueHasBeenSet() const { return m_attributeValueHasBeenSet; } /** *

The attribute value used to search for things.

*/ inline void SetAttributeValue(const Aws::String& value) { m_attributeValueHasBeenSet = true; m_attributeValue = value; } /** *

The attribute value used to search for things.

*/ inline void SetAttributeValue(Aws::String&& value) { m_attributeValueHasBeenSet = true; m_attributeValue = std::move(value); } /** *

The attribute value used to search for things.

*/ inline void SetAttributeValue(const char* value) { m_attributeValueHasBeenSet = true; m_attributeValue.assign(value); } /** *

The attribute value used to search for things.

*/ inline ListThingsRequest& WithAttributeValue(const Aws::String& value) { SetAttributeValue(value); return *this;} /** *

The attribute value used to search for things.

*/ inline ListThingsRequest& WithAttributeValue(Aws::String&& value) { SetAttributeValue(std::move(value)); return *this;} /** *

The attribute value used to search for things.

*/ inline ListThingsRequest& WithAttributeValue(const char* value) { SetAttributeValue(value); return *this;} /** *

The name of the thing type used to search for things.

*/ inline const Aws::String& GetThingTypeName() const{ return m_thingTypeName; } /** *

The name of the thing type used to search for things.

*/ inline bool ThingTypeNameHasBeenSet() const { return m_thingTypeNameHasBeenSet; } /** *

The name of the thing type used to search for things.

*/ inline void SetThingTypeName(const Aws::String& value) { m_thingTypeNameHasBeenSet = true; m_thingTypeName = value; } /** *

The name of the thing type used to search for things.

*/ inline void SetThingTypeName(Aws::String&& value) { m_thingTypeNameHasBeenSet = true; m_thingTypeName = std::move(value); } /** *

The name of the thing type used to search for things.

*/ inline void SetThingTypeName(const char* value) { m_thingTypeNameHasBeenSet = true; m_thingTypeName.assign(value); } /** *

The name of the thing type used to search for things.

*/ inline ListThingsRequest& WithThingTypeName(const Aws::String& value) { SetThingTypeName(value); return *this;} /** *

The name of the thing type used to search for things.

*/ inline ListThingsRequest& WithThingTypeName(Aws::String&& value) { SetThingTypeName(std::move(value)); return *this;} /** *

The name of the thing type used to search for things.

*/ inline ListThingsRequest& WithThingTypeName(const char* value) { SetThingTypeName(value); return *this;} /** *

When true, the action returns the thing resources with attribute * values that start with the attributeValue provided.

When * false, or not present, the action returns only the thing resources * with attribute values that match the entire attributeValue * provided.

*/ inline bool GetUsePrefixAttributeValue() const{ return m_usePrefixAttributeValue; } /** *

When true, the action returns the thing resources with attribute * values that start with the attributeValue provided.

When * false, or not present, the action returns only the thing resources * with attribute values that match the entire attributeValue * provided.

*/ inline bool UsePrefixAttributeValueHasBeenSet() const { return m_usePrefixAttributeValueHasBeenSet; } /** *

When true, the action returns the thing resources with attribute * values that start with the attributeValue provided.

When * false, or not present, the action returns only the thing resources * with attribute values that match the entire attributeValue * provided.

*/ inline void SetUsePrefixAttributeValue(bool value) { m_usePrefixAttributeValueHasBeenSet = true; m_usePrefixAttributeValue = value; } /** *

When true, the action returns the thing resources with attribute * values that start with the attributeValue provided.

When * false, or not present, the action returns only the thing resources * with attribute values that match the entire attributeValue * provided.

*/ inline ListThingsRequest& WithUsePrefixAttributeValue(bool value) { SetUsePrefixAttributeValue(value); return *this;} private: Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_attributeName; bool m_attributeNameHasBeenSet = false; Aws::String m_attributeValue; bool m_attributeValueHasBeenSet = false; Aws::String m_thingTypeName; bool m_thingTypeNameHasBeenSet = false; bool m_usePrefixAttributeValue; bool m_usePrefixAttributeValueHasBeenSet = false; }; } // namespace Model } // namespace IoT } // namespace Aws