/*
* 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 ecs-2014-11-13.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.ECS.Model
{
///
/// Container for the parameters to the ListContainerInstances operation.
/// Returns a list of container instances in a specified cluster. You can filter the results
/// of a ListContainerInstances
operation with cluster query language statements
/// inside the filter
parameter. For more information, see Cluster
/// Query Language in the Amazon Elastic Container Service Developer Guide.
///
public partial class ListContainerInstancesRequest : AmazonECSRequest
{
private string _cluster;
private string _filter;
private int? _maxResults;
private string _nextToken;
private ContainerInstanceStatus _status;
///
/// Gets and sets the property Cluster.
///
/// The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container
/// instances to list. If you do not specify a cluster, the default cluster is assumed.
///
///
public string Cluster
{
get { return this._cluster; }
set { this._cluster = value; }
}
// Check to see if Cluster property is set
internal bool IsSetCluster()
{
return this._cluster != null;
}
///
/// Gets and sets the property Filter.
///
/// You can filter the results of a ListContainerInstances
operation with
/// cluster query language statements. For more information, see Cluster
/// Query Language in the Amazon Elastic Container Service Developer Guide.
///
///
public string Filter
{
get { return this._filter; }
set { this._filter = value; }
}
// Check to see if Filter property is set
internal bool IsSetFilter()
{
return this._filter != null;
}
///
/// Gets and sets the property MaxResults.
///
/// The maximum number of container instance results that ListContainerInstances
/// returned in paginated output. When this parameter is used, ListContainerInstances
/// 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 ListContainerInstances
request with the returned nextToken
/// value. This value can be between 1 and 100. If this parameter isn't used, then ListContainerInstances
/// returns up to 100 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.
///
/// The nextToken
value returned from a ListContainerInstances
/// request indicating that more results are available to fulfill the request and further
/// calls are needed. If maxResults
was provided, it's possible the number
/// of results to be fewer than maxResults
.
///
///
///
/// This token should be treated as an opaque identifier that is only used to retrieve
/// the next items in a list and not for other programmatic purposes.
///
///
///
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;
}
///
/// Gets and sets the property Status.
///
/// Filters the container instances by status. For example, if you specify the DRAINING
/// status, the results include only container instances that have been set to DRAINING
/// using UpdateContainerInstancesState. If you don't specify this parameter, the
/// default is to include container instances set to all states other than INACTIVE
.
///
///
public ContainerInstanceStatus Status
{
get { return this._status; }
set { this._status = value; }
}
// Check to see if Status property is set
internal bool IsSetStatus()
{
return this._status != null;
}
}
}