PlayerLatencyPolicy (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.gamelift.model.PlayerLatencyPolicy

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PlayerLatencyPolicy
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Queue setting that determines the highest latency allowed for individual players when placing a game session. When a latency policy is in force, a game session cannot be placed at any destination in a region where a player is reporting latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information.

Queue-related operations include:
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PlayerLatencyPolicy()

Constructors
Constructor and Description
`PlayerLatencyPolicy()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PlayerLatencyPolicy`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getMaximumIndividualPlayerLatencyMilliseconds()` The maximum latency value that is allowed for any player, in milliseconds.
`Integer`	`getPolicyDurationSeconds()` The length of time, in seconds, that the policy is enforced while placing a new game session.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setMaximumIndividualPlayerLatencyMilliseconds(Integer maximumIndividualPlayerLatencyMilliseconds)` The maximum latency value that is allowed for any player, in milliseconds.
`void`	`setPolicyDurationSeconds(Integer policyDurationSeconds)` The length of time, in seconds, that the policy is enforced while placing a new game session.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`PlayerLatencyPolicy`	`withMaximumIndividualPlayerLatencyMilliseconds(Integer maximumIndividualPlayerLatencyMilliseconds)` The maximum latency value that is allowed for any player, in milliseconds.
`PlayerLatencyPolicy`	`withPolicyDurationSeconds(Integer policyDurationSeconds)` The length of time, in seconds, that the policy is enforced while placing a new game session.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PlayerLatencyPolicy
```
public PlayerLatencyPolicy()
```
- Method Detail
  - setMaximumIndividualPlayerLatencyMilliseconds
```
public void setMaximumIndividualPlayerLatencyMilliseconds(Integer maximumIndividualPlayerLatencyMilliseconds)
```
    The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
    
    Parameters:
    
    maximumIndividualPlayerLatencyMilliseconds - The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
  - getMaximumIndividualPlayerLatencyMilliseconds
```
public Integer getMaximumIndividualPlayerLatencyMilliseconds()
```
    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.
  - withMaximumIndividualPlayerLatencyMilliseconds
```
public PlayerLatencyPolicy withMaximumIndividualPlayerLatencyMilliseconds(Integer maximumIndividualPlayerLatencyMilliseconds)
```
    The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
    
    Parameters:
    
    maximumIndividualPlayerLatencyMilliseconds - The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPolicyDurationSeconds
```
public void setPolicyDurationSeconds(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.
    
    Parameters:
    
    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.
  - getPolicyDurationSeconds
```
public Integer getPolicyDurationSeconds()
```
    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.
  - withPolicyDurationSeconds
```
public PlayerLatencyPolicy withPolicyDurationSeconds(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PlayerLatencyPolicy clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class PlayerLatencyPolicy

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PlayerLatencyPolicy

Method Detail

setMaximumIndividualPlayerLatencyMilliseconds

getMaximumIndividualPlayerLatencyMilliseconds

withMaximumIndividualPlayerLatencyMilliseconds

setPolicyDurationSeconds

getPolicyDurationSeconds

withPolicyDurationSeconds

toString

equals

hashCode

clone

marshall