software.amazon.awssdk.services.gamelift.model

Class PlayerLatencyPolicy

java.lang.Object

software.amazon.awssdk.services.gamelift.model.PlayerLatencyPolicy

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PlayerLatencyPolicy.Builder,PlayerLatencyPolicy>

@Generated(value="software.amazon.awssdk:codegen")
public final class PlayerLatencyPolicy
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PlayerLatencyPolicy.Builder,PlayerLatencyPolicy>

Sets a latency cap for individual players when placing a game session. With a latency policy in force, a game session cannot be placed in a fleet location where a player reports latency higher than the cap. Latency policies are used only with placement request that provide player latency information. Player latency policies can be stacked to gradually relax latency requirements over time.

Latency policies are part of a GameSessionQueue.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PlayerLatencyPolicy.Builder

Method Summary

Modifier and Type	Method and Description
static PlayerLatencyPolicy.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maximumIndividualPlayerLatencyMilliseconds() The maximum latency value that is allowed for any player, in milliseconds.
Integer	policyDurationSeconds() The length of time, in seconds, that the policy is enforced while placing a new game session.
List<SdkField<?>>	sdkFields()
static Class<? extends PlayerLatencyPolicy.Builder>	serializableBuilderClass()
PlayerLatencyPolicy.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

maximumIndividualPlayerLatencyMilliseconds

public final Integer maximumIndividualPlayerLatencyMilliseconds()

The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.

Returns:

The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.

policyDurationSeconds

public final Integer policyDurationSeconds()

The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.

Returns:

The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.

toBuilder

public PlayerLatencyPolicy.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PlayerLatencyPolicy.Builder,PlayerLatencyPolicy>

builder

public static PlayerLatencyPolicy.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo