File Coverage

blib/lib/Paws/GameLift/GameSession.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::GameLift::GameSession;
2 1     1   557 use Moose;
  1         3  
  1         7  
3             has CreationTime => (is => 'ro', isa => 'Str');
4             has CreatorId => (is => 'ro', isa => 'Str');
5             has CurrentPlayerSessionCount => (is => 'ro', isa => 'Int');
6             has FleetId => (is => 'ro', isa => 'Str');
7             has GameProperties => (is => 'ro', isa => 'ArrayRef[Paws::GameLift::GameProperty]');
8             has GameSessionId => (is => 'ro', isa => 'Str');
9             has IpAddress => (is => 'ro', isa => 'Str');
10             has MaximumPlayerSessionCount => (is => 'ro', isa => 'Int');
11             has Name => (is => 'ro', isa => 'Str');
12             has PlayerSessionCreationPolicy => (is => 'ro', isa => 'Str');
13             has Port => (is => 'ro', isa => 'Int');
14             has Status => (is => 'ro', isa => 'Str');
15             has TerminationTime => (is => 'ro', isa => 'Str');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::GameLift::GameSession
23              
24             =head1 USAGE
25              
26             This class represents one of two things:
27              
28             =head3 Arguments in a call to a service
29              
30             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
31             Each attribute should be used as a named argument in the calls that expect this type of object.
32              
33             As an example, if Att1 is expected to be a Paws::GameLift::GameSession object:
34              
35             $service_obj->Method(Att1 => { CreationTime => $value, ..., TerminationTime => $value });
36              
37             =head3 Results returned from an API call
38              
39             Use accessors for each attribute. If Att1 is expected to be an Paws::GameLift::GameSession object:
40              
41             $result = $service_obj->Method(...);
42             $result->Att1->CreationTime
43              
44             =head1 DESCRIPTION
45              
46             Properties describing a game session.
47              
48             Game-session-related operations include:
49              
50             =over
51              
52             =item *
53              
54             CreateGameSession
55              
56             =item *
57              
58             DescribeGameSessions
59              
60             =item *
61              
62             DescribeGameSessionDetails
63              
64             =item *
65              
66             SearchGameSessions
67              
68             =item *
69              
70             UpdateGameSession
71              
72             =item *
73              
74             GetGameSessionLogUrl
75              
76             =item *
77              
78             Game session placements
79              
80             =over
81              
82             =item *
83              
84             StartGameSessionPlacement
85              
86             =item *
87              
88             DescribeGameSessionPlacement
89              
90             =item *
91              
92             StopGameSessionPlacement
93              
94             =back
95              
96             =back
97              
98              
99             =head1 ATTRIBUTES
100              
101              
102             =head2 CreationTime => Str
103              
104             Time stamp indicating when this data object was created. Format is a
105             number expressed in Unix time as milliseconds (for example
106             "1469498468.057").
107              
108              
109             =head2 CreatorId => Str
110              
111             Unique identifier for a player. This ID is used to enforce a resource
112             protection policy (if one exists), that limits the number of game
113             sessions a player can create.
114              
115              
116             =head2 CurrentPlayerSessionCount => Int
117              
118             Number of players currently in the game session.
119              
120              
121             =head2 FleetId => Str
122              
123             Unique identifier for a fleet the game session is running on.
124              
125              
126             =head2 GameProperties => ArrayRef[L<Paws::GameLift::GameProperty>]
127              
128             Set of developer-defined properties for a game session. These
129             properties are passed to the server process hosting the game session.
130              
131              
132             =head2 GameSessionId => Str
133              
134             Unique identifier for the game session. A game session ID has the
135             following format:
136             C<arn:aws:gamelift:E<lt>regionE<gt>::gamesession/E<lt>fleet
137             IDE<gt>/E<lt>custom ID string or idempotency tokenE<gt>>.
138              
139              
140             =head2 IpAddress => Str
141              
142             IP address of the game session. To connect to a Amazon GameLift game
143             server, an app needs both the IP address and port number.
144              
145              
146             =head2 MaximumPlayerSessionCount => Int
147              
148             Maximum number of players that can be connected simultaneously to the
149             game session.
150              
151              
152             =head2 Name => Str
153              
154             Descriptive label that is associated with a game session. Session names
155             do not need to be unique.
156              
157              
158             =head2 PlayerSessionCreationPolicy => Str
159              
160             Indicates whether or not the game session is accepting new players.
161              
162              
163             =head2 Port => Int
164              
165             Port number for the game session. To connect to a Amazon GameLift game
166             server, an app needs both the IP address and port number.
167              
168              
169             =head2 Status => Str
170              
171             Current status of the game session. A game session must have an
172             C<ACTIVE> status to have player sessions.
173              
174              
175             =head2 TerminationTime => Str
176              
177             Time stamp indicating when this data object was terminated. Format is a
178             number expressed in Unix time as milliseconds (for example
179             "1469498468.057").
180              
181              
182              
183             =head1 SEE ALSO
184              
185             This class forms part of L<Paws>, describing an object used in L<Paws::GameLift>
186              
187             =head1 BUGS and CONTRIBUTIONS
188              
189             The source code is located here: https://github.com/pplu/aws-sdk-perl
190              
191             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
192              
193             =cut
194