/*
* 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 gamelift-2015-10-01.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.GameLift.Model
{
///
/// Container for the parameters to the DescribeFleetAttributes operation.
/// Retrieves core fleet-wide properties, including the computing hardware and deployment
/// configuration for all instances in the fleet.
///
///
///
/// This operation can be used in the following ways:
///
/// -
///
/// To get attributes for one or more specific fleets, provide a list of fleet IDs or
/// fleet ARNs.
///
///
-
///
/// To get attributes for all fleets, do not provide a fleet identifier.
///
///
///
/// When requesting attributes for multiple fleets, use the pagination parameters to retrieve
/// results as a set of sequential pages.
///
///
///
/// If successful, a FleetAttributes
object is returned for each fleet requested,
/// unless the fleet identifier is not found.
///
///
///
/// Some API operations limit the number of fleet IDs that allowed in one request. If
/// a request exceeds this limit, the request fails and the error message contains the
/// maximum allowed number.
///
///
///
/// Learn more
///
///
///
/// Setting
/// up Amazon GameLift fleets
///
///
public partial class DescribeFleetAttributesRequest : AmazonGameLiftRequest
{
private List _fleetIds = new List();
private int? _limit;
private string _nextToken;
///
/// Gets and sets the property FleetIds.
///
/// A list of unique fleet identifiers to retrieve attributes for. You can use either
/// the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include
/// this parameter.
///
///
[AWSProperty(Min=1)]
public List FleetIds
{
get { return this._fleetIds; }
set { this._fleetIds = value; }
}
// Check to see if FleetIds property is set
internal bool IsSetFleetIds()
{
return this._fleetIds != null && this._fleetIds.Count > 0;
}
///
/// Gets and sets the property Limit.
///
/// The maximum number of results to return. Use this parameter with NextToken
/// to get results as a set of sequential pages. This parameter is ignored when the request
/// specifies one or a list of fleet IDs.
///
///
[AWSProperty(Min=1)]
public int Limit
{
get { return this._limit.GetValueOrDefault(); }
set { this._limit = value; }
}
// Check to see if Limit property is set
internal bool IsSetLimit()
{
return this._limit.HasValue;
}
///
/// Gets and sets the property NextToken.
///
/// A token that indicates the start of the next sequential page of results. Use the token
/// that is returned with a previous call to this operation. To start at the beginning
/// of the result set, do not specify a value. This parameter is ignored when the request
/// specifies one or a list of fleet IDs.
///
///
[AWSProperty(Min=1, Max=1024)]
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;
}
}
}