File Coverage

blib/lib/Paws/GameLift/StartMatchmaking.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::StartMatchmaking;
3 1     1   298 use Moose;
  1         2  
  1         7  
4             has ConfigurationName => (is => 'ro', isa => 'Str', required => 1);
5             has Players => (is => 'ro', isa => 'ArrayRef[Paws::GameLift::Player]', required => 1);
6             has TicketId => (is => 'ro', isa => 'Str');
7              
8 1     1   5387 use MooseX::ClassAttribute;
  1         2  
  1         10  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartMatchmaking');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::GameLift::StartMatchmakingOutput');
12             class_has _result_key => (isa => 'Str', is => 'ro');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::GameLift::StartMatchmaking - Arguments for method StartMatchmaking on Paws::GameLift
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method StartMatchmaking on the
24             Amazon GameLift service. Use the attributes of this class
25             as arguments to method StartMatchmaking.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartMatchmaking.
28              
29             As an example:
30              
31             $service_obj->StartMatchmaking(Att1 => $value1, Att2 => $value2, ...);
32              
33             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.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 B<REQUIRED> ConfigurationName => Str
39              
40             Name of the matchmaking configuration to use for this request.
41             Matchmaking configurations must exist in the same region as this
42             request.
43              
44              
45              
46             =head2 B<REQUIRED> Players => ArrayRef[L<Paws::GameLift::Player>]
47              
48             Information on each player to be matched. This information must include
49             a player ID, and may contain player attributes and latency data to be
50             used in the matchmaking process. After a successful match, C<Player>
51             objects contain the name of the team the player is assigned to.
52              
53              
54              
55             =head2 TicketId => Str
56              
57             Unique identifier for a matchmaking ticket. Use this identifier to
58             track the matchmaking ticket status and retrieve match results.
59              
60              
61              
62              
63             =head1 SEE ALSO
64              
65             This class forms part of L<Paws>, documenting arguments for method StartMatchmaking in L<Paws::GameLift>
66              
67             =head1 BUGS and CONTRIBUTIONS
68              
69             The source code is located here: https://github.com/pplu/aws-sdk-perl
70              
71             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
72              
73             =cut
74