File Coverage

blib/lib/Paws/GameLift/GameSessionQueue.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::GameSessionQueue;
2 1     1   796 use Moose;
  1         2  
  1         10  
3             has Destinations => (is => 'ro', isa => 'ArrayRef[Paws::GameLift::GameSessionQueueDestination]');
4             has GameSessionQueueArn => (is => 'ro', isa => 'Str');
5             has Name => (is => 'ro', isa => 'Str');
6             has PlayerLatencyPolicies => (is => 'ro', isa => 'ArrayRef[Paws::GameLift::PlayerLatencyPolicy]');
7             has TimeoutInSeconds => (is => 'ro', isa => 'Int');
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::GameLift::GameSessionQueue
15              
16             =head1 USAGE
17              
18             This class represents one of two things:
19              
20             =head3 Arguments in a call to a service
21              
22             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23             Each attribute should be used as a named argument in the calls that expect this type of object.
24              
25             As an example, if Att1 is expected to be a Paws::GameLift::GameSessionQueue object:
26              
27             $service_obj->Method(Att1 => { Destinations => $value, ..., TimeoutInSeconds => $value });
28              
29             =head3 Results returned from an API call
30              
31             Use accessors for each attribute. If Att1 is expected to be an Paws::GameLift::GameSessionQueue object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->Destinations
35              
36             =head1 DESCRIPTION
37              
38             Configuration of a queue that is used to process game session placement
39             requests. The queue configuration identifies several game features:
40              
41             Queue-related operations include:
42              
43             =over
44              
45             =item *
46              
47             CreateGameSessionQueue
48              
49             =item *
50              
51             DescribeGameSessionQueues
52              
53             =item *
54              
55             UpdateGameSessionQueue
56              
57             =item *
58              
59             DeleteGameSessionQueue
60              
61             =back
62              
63             =over
64              
65             =item *
66              
67             The destinations where a new game session can potentially be hosted.
68             Amazon GameLift tries these destinations in an order based on either
69             the queue's default order or player latency information, if provided in
70             a placement request. With latency information, Amazon GameLift can
71             place game sessions where the majority of players are reporting the
72             lowest possible latency.
73              
74             =item *
75              
76             The length of time that placement requests can wait in the queue before
77             timing out.
78              
79             =item *
80              
81             A set of optional latency policies that protect individual players from
82             high latencies, preventing game sessions from being placed where any
83             individual player is reporting latency higher than a policy's maximum.
84              
85             =back
86              
87             Queue-related operations include the following:
88              
89             =over
90              
91             =item *
92              
93             CreateGameSessionQueue
94              
95             =item *
96              
97             DescribeGameSessionQueues
98              
99             =item *
100              
101             UpdateGameSessionQueue
102              
103             =item *
104              
105             DeleteGameSessionQueue
106              
107             =back
108              
109              
110             =head1 ATTRIBUTES
111              
112              
113             =head2 Destinations => ArrayRef[L<Paws::GameLift::GameSessionQueueDestination>]
114              
115             List of fleets that can be used to fulfill game session placement
116             requests in the queue. Fleets are identified by either a fleet ARN or a
117             fleet alias ARN. Destinations are listed in default preference order.
118              
119              
120             =head2 GameSessionQueueArn => Str
121              
122             Amazon Resource Name (ARN) that is assigned to a game session queue and
123             uniquely identifies it. Format is
124             C<arn:aws:gamelift:E<lt>regionE<gt>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912>.
125              
126              
127             =head2 Name => Str
128              
129             Descriptive label that is associated with queue. Queue names must be
130             unique within each region.
131              
132              
133             =head2 PlayerLatencyPolicies => ArrayRef[L<Paws::GameLift::PlayerLatencyPolicy>]
134              
135             Collection of latency policies to apply when processing game sessions
136             placement requests with player latency information. Multiple policies
137             are evaluated in order of the maximum latency value, starting with the
138             lowest latency values. With just one policy, it is enforced at the
139             start of the game session placement for the duration period. With
140             multiple policies, each policy is enforced consecutively for its
141             duration period. For example, a queue might enforce a 60-second policy
142             followed by a 120-second policy, and then no policy for the remainder
143             of the placement.
144              
145              
146             =head2 TimeoutInSeconds => Int
147              
148             Maximum time, in seconds, that a new game session placement request
149             remains in the queue. When a request exceeds this time, the game
150             session placement changes to a TIMED_OUT status.
151              
152              
153              
154             =head1 SEE ALSO
155              
156             This class forms part of L<Paws>, describing an object used in L<Paws::GameLift>
157              
158             =head1 BUGS and CONTRIBUTIONS
159              
160             The source code is located here: https://github.com/pplu/aws-sdk-perl
161              
162             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
163              
164             =cut
165