Package software.amazon.awssdk.services.gamelift.model

Class StartMatchmakingRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.gamelift.model.GameLiftRequest

software.amazon.awssdk.services.gamelift.model.StartMatchmakingRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartMatchmakingRequest.Builder,StartMatchmakingRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartMatchmakingRequest
extends GameLiftRequest
implements ToCopyableBuilder<StartMatchmakingRequest.Builder,StartMatchmakingRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartMatchmakingRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartMatchmakingRequest.Builder	builder()
String	configurationName()	Name of the matchmaking configuration to use for this request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPlayers()	For responses, this returns true if the service returned a value for the Players property.
List<Player>	players()	Information on each player to be matched.
List<SdkField<?>>	sdkFields()
static Class<? extends StartMatchmakingRequest.Builder>	serializableBuilderClass()
String	ticketId()	A unique identifier for a matchmaking ticket.
StartMatchmakingRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

ticketId

public final String ticketId()

A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.

Returns:

A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.

configurationName

public final String configurationName()

Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same Region as this request. You can use either the configuration name or ARN value.

Returns:

Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same Region as this request. You can use either the configuration name or ARN value.

hasPlayers

public final boolean hasPlayers()

For responses, this returns true if the service returned a value for the Players property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

players

public final List<Player> players()

Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

You can include up to 10 Players in a StartMatchmaking request.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPlayers() method.

Returns:

Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

You can include up to 10 Players in a StartMatchmaking request.

toBuilder

public StartMatchmakingRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartMatchmakingRequest.Builder,StartMatchmakingRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static StartMatchmakingRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartMatchmakingRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo