Class PlayerLatency

java.lang.Object
software.amazon.awssdk.services.gamelift.model.PlayerLatency
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PlayerLatency.Builder,PlayerLatency>
@Generated("software.amazon.awssdk:codegen") public final class PlayerLatency extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PlayerLatency.Builder,PlayerLatency>

Regional latency information for a player, used when requesting a new game session. This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified location (an Amazon Web Services Region or a custom location for Amazon GameLift Servers Anywhere fleets). The relative difference between a player's latency values for multiple locations are used to determine which fleets are best suited to place a new game session for the player.

See Also:

  • Method Details

    • playerId

      public final String playerId()

      A unique identifier for a player associated with the latency data.

      Returns:
      A unique identifier for a player associated with the latency data.

    • regionIdentifier

      public final String regionIdentifier()

      Name of the Region or custom location that is associated with the latency value. For Amazon GameLift Servers Anywhere fleets, use the custom location name.

      Returns:
      Name of the Region or custom location that is associated with the latency value. For Amazon GameLift Servers Anywhere fleets, use the custom location name.

    • latencyInMilliseconds

      public final Float latencyInMilliseconds()

      Amount of time that represents the time lag experienced by the player when connected to the specified Region.

      Returns:
      Amount of time that represents the time lag experienced by the player when connected to the specified Region.

    • toBuilder

      public PlayerLatency.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<PlayerLatency.Builder,PlayerLatency>
      Returns:
      a builder for type T

    • builder

      public static PlayerLatency.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PlayerLatency.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.