Class PlayerLatencyPolicy

java.lang.Object
software.amazon.awssdk.services.gamelift.model.PlayerLatencyPolicy
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PlayerLatencyPolicy.Builder,PlayerLatencyPolicy>
@Generated("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.

See Also:

  • Method Details

    • 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()
      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<PlayerLatencyPolicy.Builder,PlayerLatencyPolicy>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.