software.amazon.awssdk.services.gamelift.model

Class StartMatchBackfillRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartMatchBackfillRequest.Builder,StartMatchBackfillRequest>

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

Represents the input for a request operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartMatchBackfillRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartMatchBackfillRequest.Builder	builder()
String	configurationName() Name of the matchmaker to use for this request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gameSessionArn() Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPlayers() Returns true if the Players property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<Player>	players() Match information on all players that are currently assigned to the game session.
List<SdkField<?>>	sdkFields()
static Class<? extends StartMatchBackfillRequest.Builder>	serializableBuilderClass()
String	ticketId() A unique identifier for a matchmaking ticket.
StartMatchBackfillRequest.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 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 match backfill 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 match backfill ticket status and retrieve match results.

configurationName

public String configurationName()

Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property.

Returns:

Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property.

gameSessionArn

public String gameSessionArn()

Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it. This is the same as the game session ID.

Returns:

Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it. This is the same as the game session ID.

hasPlayers

public boolean hasPlayers()

Returns true if the Players property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

players

public List<Player> players()

Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.

• PlayerID, PlayerAttributes, Team -\\- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data.

• LatencyInMs -\\- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.

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

You can use hasPlayers() to see if a value was sent in this field.

Returns:

Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.

• PlayerID, PlayerAttributes, Team -\\- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data.

• LatencyInMs -\\- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.

toBuilder

public StartMatchBackfillRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartMatchBackfillRequest.Builder,StartMatchBackfillRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static StartMatchBackfillRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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