/*
* 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 DescribeFleetLocationAttributes operation.
/// Retrieves information on a fleet's remote locations, including life-cycle status and
/// any suspended fleet activity.
///
///
///
/// This operation can be used in the following ways:
///
/// -
///
/// To get data for specific locations, provide a fleet identifier and a list of locations.
/// Location data is returned in the order that it is requested.
///
///
-
///
/// To get data for all locations, provide a fleet identifier only. Location data is returned
/// in no particular order.
///
///
///
/// When requesting attributes for multiple locations, use the pagination parameters to
/// retrieve results as a set of sequential pages.
///
///
///
/// If successful, a LocationAttributes
object is returned for each requested
/// location. If the fleet does not have a requested location, no information is returned.
/// This operation does not return the home Region. To get information on a fleet's home
/// Region, call DescribeFleetAttributes
.
///
///
///
/// Learn more
///
///
///
/// Setting
/// up Amazon GameLift fleets
///
///
public partial class DescribeFleetLocationAttributesRequest : AmazonGameLiftRequest
{
private string _fleetId;
private int? _limit;
private List _locations = new List();
private string _nextToken;
///
/// Gets and sets the property FleetId.
///
/// A unique identifier for the fleet to retrieve remote locations for. You can use either
/// the fleet ID or ARN value.
///
///
[AWSProperty(Required=true)]
public string FleetId
{
get { return this._fleetId; }
set { this._fleetId = value; }
}
// Check to see if FleetId property is set
internal bool IsSetFleetId()
{
return this._fleetId != null;
}
///
/// 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 limit is not currently enforced.
///
///
[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 Locations.
///
/// A list of fleet locations to retrieve information for. Specify locations in the form
/// of an Amazon Web Services Region code, such as us-west-2
.
///
///
[AWSProperty(Min=1, Max=100)]
public List Locations
{
get { return this._locations; }
set { this._locations = value; }
}
// Check to see if Locations property is set
internal bool IsSetLocations()
{
return this._locations != null && this._locations.Count > 0;
}
///
/// 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.
///
///
[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;
}
}
}