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   614 use Moose;
  1         4  
  1         14  
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             =over
42              
43             =item *
44              
45             The destinations where a new game session can potentially be hosted.
46             Amazon GameLift tries these destinations in an order based on either
47             the queue's default order or player latency information, if provided in
48             a placement request. With latency information, Amazon GameLift can
49             place game sessions where the majority of players are reporting the
50             lowest possible latency.
51              
52             =item *
53              
54             The length of time that placement requests can wait in the queue before
55             timing out.
56              
57             =item *
58              
59             A set of optional latency policies that protect individual players from
60             high latencies, preventing game sessions from being placed where any
61             individual player is reporting latency higher than a policy's maximum.
62              
63             =back
64              
65             Queue-related operations include:
66              
67             =over
68              
69             =item *
70              
71             CreateGameSessionQueue
72              
73             =item *
74              
75             DescribeGameSessionQueues
76              
77             =item *
78              
79             UpdateGameSessionQueue
80              
81             =item *
82              
83             DeleteGameSessionQueue
84              
85             =back
86              
87              
88             =head1 ATTRIBUTES
89              
90              
91             =head2 Destinations => ArrayRef[L<Paws::GameLift::GameSessionQueueDestination>]
92              
93             List of fleets that can be used to fulfill game session placement
94             requests in the queue. Fleets are identified by either a fleet ARN or a
95             fleet alias ARN. Destinations are listed in default preference order.
96              
97              
98             =head2 GameSessionQueueArn => Str
99              
100             Amazon Resource Name (ARN) that is assigned to a game session queue and
101             uniquely identifies it. Format is
102             C<arn:aws:gamelift:E<lt>regionE<gt>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912>.
103              
104              
105             =head2 Name => Str
106              
107             Descriptive label that is associated with game session queue. Queue
108             names must be unique within each region.
109              
110              
111             =head2 PlayerLatencyPolicies => ArrayRef[L<Paws::GameLift::PlayerLatencyPolicy>]
112              
113             Collection of latency policies to apply when processing game sessions
114             placement requests with player latency information. Multiple policies
115             are evaluated in order of the maximum latency value, starting with the
116             lowest latency values. With just one policy, it is enforced at the
117             start of the game session placement for the duration period. With
118             multiple policies, each policy is enforced consecutively for its
119             duration period. For example, a queue might enforce a 60-second policy
120             followed by a 120-second policy, and then no policy for the remainder
121             of the placement.
122              
123              
124             =head2 TimeoutInSeconds => Int
125              
126             Maximum time, in seconds, that a new game session placement request
127             remains in the queue. When a request exceeds this time, the game
128             session placement changes to a C<TIMED_OUT> status.
129              
130              
131              
132             =head1 SEE ALSO
133              
134             This class forms part of L<Paws>, describing an object used in L<Paws::GameLift>
135              
136             =head1 BUGS and CONTRIBUTIONS
137              
138             The source code is located here: https://github.com/pplu/aws-sdk-perl
139              
140             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
141              
142             =cut
143