File Coverage

blib/lib/Paws/GameLift/StartGameSessionPlacement.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::GameLift::StartGameSessionPlacement;
3 1     1   338 use Moose;
  1         2  
  1         8  
4             has DesiredPlayerSessions => (is => 'ro', isa => 'ArrayRef[Paws::GameLift::DesiredPlayerSession]');
5             has GameProperties => (is => 'ro', isa => 'ArrayRef[Paws::GameLift::GameProperty]');
6             has GameSessionData => (is => 'ro', isa => 'Str');
7             has GameSessionName => (is => 'ro', isa => 'Str');
8             has GameSessionQueueName => (is => 'ro', isa => 'Str', required => 1);
9             has MaximumPlayerSessionCount => (is => 'ro', isa => 'Int', required => 1);
10             has PlacementId => (is => 'ro', isa => 'Str', required => 1);
11             has PlayerLatencies => (is => 'ro', isa => 'ArrayRef[Paws::GameLift::PlayerLatency]');
12              
13 1     1   5624 use MooseX::ClassAttribute;
  1         2  
  1         8  
14              
15             class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartGameSessionPlacement');
16             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::GameLift::StartGameSessionPlacementOutput');
17             class_has _result_key => (isa => 'Str', is => 'ro');
18             1;
19              
20             ### main pod documentation begin ###
21              
22             =head1 NAME
23              
24             Paws::GameLift::StartGameSessionPlacement - Arguments for method StartGameSessionPlacement on Paws::GameLift
25              
26             =head1 DESCRIPTION
27              
28             This class represents the parameters used for calling the method StartGameSessionPlacement on the
29             Amazon GameLift service. Use the attributes of this class
30             as arguments to method StartGameSessionPlacement.
31              
32             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartGameSessionPlacement.
33              
34             As an example:
35              
36             $service_obj->StartGameSessionPlacement(Att1 => $value1, Att2 => $value2, ...);
37              
38             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 DesiredPlayerSessions => ArrayRef[L<Paws::GameLift::DesiredPlayerSession>]
44              
45             Set of information on each player to create a player session for.
46              
47              
48              
49             =head2 GameProperties => ArrayRef[L<Paws::GameLift::GameProperty>]
50              
51             Set of developer-defined properties for a game session, formatted as a
52             set of type:value pairs. These properties are included in the
53             GameSession object, which is passed to the game server with a request
54             to start a new game session (see Start a Game Session).
55              
56              
57              
58             =head2 GameSessionData => Str
59              
60             Set of developer-defined game session properties, formatted as a single
61             string value. This data is included in the GameSession object, which is
62             passed to the game server with a request to start a new game session
63             (see Start a Game Session).
64              
65              
66              
67             =head2 GameSessionName => Str
68              
69             Descriptive label that is associated with a game session. Session names
70             do not need to be unique.
71              
72              
73              
74             =head2 B<REQUIRED> GameSessionQueueName => Str
75              
76             Name of the queue to use to place the new game session.
77              
78              
79              
80             =head2 B<REQUIRED> MaximumPlayerSessionCount => Int
81              
82             Maximum number of players that can be connected simultaneously to the
83             game session.
84              
85              
86              
87             =head2 B<REQUIRED> PlacementId => Str
88              
89             Unique identifier to assign to the new game session placement. This
90             value is developer-defined. The value must be unique across all regions
91             and cannot be reused unless you are resubmitting a canceled or
92             timed-out placement request.
93              
94              
95              
96             =head2 PlayerLatencies => ArrayRef[L<Paws::GameLift::PlayerLatency>]
97              
98             Set of values, expressed in milliseconds, indicating the amount of
99             latency that a player experiences when connected to AWS regions. This
100             information is used to try to place the new game session where it can
101             offer the best possible gameplay experience for the players.
102              
103              
104              
105              
106             =head1 SEE ALSO
107              
108             This class forms part of L<Paws>, documenting arguments for method StartGameSessionPlacement in L<Paws::GameLift>
109              
110             =head1 BUGS and CONTRIBUTIONS
111              
112             The source code is located here: https://github.com/pplu/aws-sdk-perl
113              
114             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
115              
116             =cut
117