/*
* 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 robomaker-2018-06-29.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.RoboMaker.Model
{
///
/// Container for the parameters to the ListRobots operation.
/// Returns a list of robots. You can optionally provide filters to retrieve specific
/// robots.
///
///
///
/// This API will no longer be supported as of May 2, 2022. Use it to remove resources
/// that were created for Deployment Service.
///
///
///
[Obsolete("Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.")]
public partial class ListRobotsRequest : AmazonRoboMakerRequest
{
private List _filters = new List();
private int? _maxResults;
private string _nextToken;
///
/// Gets and sets the property Filters.
///
/// Optional filters to limit results.
///
///
///
/// The filter names status
and fleetName
are supported. When
/// filtering, you must use the complete value of the filtered item. You can use up to
/// three filters, but they must be for the same named item. For example, if you are looking
/// for items with the status Registered
or the status Available
.
///
///
[AWSProperty(Min=1, Max=1)]
public List Filters
{
get { return this._filters; }
set { this._filters = value; }
}
// Check to see if Filters property is set
internal bool IsSetFilters()
{
return this._filters != null && this._filters.Count > 0;
}
///
/// Gets and sets the property MaxResults.
///
/// When this parameter is used, ListRobots
only returns maxResults
/// results in a single page along with a nextToken
response element. The
/// remaining results of the initial request can be seen by sending another ListRobots
/// request with the returned nextToken
value. This value can be between
/// 1 and 200. If this parameter is not used, then ListRobots
returns up
/// to 200 results and a nextToken
value if applicable.
///
///
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 NextToken.
///
/// If the previous paginated request did not return all of the remaining results, the
/// response object's nextToken
parameter value is set to a token. To retrieve
/// the next set of results, call ListRobots
again and assign that token
/// to the request object's nextToken
parameter. If there are no remaining
/// results, the previous response object's NextToken parameter is set to null.
///
///
[AWSProperty(Min=1, Max=2048)]
public string NextToken
{
get { return this._nextToken; }
set { this._nextToken = value; }
}
// Check to see if NextToken property is set
internal bool IsSetNextToken()
{
return this._nextToken != null;
}
}
}