File Coverage

blib/lib/Paws/GameLift/MatchmakingConfiguration.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	sub	time	code
1				package Paws::GameLift::MatchmakingConfiguration;
2	1	1	359	use Moose;
	1		3
	1		7
3				has AcceptanceRequired => (is => 'ro', isa => 'Bool');
4				has AcceptanceTimeoutSeconds => (is => 'ro', isa => 'Int');
5				has AdditionalPlayerCount => (is => 'ro', isa => 'Int');
6				has CreationTime => (is => 'ro', isa => 'Str');
7				has CustomEventData => (is => 'ro', isa => 'Str');
8				has Description => (is => 'ro', isa => 'Str');
9				has GameProperties => (is => 'ro', isa => 'ArrayRef[Paws::GameLift::GameProperty]');
10				has GameSessionData => (is => 'ro', isa => 'Str');
11				has GameSessionQueueArns => (is => 'ro', isa => 'ArrayRef[Str\|Undef]');
12				has Name => (is => 'ro', isa => 'Str');
13				has NotificationTarget => (is => 'ro', isa => 'Str');
14				has RequestTimeoutSeconds => (is => 'ro', isa => 'Int');
15				has RuleSetName => (is => 'ro', isa => 'Str');
16				1;
17
18				### main pod documentation begin ###
19
20				=head1 NAME
21
22				Paws::GameLift::MatchmakingConfiguration
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::MatchmakingConfiguration object:
34
35				$service_obj->Method(Att1 => { AcceptanceRequired => $value, ..., RuleSetName => $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::MatchmakingConfiguration object:
40
41				$result = $service_obj->Method(...);
42				$result->Att1->AcceptanceRequired
43
44				=head1 DESCRIPTION
45
46				Guidelines for use with FlexMatch to match players into games. All
47				matchmaking requests must specify a matchmaking configuration.
48
49				=head1 ATTRIBUTES
50
51
52				=head2 AcceptanceRequired => Bool
53
54				Flag that determines whether or not a match that was created with this
55				configuration must be accepted by the matched players. To require
56				acceptance, set to TRUE.
57
58
59				=head2 AcceptanceTimeoutSeconds => Int
60
61				Length of time (in seconds) to wait for players to accept a proposed
62				match. If any player rejects the match or fails to accept before the
63				timeout, the ticket continues to look for an acceptable match.
64
65
66				=head2 AdditionalPlayerCount => Int
67
68				Number of player slots in a match to keep open for future players. For
69				example, if the configuration's rule set specifies a match for a single
70				12-person team, and the additional player count is set to 2, only 10
71				players are selected for the match.
72
73
74				=head2 CreationTime => Str
75
76				Time stamp indicating when this data object was created. Format is a
77				number expressed in Unix time as milliseconds (for example
78				"1469498468.057").
79
80
81				=head2 CustomEventData => Str
82
83				Information to attached to all events related to the matchmaking
84				configuration.
85
86
87				=head2 Description => Str
88
89				Descriptive label that is associated with matchmaking configuration.
90
91
92				=head2 GameProperties => ArrayRef[L<Paws::GameLift::GameProperty>]
93
94				Set of developer-defined properties for a game session, formatted as a
95				set of type:value pairs. These properties are included in the
96				GameSession object, which is passed to the game server with a request
97				to start a new game session (see Start a Game Session). This
98				information is added to the new GameSession object that is created for
99				a successful match.
100
101
102				=head2 GameSessionData => Str
103
104				Set of developer-defined game session properties, formatted as a single
105				string value. This data is included in the GameSession object, which is
106				passed to the game server with a request to start a new game session
107				(see Start a Game Session). This information is added to the new
108				GameSession object that is created for a successful match.
109
110
111				=head2 GameSessionQueueArns => ArrayRef[Str\|Undef]
112
113				Amazon Resource Name (ARN) that is assigned to a game session queue and
114				uniquely identifies it. Format is
115				C<arn:aws:gamelift:E<lt>regionE<gt>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912>.
116				These queues are used when placing game sessions for matches that are
117				created with this matchmaking configuration. Queues can be located in
118				any region.
119
120
121				=head2 Name => Str
122
123				Unique identifier for a matchmaking configuration. This name is used to
124				identify the configuration associated with a matchmaking request or
125				ticket.
126
127
128				=head2 NotificationTarget => Str
129
130				SNS topic ARN that is set up to receive matchmaking notifications.
131
132
133				=head2 RequestTimeoutSeconds => Int
134
135				Maximum duration, in seconds, that a matchmaking ticket can remain in
136				process before timing out. Requests that time out can be resubmitted as
137				needed.
138
139
140				=head2 RuleSetName => Str
141
142				Unique identifier for a matchmaking rule set to use with this
143				configuration. A matchmaking configuration can only use rule sets that
144				are defined in the same region.
145
146
147
148				=head1 SEE ALSO
149
150				This class forms part of L<Paws>, describing an object used in L<Paws::GameLift>
151
152				=head1 BUGS and CONTRIBUTIONS
153
154				The source code is located here: https://github.com/pplu/aws-sdk-perl
155
156				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
157
158				=cut
159