File Coverage

blib/lib/Paws/GameLift/PlayerLatencyPolicy.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::PlayerLatencyPolicy;
2 1     1   279 use Moose;
  1         3  
  1         5  
3             has MaximumIndividualPlayerLatencyMilliseconds => (is => 'ro', isa => 'Int');
4             has PolicyDurationSeconds => (is => 'ro', isa => 'Int');
5             1;
6              
7             ### main pod documentation begin ###
8              
9             =head1 NAME
10              
11             Paws::GameLift::PlayerLatencyPolicy
12              
13             =head1 USAGE
14              
15             This class represents one of two things:
16              
17             =head3 Arguments in a call to a service
18              
19             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
20             Each attribute should be used as a named argument in the calls that expect this type of object.
21              
22             As an example, if Att1 is expected to be a Paws::GameLift::PlayerLatencyPolicy object:
23              
24             $service_obj->Method(Att1 => { MaximumIndividualPlayerLatencyMilliseconds => $value, ..., PolicyDurationSeconds => $value });
25              
26             =head3 Results returned from an API call
27              
28             Use accessors for each attribute. If Att1 is expected to be an Paws::GameLift::PlayerLatencyPolicy object:
29              
30             $result = $service_obj->Method(...);
31             $result->Att1->MaximumIndividualPlayerLatencyMilliseconds
32              
33             =head1 DESCRIPTION
34              
35             Queue setting that determines the highest latency allowed for
36             individual players when placing a game session. When a latency policy
37             is in force, a game session cannot be placed at any destination in a
38             region where a player is reporting latency higher than the cap. Latency
39             policies are only enforced when the placement request contains player
40             latency information.
41              
42             Queue-related operations include:
43              
44             =over
45              
46             =item *
47              
48             CreateGameSessionQueue
49              
50             =item *
51              
52             DescribeGameSessionQueues
53              
54             =item *
55              
56             UpdateGameSessionQueue
57              
58             =item *
59              
60             DeleteGameSessionQueue
61              
62             =back
63              
64              
65             =head1 ATTRIBUTES
66              
67              
68             =head2 MaximumIndividualPlayerLatencyMilliseconds => Int
69              
70             The maximum latency value that is allowed for any player, in
71             milliseconds. All policies must have a value set for this property.
72              
73              
74             =head2 PolicyDurationSeconds => Int
75              
76             The length of time, in seconds, that the policy is enforced while
77             placing a new game session. A null value for this property means that
78             the policy is enforced until the queue times out.
79              
80              
81              
82             =head1 SEE ALSO
83              
84             This class forms part of L<Paws>, describing an object used in L<Paws::GameLift>
85              
86             =head1 BUGS and CONTRIBUTIONS
87              
88             The source code is located here: https://github.com/pplu/aws-sdk-perl
89              
90             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
91              
92             =cut
93