com.amazonaws.services.gamelift.model

Class MatchmakingTicket

java.lang.Object

com.amazonaws.services.gamelift.model.MatchmakingTicket

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MatchmakingTicket
extends Object
implements Serializable, Cloneable, StructuredPojo

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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
MatchmakingTicket()

Method Summary

Modifier and Type	Method and Description
MatchmakingTicket	clone()
boolean	equals(Object obj)
String	getConfigurationName() Name of the MatchmakingConfiguration that is used with this ticket.
Date	getEndTime() Time stamp indicating when the matchmaking request stopped being processed due to successful completion, timeout, or cancellation.
Integer	getEstimatedWaitTime() Average amount of time (in seconds) that players are currently waiting for a match.
GameSessionConnectionInfo	getGameSessionConnectionInfo() Identifier and connection information of the game session created for the match.
List<Player>	getPlayers() A set of Player objects, each representing a player to find matches for.
Date	getStartTime() Time stamp indicating when this matchmaking request was received.
String	getStatus() Current status of the matchmaking request.
String	getStatusMessage() Additional information about the current status.
String	getStatusReason() Code to explain the current status.
String	getTicketId() Unique identifier for a matchmaking ticket.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setConfigurationName(String configurationName) Name of the MatchmakingConfiguration that is used with this ticket.
void	setEndTime(Date endTime) Time stamp indicating when the matchmaking request stopped being processed due to successful completion, timeout, or cancellation.
void	setEstimatedWaitTime(Integer estimatedWaitTime) Average amount of time (in seconds) that players are currently waiting for a match.
void	setGameSessionConnectionInfo(GameSessionConnectionInfo gameSessionConnectionInfo) Identifier and connection information of the game session created for the match.
void	setPlayers(Collection<Player> players) A set of Player objects, each representing a player to find matches for.
void	setStartTime(Date startTime) Time stamp indicating when this matchmaking request was received.
void	setStatus(String status) Current status of the matchmaking request.
void	setStatusMessage(String statusMessage) Additional information about the current status.
void	setStatusReason(String statusReason) Code to explain the current status.
void	setTicketId(String ticketId) Unique identifier for a matchmaking ticket.
String	toString() Returns a string representation of this object; useful for testing and debugging.
MatchmakingTicket	withConfigurationName(String configurationName) Name of the MatchmakingConfiguration that is used with this ticket.
MatchmakingTicket	withEndTime(Date endTime) Time stamp indicating when the matchmaking request stopped being processed due to successful completion, timeout, or cancellation.
MatchmakingTicket	withEstimatedWaitTime(Integer estimatedWaitTime) Average amount of time (in seconds) that players are currently waiting for a match.
MatchmakingTicket	withGameSessionConnectionInfo(GameSessionConnectionInfo gameSessionConnectionInfo) Identifier and connection information of the game session created for the match.
MatchmakingTicket	withPlayers(Collection<Player> players) A set of Player objects, each representing a player to find matches for.
MatchmakingTicket	withPlayers(Player... players) A set of Player objects, each representing a player to find matches for.
MatchmakingTicket	withStartTime(Date startTime) Time stamp indicating when this matchmaking request was received.
MatchmakingTicket	withStatus(MatchmakingConfigurationStatus status) Current status of the matchmaking request.
MatchmakingTicket	withStatus(String status) Current status of the matchmaking request.
MatchmakingTicket	withStatusMessage(String statusMessage) Additional information about the current status.
MatchmakingTicket	withStatusReason(String statusReason) Code to explain the current status.
MatchmakingTicket	withTicketId(String ticketId) Unique identifier for a matchmaking ticket.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MatchmakingTicket

public MatchmakingTicket()

Method Detail

setTicketId

public void setTicketId(String ticketId)

Unique identifier for a matchmaking ticket.

Parameters:

ticketId - Unique identifier for a matchmaking ticket.

getTicketId

public String getTicketId()

Unique identifier for a matchmaking ticket.

Returns:

Unique identifier for a matchmaking ticket.

withTicketId

public MatchmakingTicket withTicketId(String ticketId)

Unique identifier for a matchmaking ticket.

Parameters:

ticketId - Unique identifier for a matchmaking ticket.

Returns:

Returns a reference to this object so that method calls can be chained together.

setConfigurationName

public void setConfigurationName(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.

Parameters:

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.

getConfigurationName

public String getConfigurationName()

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.

Returns:

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.

withConfigurationName

public MatchmakingTicket withConfigurationName(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStatus

public void setStatus(String 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.

Parameters:

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.

See Also:

MatchmakingConfigurationStatus

getStatus

public String getStatus()

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.

Returns:

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.

See Also:

MatchmakingConfigurationStatus

withStatus

public MatchmakingTicket withStatus(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MatchmakingConfigurationStatus

withStatus

public MatchmakingTicket withStatus(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MatchmakingConfigurationStatus

setStatusReason

public void setStatusReason(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.

Parameters:

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.

getStatusReason

public String getStatusReason()

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.

Returns:

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.

withStatusReason

public MatchmakingTicket withStatusReason(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStatusMessage

public void setStatusMessage(String statusMessage)

Additional information about the current status.

Parameters:

statusMessage - Additional information about the current status.

getStatusMessage

public String getStatusMessage()

Additional information about the current status.

Returns:

Additional information about the current status.

withStatusMessage

public MatchmakingTicket withStatusMessage(String statusMessage)

Additional information about the current status.

Parameters:

statusMessage - Additional information about the current status.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStartTime

public void setStartTime(Date startTime)

Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Parameters:

startTime - Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

getStartTime

public Date getStartTime()

Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

withStartTime

public MatchmakingTicket withStartTime(Date startTime)

Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Parameters:

startTime - Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

Returns a reference to this object so that method calls can be chained together.

setEndTime

public void setEndTime(Date 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").

Parameters:

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").

getEndTime

public Date getEndTime()

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").

Returns:

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").

withEndTime

public MatchmakingTicket withEndTime(Date 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").

Parameters:

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").

Returns:

Returns a reference to this object so that method calls can be chained together.

getPlayers

public List<Player> getPlayers()

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.

Returns:

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.

setPlayers

public void setPlayers(Collection<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.

Parameters:

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.

withPlayers

public MatchmakingTicket withPlayers(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.

NOTE: This method appends the values to the existing list (if any). Use setPlayers(java.util.Collection) or withPlayers(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withPlayers

public MatchmakingTicket withPlayers(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setGameSessionConnectionInfo

public void setGameSessionConnectionInfo(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.

Parameters:

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.

getGameSessionConnectionInfo

public GameSessionConnectionInfo getGameSessionConnectionInfo()

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.

Returns:

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.

withGameSessionConnectionInfo

public MatchmakingTicket withGameSessionConnectionInfo(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEstimatedWaitTime

public void setEstimatedWaitTime(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.

Parameters:

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.

getEstimatedWaitTime

public Integer getEstimatedWaitTime()

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.

Returns:

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.

withEstimatedWaitTime

public MatchmakingTicket withEstimatedWaitTime(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public MatchmakingTicket clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.