@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PlayerLatencyPolicy extends Object implements Serializable, Cloneable, StructuredPojo
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.
| Constructor and Description |
|---|
PlayerLatencyPolicy() |
| 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.
|
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.
|
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.
maximumIndividualPlayerLatencyMilliseconds - The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value
set for this property.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.
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.
maximumIndividualPlayerLatencyMilliseconds - The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value
set for this property.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.
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.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.
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.
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.public String toString()
toString in class ObjectObject.toString()public PlayerLatencyPolicy clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.