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(value="software.amazon.awssdk:codegen")
public final class StartMatchmakingRequest
extends GameLiftRequest
implements ToCopyableBuilder<StartMatchmakingRequest.Builder,StartMatchmakingRequest>

Represents the input for a request action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartMatchmakingRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartMatchmakingRequest.Builder	builder()
String	configurationName() Name of the matchmaking configuration to use for this request.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<Player>	players() Information on each player to be matched.
List<SdkField<?>>	sdkFields()
static Class<? extends StartMatchmakingRequest.Builder>	serializableBuilderClass()
String	ticketId() Unique identifier for a matchmaking ticket.
StartMatchmakingRequest.Builder	toBuilder()
String	toString()

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 String ticketId()

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:

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 String configurationName()

Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same region as this request.

Returns:

Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same region as this request.

players

public 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.

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

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.

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo