@Generated(value="software.amazon.awssdk:codegen") public final class StartMatchBackfillRequest extends GameLiftRequest implements ToCopyableBuilder<StartMatchBackfillRequest.Builder,StartMatchBackfillRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
StartMatchBackfillRequest.Builder |
| 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()
A unique identifier for the game session.
|
<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()
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.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic 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 match backfill ticket status and retrieve match results.
public final 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.
GameSession object, MatchmakerData property.public final String gameSessionArn()
A unique identifier for the game session. Use the game session ID. When using FlexMatch as a standalone matchmaking solution, this parameter is not needed.
public final boolean hasPlayers()
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.public final 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.
You can include up to 199 Players in a StartMatchBackfill request.
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.
The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.
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.
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.
You can include up to 199 Players in a StartMatchBackfill request.
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.
The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.
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.
public StartMatchBackfillRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<StartMatchBackfillRequest.Builder,StartMatchBackfillRequest>toBuilder in class GameLiftRequestpublic static StartMatchBackfillRequest.Builder builder()
public static Class<? extends StartMatchBackfillRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2022. All rights reserved.