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:

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) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
List<Player>	players() Information on each player to be matched.
static Class<? extends StartMatchmakingRequest.Builder>	serializableBuilderClass()
String	ticketId() Unique identifier for a matchmaking ticket.
StartMatchmakingRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

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. Use this identifier to track the matchmaking ticket status and retrieve match results.

Returns:

Unique identifier for a matchmaking ticket. 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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<StartMatchmakingRequest.Builder,StartMatchmakingRequest>

Specified by:

toBuilder in class GameLiftRequest

Returns:

a builder for type T

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value