@Generated(value="software.amazon.awssdk:codegen") public class MatchmakingTicket extends Object implements StructuredPojo, ToCopyableBuilder<MatchmakingTicket.Builder,MatchmakingTicket>
Ticket generated to track the progress of a matchmaking request. Each ticket is uniquely identified by a ticket ID, supplied by the requester, when creating a matchmaking request with StartMatchmaking. Tickets can be retrieved by calling DescribeMatchmaking with the ticket ID.
Modifier and Type | Class and Description |
---|---|
static interface |
MatchmakingTicket.Builder |
Modifier and Type | Method and Description |
---|---|
static MatchmakingTicket.Builder |
builder() |
String |
configurationName()
Name of the MatchmakingConfiguration that is used with this ticket.
|
Instant |
endTime()
Time stamp indicating when the matchmaking request stopped being processed due to successful completion, timeout,
or cancellation.
|
boolean |
equals(Object obj) |
Integer |
estimatedWaitTime()
Average amount of time (in seconds) that players are currently waiting for a match.
|
GameSessionConnectionInfo |
gameSessionConnectionInfo()
Identifier and connection information of the game session created for the match.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
List<Player> |
players()
A set of
Player objects, each representing a player to find matches for. |
static Class<? extends MatchmakingTicket.Builder> |
serializableBuilderClass() |
Instant |
startTime()
Time stamp indicating when this matchmaking request was received.
|
MatchmakingConfigurationStatus |
status()
Current status of the matchmaking request.
|
String |
statusMessage()
Additional information about the current status.
|
String |
statusReason()
Code to explain the current status.
|
String |
statusString()
Current status of the matchmaking request.
|
String |
ticketId()
Unique identifier for a matchmaking ticket.
|
MatchmakingTicket.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 ticketId()
Unique identifier for a matchmaking ticket.
public String configurationName()
Name of the MatchmakingConfiguration that is used with this ticket. Matchmaking configurations determine how players are grouped into a match and how a new game session is created for the match.
public MatchmakingConfigurationStatus status()
Current status of the matchmaking request.
QUEUED -- The matchmaking request has been received and is currently waiting to be processed.
SEARCHING -- The matchmaking request is currently being processed.
REQUIRES_ACCEPTANCE -- A match has been proposed and the players must accept the match (see AcceptMatch). This status is used only with requests that use a matchmaking configuration with a player acceptance requirement.
PLACING -- The FlexMatch engine has matched players and is in the process of placing a new game session for the match.
COMPLETED -- Players have been matched and a game session is ready to host the players. A ticket in this state contains the necessary connection information for players.
FAILED -- The matchmaking request was not completed. Tickets with players who fail to accept a proposed
match are placed in FAILED
status; new matchmaking requests can be submitted for these players.
CANCELLED -- The matchmaking request was canceled with a call to StopMatchmaking.
TIMED_OUT -- The matchmaking request was not completed within the duration specified in the matchmaking configuration. Matchmaking requests that time out can be resubmitted.
If the service returns an enum value that is not available in the current SDK version, status
will
return MatchmakingConfigurationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from statusString()
.
QUEUED -- The matchmaking request has been received and is currently waiting to be processed.
SEARCHING -- The matchmaking request is currently being processed.
REQUIRES_ACCEPTANCE -- A match has been proposed and the players must accept the match (see AcceptMatch). This status is used only with requests that use a matchmaking configuration with a player acceptance requirement.
PLACING -- The FlexMatch engine has matched players and is in the process of placing a new game session for the match.
COMPLETED -- Players have been matched and a game session is ready to host the players. A ticket in this state contains the necessary connection information for players.
FAILED -- The matchmaking request was not completed. Tickets with players who fail to accept a
proposed match are placed in FAILED
status; new matchmaking requests can be submitted for
these players.
CANCELLED -- The matchmaking request was canceled with a call to StopMatchmaking.
TIMED_OUT -- The matchmaking request was not completed within the duration specified in the matchmaking configuration. Matchmaking requests that time out can be resubmitted.
MatchmakingConfigurationStatus
public String statusString()
Current status of the matchmaking request.
QUEUED -- The matchmaking request has been received and is currently waiting to be processed.
SEARCHING -- The matchmaking request is currently being processed.
REQUIRES_ACCEPTANCE -- A match has been proposed and the players must accept the match (see AcceptMatch). This status is used only with requests that use a matchmaking configuration with a player acceptance requirement.
PLACING -- The FlexMatch engine has matched players and is in the process of placing a new game session for the match.
COMPLETED -- Players have been matched and a game session is ready to host the players. A ticket in this state contains the necessary connection information for players.
FAILED -- The matchmaking request was not completed. Tickets with players who fail to accept a proposed
match are placed in FAILED
status; new matchmaking requests can be submitted for these players.
CANCELLED -- The matchmaking request was canceled with a call to StopMatchmaking.
TIMED_OUT -- The matchmaking request was not completed within the duration specified in the matchmaking configuration. Matchmaking requests that time out can be resubmitted.
If the service returns an enum value that is not available in the current SDK version, status
will
return MatchmakingConfigurationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from statusString()
.
QUEUED -- The matchmaking request has been received and is currently waiting to be processed.
SEARCHING -- The matchmaking request is currently being processed.
REQUIRES_ACCEPTANCE -- A match has been proposed and the players must accept the match (see AcceptMatch). This status is used only with requests that use a matchmaking configuration with a player acceptance requirement.
PLACING -- The FlexMatch engine has matched players and is in the process of placing a new game session for the match.
COMPLETED -- Players have been matched and a game session is ready to host the players. A ticket in this state contains the necessary connection information for players.
FAILED -- The matchmaking request was not completed. Tickets with players who fail to accept a
proposed match are placed in FAILED
status; new matchmaking requests can be submitted for
these players.
CANCELLED -- The matchmaking request was canceled with a call to StopMatchmaking.
TIMED_OUT -- The matchmaking request was not completed within the duration specified in the matchmaking configuration. Matchmaking requests that time out can be resubmitted.
MatchmakingConfigurationStatus
public String statusReason()
Code to explain the current status. For example, a status reason may indicate when a ticket has returned to
SEARCHING
status after a proposed match fails to receive player acceptances.
SEARCHING
status after a proposed match fails to receive player acceptances.public String statusMessage()
Additional information about the current status.
public Instant startTime()
Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
public Instant endTime()
Time stamp indicating when the matchmaking request stopped being processed due to successful completion, timeout, or cancellation. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
public List<Player> players()
A set of Player
objects, each representing a player to find matches for. Players are identified by a
unique player ID and may include latency data for use during matchmaking. If the ticket is in status
COMPLETED
, the Player
objects include the team the players were assigned to in the
resulting match.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Player
objects, each representing a player to find matches for. Players are
identified by a unique player ID and may include latency data for use during matchmaking. If the ticket
is in status COMPLETED
, the Player
objects include the team the players were
assigned to in the resulting match.public GameSessionConnectionInfo gameSessionConnectionInfo()
Identifier and connection information of the game session created for the match. This information is added to the ticket only after the matchmaking request has been successfully completed.
public Integer estimatedWaitTime()
Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent data, this property may be empty.
public MatchmakingTicket.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<MatchmakingTicket.Builder,MatchmakingTicket>
public static MatchmakingTicket.Builder builder()
public static Class<? extends MatchmakingTicket.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.