/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the iot-2015-05-28.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.IoT.Model
{
///
/// Container for the parameters to the ListThings operation.
/// Lists your things. Use the attributeName and attributeValue parameters
/// to filter your things. For example, calling ListThings
with attributeName=Color
/// and attributeValue=Red retrieves all things in the registry that contain an attribute
/// Color with the value Red. For more information, see List
/// Things from the Amazon Web Services IoT Core Developer Guide.
///
///
///
/// Requires permission to access the ListThings
/// action.
///
///
///
/// You will not be charged for calling this API if an Access denied
error
/// is returned. You will also not be charged if no attributes or pagination token was
/// provided in request and no pagination token and no results were returned.
///
///
///
public partial class ListThingsRequest : AmazonIoTRequest
{
private string _attributeName;
private string _attributeValue;
private string _marker;
private int? _maxResults;
private string _thingTypeName;
private bool? _usePrefixAttributeValue;
///
/// Gets and sets the property AttributeName.
///
/// The attribute name used to search for things.
///
///
[AWSProperty(Max=128)]
public string AttributeName
{
get { return this._attributeName; }
set { this._attributeName = value; }
}
// Check to see if AttributeName property is set
internal bool IsSetAttributeName()
{
return this._attributeName != null;
}
///
/// Gets and sets the property AttributeValue.
///
/// The attribute value used to search for things.
///
///
[AWSProperty(Max=800)]
public string AttributeValue
{
get { return this._attributeValue; }
set { this._attributeValue = value; }
}
// Check to see if AttributeValue property is set
internal bool IsSetAttributeValue()
{
return this._attributeValue != null;
}
///
/// Gets and sets the property Marker.
///
/// To retrieve the next set of results, the nextToken
value from a previous
/// response; otherwise null to receive the first set of results.
///
///
public string Marker
{
get { return this._marker; }
set { this._marker = value; }
}
// Check to see if Marker property is set
internal bool IsSetMarker()
{
return this._marker != null;
}
///
/// Gets and sets the property MaxResults.
///
/// The maximum number of results to return in this operation.
///
///
[AWSProperty(Min=1, Max=250)]
public int MaxResults
{
get { return this._maxResults.GetValueOrDefault(); }
set { this._maxResults = value; }
}
// Check to see if MaxResults property is set
internal bool IsSetMaxResults()
{
return this._maxResults.HasValue;
}
///
/// Gets and sets the property ThingTypeName.
///
/// The name of the thing type used to search for things.
///
///
[AWSProperty(Min=1, Max=128)]
public string ThingTypeName
{
get { return this._thingTypeName; }
set { this._thingTypeName = value; }
}
// Check to see if ThingTypeName property is set
internal bool IsSetThingTypeName()
{
return this._thingTypeName != null;
}
///
/// Gets and sets the property 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.
///
///
///
public bool UsePrefixAttributeValue
{
get { return this._usePrefixAttributeValue.GetValueOrDefault(); }
set { this._usePrefixAttributeValue = value; }
}
// Check to see if UsePrefixAttributeValue property is set
internal bool IsSetUsePrefixAttributeValue()
{
return this._usePrefixAttributeValue.HasValue;
}
}
}