@Generated(value="software.amazon.awssdk:codegen") public final class MatchmakingConfiguration extends Object implements StructuredPojo, ToCopyableBuilder<MatchmakingConfiguration.Builder,MatchmakingConfiguration>
Guidelines for use with FlexMatch to match players into games. All matchmaking requests must specify a matchmaking configuration.
Modifier and Type | Class and Description |
---|---|
static interface |
MatchmakingConfiguration.Builder |
Modifier and Type | Method and Description |
---|---|
Boolean |
acceptanceRequired()
Flag that determines whether or not a match that was created with this configuration must be accepted by the
matched players.
|
Integer |
acceptanceTimeoutSeconds()
Length of time (in seconds) to wait for players to accept a proposed match.
|
Integer |
additionalPlayerCount()
Number of player slots in a match to keep open for future players.
|
static MatchmakingConfiguration.Builder |
builder() |
Instant |
creationTime()
Time stamp indicating when this data object was created.
|
String |
customEventData()
Information to attached to all events related to the matchmaking configuration.
|
String |
description()
Descriptive label that is associated with matchmaking configuration.
|
boolean |
equals(Object obj) |
List<GameProperty> |
gameProperties()
Set of developer-defined properties for a game session, formatted as a set of type:value pairs.
|
String |
gameSessionData()
Set of developer-defined game session properties, formatted as a single string value.
|
List<String> |
gameSessionQueueArns()
Amazon Resource Name (ARN) that
is assigned to a game session queue and uniquely identifies it.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
String |
name()
Unique identifier for a matchmaking configuration.
|
String |
notificationTarget()
SNS topic ARN that is set up to receive matchmaking notifications.
|
Integer |
requestTimeoutSeconds()
Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
|
String |
ruleSetName()
Unique identifier for a matchmaking rule set to use with this configuration.
|
static Class<? extends MatchmakingConfiguration.Builder> |
serializableBuilderClass() |
MatchmakingConfiguration.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String name()
Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.
public String description()
Descriptive label that is associated with matchmaking configuration.
public List<String> gameSessionQueueArns()
Amazon Resource Name (ARN) that
is assigned to a game session queue and uniquely identifies it. Format is
arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912
. These queues are
used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be
located in any region.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912
. These
queues are used when placing game sessions for matches that are created with this matchmaking
configuration. Queues can be located in any region.public Integer requestTimeoutSeconds()
Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.
public Integer acceptanceTimeoutSeconds()
Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.
public Boolean acceptanceRequired()
Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.
public String ruleSetName()
Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.
public String notificationTarget()
SNS topic ARN that is set up to receive matchmaking notifications.
public Integer additionalPlayerCount()
Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.
public String customEventData()
Information to attached to all events related to the matchmaking configuration.
public Instant creationTime()
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
public List<GameProperty> gameProperties()
Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String gameSessionData()
Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.
public MatchmakingConfiguration.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<MatchmakingConfiguration.Builder,MatchmakingConfiguration>
public static MatchmakingConfiguration.Builder builder()
public static Class<? extends MatchmakingConfiguration.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.