/*
* 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 CreatePlayerSessions operation.
/// Reserves open slots in a game session for a group of players. New player sessions
/// can be created in any game session with an open slot that is in ACTIVE
/// status and has a player creation policy of ACCEPT_ALL
. To add a single
/// player to a game session, use CreatePlayerSession
///
///
///
///
/// To create player sessions, specify a game session ID and a list of player IDs. Optionally,
/// provide a set of player data for each player ID.
///
///
///
/// If successful, a slot is reserved in the game session for each player, and new PlayerSession
/// objects are returned with player session IDs. Each player references their player
/// session ID when sending a connection request to the game session, and the game server
/// can use it to validate the player reservation with the Amazon GameLift service. Player
/// sessions cannot be updated.
///
///
///
/// The maximum number of players per game session is 200. It is not adjustable.
///
///
///
/// Related actions
///
///
///
/// All
/// APIs by task
///
///
public partial class CreatePlayerSessionsRequest : AmazonGameLiftRequest
{
private string _gameSessionId;
private Dictionary _playerDataMap = new Dictionary();
private List _playerIds = new List();
///
/// Gets and sets the property GameSessionId.
///
/// A unique identifier for the game session to add players to.
///
///
[AWSProperty(Required=true, Min=1, Max=256)]
public string GameSessionId
{
get { return this._gameSessionId; }
set { this._gameSessionId = value; }
}
// Check to see if GameSessionId property is set
internal bool IsSetGameSessionId()
{
return this._gameSessionId != null;
}
///
/// Gets and sets the property PlayerDataMap.
///
/// Map of string pairs, each specifying a player ID and a set of developer-defined information
/// related to the player. Amazon GameLift does not use this data, so it can be formatted
/// as needed for use in the game. Any player data strings for player IDs that are not
/// included in the PlayerIds
parameter are ignored.
///
///
public Dictionary PlayerDataMap
{
get { return this._playerDataMap; }
set { this._playerDataMap = value; }
}
// Check to see if PlayerDataMap property is set
internal bool IsSetPlayerDataMap()
{
return this._playerDataMap != null && this._playerDataMap.Count > 0;
}
///
/// Gets and sets the property PlayerIds.
///
/// List of unique identifiers for the players to be added.
///
///
[AWSProperty(Required=true, Min=1, Max=25)]
public List PlayerIds
{
get { return this._playerIds; }
set { this._playerIds = value; }
}
// Check to see if PlayerIds property is set
internal bool IsSetPlayerIds()
{
return this._playerIds != null && this._playerIds.Count > 0;
}
}
}